mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-25 19:50:05 +08:00
Code Issues Actions 20 Packages Projects Releases Wiki Activity
84d65b3f66
ant-design/components/checkbox/index.en-US.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636) 
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

1.2 KiB
Raw Blame History

category type title
Components Data Entry Checkbox

Checkbox.

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

Checkbox

Property Description Type Default
checked Specifies whether the checkbox is selected. boolean false
defaultChecked Specifies the initial state: whether or not the checkbox is selected. boolean false
onChange The callback function that is triggered when the state changes. Function(e:Event) -

Checkbox Group

Property Description Type Default
defaultValue Default selected value string[] []
value Used for setting the currently selected value. string[] []
options Specifies options string[] []
onChange The callback function that is triggered when the state changes. Function(checkedValue) -