@trendmicro/react-checkbox

react-checkbox

React Checkbox

Demo: https://trendmicro-frontend.github.io/react-checkbox

Installation

1. Install the latest version of react and react-checkbox:

npm install --save react @trendmicro/react-checkbox

1. At this point you can import @trendmicro/react-checkbox and its styles in your application as follows:

import Checkbox from '@trendmicro/react-checkbox';

// Be sure to include styles at some point, probably during your bootstraping
import '@trendmicro/react-checkbox/dist/react-checkbox.css';

Usage

// Basic
<Checkbox />

// Checked
<Checkbox defaultChecked />

// Force checked
<Checkbox checked />

// Partial checked
<Checkbox defaultIndeterminate />

// Partial checked. Force indeterminate status (Do not change by click)
<Checkbox indeterminate />

// Disabled
<Checkbox disabled />

// With Label
<Checkbox>
    Normal
</Checkbox>

// Get checked status of checkbox by this.checkbox.checked
// Get indeterminate status of checkbox by this.checkbox.indeterminate
<Checkbox
    ref={node => {
        this.checkbox = node;
    }}
/>

API

Properties

Name	Type	Default	Description
defaultChecked	Boolean		Specify default checked status for checkbox
checked	Boolean		Force checked status for checkbox
defaultIndeterminate	Boolean	false	Specify default indeterminate status for checkbox
indeterminate	Boolean		Force indeterminate status for checkbox
disabled	Boolean	false	Specify disabled status for checkbox

Name	Type	Description
checked	Boolean	Get checked status
indeterminate	Boolean	Get indeterminate status

License

MIT