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

36 lines
1.4 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
---
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 |
2017-10-25 10:25:44 +08:00
| -------- | ----------- | ---- | ------- |
| autoFocus | get focus when component mounted | boolean | false |
2017-10-25 10:25:44 +08:00
| 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 |
2017-10-25 10:25:44 +08:00
| disabled | Disable switch | boolean | false |
2017-12-29 20:22:58 +08:00
| loading | loading state of switch | boolean | false |
| size | the size of the `Switch`, options: `default` `small` | string | default |
2017-10-25 10:25:44 +08:00
| unCheckedChildren | content to be shown when the state is unchecked | string\|ReactNode | |
2019-01-26 01:26:48 +08:00
| onChange | trigger when the checked state is changing | Function(checked: boolean, event: Event) | |
| onClick | trigger when clicked | Function(checked: boolean, event: Event) | |
2018-10-02 04:58:00 +08:00
| className | additional class to Switch | string | - |
## Methods
| Name | Description |
| ---- | ----------- |
| blur() | remove focus |
2017-12-29 20:22:58 +08:00
| focus() | get focus |