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

25 lines
1.0 KiB
Markdown
Raw Normal View History

2018-02-27 12:14:29 +08:00
## API
| Property | Description | Type | Default |
| -------- | ----------- | ---- | ------- |
| autoFocus | get focus when component mounted | boolean | false |
2018-03-05 19:06:44 +08:00
| checked(v-model) | determine whether the `Switch` is checked | boolean | false |
2018-02-27 12:14:29 +08:00
| checkedChildren | content to be shown when the state is checked | string\|slot | |
| 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\|slot | |
2018-02-27 18:00:11 +08:00
2018-03-22 22:17:35 +08:00
### Events
2018-02-27 18:00:11 +08:00
| Events Name | Description | Arguments |
| --- | --- | --- |
2019-03-18 20:35:24 +08:00
| change | trigger when the checked state is changing | Function(checked: boolean, event: Event) | |
| click | trigger when clicked | Function(checked: boolean, event: Event) | |
2018-02-27 12:14:29 +08:00
## Methods
| Name | Description |
| ---- | ----------- |
| blur() | remove focus |
| focus() | get focus |