ant-design/components/switch/index.en-US.md

37 lines
1.5 KiB
Markdown
Raw Normal View History

2016-07-26 09:17:46 +08:00
---
category: Components
type: Data Entry
2016-07-26 09:17:46 +08:00
title: Switch
cover: https://gw.alipayobjects.com/zos/alicdn/zNdJQMhfm/Switch.svg
2016-07-26 09:17:46 +08:00
---
Switching Selector.
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-26 09:17:46 +08:00
- 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
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| autoFocus | Whether get focus when component mounted | boolean | false |
| checked | Determine whether the Switch is checked | boolean | false |
2020-10-09 10:08:52 +08:00
| checkedChildren | The content to be shown when the state is checked | ReactNode | - |
| 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` |
2020-10-09 10:08:52 +08:00
| 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) | - |
| className | The additional class to Switch | string | - |
## Methods
| Name | Description |
| ------- | ------------ |
| blur() | Remove focus |
| focus() | Get focus |