Checkbox component.
When To Use
- Used for selecting multiple values from several options.
- If you use only one checkbox, it is the same as using Switch to toggle between two states. The difference is that Switch will trigger the state change directly, but Checkbox just marks the state as changed and this needs to be submitted.
Examples
Basic
Disabled
Controlled Checkbox
Checkbox Group
Check all
Use with Grid
Same line
Disabled to show Tooltip
API
Props
Checkbox
| Property |
Description |
Type |
Default |
Version |
| autoFocus |
If get focus when component mounted |
boolean |
false |
|
| checked |
Specifies whether the checkbox is selected |
boolean |
false |
|
| defaultChecked |
Specifies the initial state: whether or not the checkbox is selected |
boolean |
false |
|
| disabled |
If disable checkbox |
boolean |
false |
|
| indeterminate |
The indeterminate checked state of checkbox |
boolean |
false |
|
| onChange |
The callback function that is triggered when the state changes |
function(e: CheckboxChangeEvent) |
- |
|
Checkbox Group
| Property |
Description |
Type |
Default |
Version |
| defaultValue |
Default selected value |
(string | number)[] |
[] |
|
| disabled |
If disable all checkboxes |
boolean |
false |
|
| name |
The name property of all input[type="checkbox"] children |
string |
- |
|
| options |
Specifies options |
string[] | number[] | Option[] |
[] |
|
| value |
Used for setting the currently selected value |
(string | number)[] |
[] |
|
| onChange |
The callback function that is triggered when the state changes |
function(checkedValue) |
- |
|
Methods
Checkbox
| Name |
Description |
Version |
| blur() |
Remove focus |
|
| focus() |
Get focus |
|
