mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-15 17:31:25 +08:00
b9f77fde6c
* feat: migrate less to token for Switch * chore: add demo * chore: code clean * chore: update demo * docs: update docs en * chore: code clean --------- Co-authored-by: MadCcc <1075746765@qq.com>
2.1 KiB
2.1 KiB
category | group | title | cover | coverDark | demo | ||
---|---|---|---|---|---|---|---|
Components | Data Entry | Switch | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*rtArRpBNDZcAAAAAAAAAAAAADrJ8AQ/original | https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*al07RK8SGf4AAAAAAAAAAAAADrJ8AQ/original |
|
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.
Examples
Basic
Disabled
Text & icon
Two sizes
Loading
Custom component token
API
Common props ref:Common props
Property | Description | Type | Default |
---|---|---|---|
autoFocus | Whether get focus when component mounted | boolean | false |
checked | Determine whether the Switch is checked | boolean | false |
checkedChildren | The content to be shown when the state is checked | ReactNode | - |
className | The additional class to Switch | string | - |
defaultChecked | Whether 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 | The content to be shown when the state is unchecked | ReactNode | - |
onChange | Trigger when the checked state is changing | function(checked: boolean, event: Event) | - |
onClick | Trigger when clicked | function(checked: boolean, event: Event) | - |
Methods
Name | Description |
---|---|
blur() | Remove focus |
focus() | Get focus |