mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-16 01:41:02 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
1.5 KiB
1.5 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
Property | Description | Type | Default | Version |
---|---|---|---|---|
autoFocus | get focus when component mounted | boolean | false | |
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 | |
loading | loading state of 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 | trigger when the checked state is changing | Function(checked: boolean, event: Event) | ||
onClick | trigger when clicked | Function(checked: boolean, event: Event) | 3.13.0 | |
className | additional class to Switch | string | - | 3.10.1 |
Methods
Name | Description | Version |
---|---|---|
blur() | remove focus | |
focus() | get focus |