ant-design/index.en-US.md at 00bcdae2ae5842d755fa155a8a9396e478d7b03a

mirror of https://github.com/ant-design/ant-design.git synced 2024-11-28 21:19:37 +08:00

* docs: Update components cover

#24629

* docs: Update components cover

2020-06-05 13:50:09 +08:00

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.

Property	Description	Type	Default
autoFocus	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	Disable checkbox	boolean	false
indeterminate	indeterminate checked state of checkbox	boolean	false
onChange	The callback function that is triggered when the state changes.	Function(e:Event)	-

Property	Description	Type	Default
defaultValue	Default selected value	string[]	[]
disabled	Disable all checkboxes	boolean	false
name	The `name` property of all `input[type="checkbox"]` children	string	-
options	Specifies options	string[]	[]
value	Used for setting the currently selected value.	string[]	[]
onChange	The callback function that is triggered when the state changes.	Function(checkedValue)	-

Name	Description	Version
blur()	remove focus
focus()	get focus