mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 21:59:41 +08:00
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Entry
|
|
title: Switch
|
|
---
|
|
|
|
Switching Selector.
|
|
|
|
## When To Use
|
|
|
|
- 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 | 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 |
|