mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 09:49:57 +08:00
633c3aeb25
close #7181
1.4 KiB
1.4 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 |
---|---|---|---|
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) | |
className | additional class to Switch | string | - |
Methods
Name | Description |
---|---|
blur() | remove focus |
focus() | get focus |