mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-15 08:59:15 +08:00
29f68f9e28
* fix: checkbox group support options other than string * docs: update checkbox docs * fix: radio group support value other than string * fix: only support number and string * docs: update group options type
1.8 KiB
1.8 KiB
| category | type | title | cover |
|---|---|---|---|
| Components | Data Entry | Checkbox | https://gw.alipayobjects.com/zos/alicdn/8nbVbHEm_/CheckBox.svg |
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.
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:Event) | - |
Checkbox Group
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| defaultValue | Default selected value | string[] | [] | |
| 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[] | [] | |
| onChange | The callback function that is triggered when the state changes | function(checkedValue) | - |
Methods
Checkbox
| Name | Description | Version |
|---|---|---|
| blur() | Remove focus | |
| focus() | Get focus |