mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-03 04:30:06 +08:00
1.1 KiB
1.1 KiB
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
andCheckbox
is thatSwitch
will trigger a state change directly when you toggle it, whileCheckbox
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 |
checkedChildren | content to be shown when the state is checked | string|ReactNode | |
defaultChecked | to set the initial state | boolean | false |
disabled | Disable switch | boolean | false |
size | the size of the Switch , options: default small |
string | default |
unCheckedChildren | content to be shown when the state is unchecked | string|ReactNode | |
onChange | a callback function, can be executed when the checked state is changing | Function(checked:Boolean) |