mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-22 22:48:29 +08:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity
3b4a51d1ef
ant-design/components/switch/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

1011 B
Raw Blame History

category type title
Components Data Entry Switch

Switching Selector.

When To Use

  • If you need to represent the switching between two states or on-off state.
  • The difference between Switch and Checkbox is that Switch will trigger a state change directly when you toggle it, while Checkbox is generally used for state marking, which should work in conjunction with submit operation.

API

Switch

Property Description Type Default
checked determine whether the Switch is checked boolean false
defaultChecked to set the initial state boolean false
onChange a callback function, can be executed when the checked state is changing Function(checked:Boolean)
checkedChildren content to be shown when the state is checked string|ReactNode
unCheckedChildren content to be shown when the state is unchecked string|ReactNode
size the size of the Switch, options: default small string default