Switch
Switch is used for switching between two opposing states.
Basic usage
Sizes
Text description
You can add active-text and inactive-text attribute to show texts. use inline-prompt attribute to control text is displayed inside dot.
Display custom icons
TIP
Use the active-icon and inactive-icon attribute to add icon. You can pass either string for the component name (registered in advance) or the component itself which is a SVG Vue component. Element Plus has provided a set of icon that you can find at icon
Extended value types
Disabled
Loading
prevent switching
custom action icon 2.3.9
custom action slot 2.4.4
API
Attributes
| Name | Description | Type | Default |
|---|---|---|---|
| model-value / v-model | binding value, it should be equivalent to either active-value or inactive-value, by default it's boolean type | boolean / string / number | false |
| disabled | whether Switch is disabled | boolean | false |
| loading | whether Switch is in loading state | boolean | false |
| size | size of Switch | enum | '' |
| width | width of Switch | number / string | '' |
| inline-prompt | whether icon or text is displayed inside dot, only the first character will be rendered for text | boolean | false |
| active-icon | component of the icon displayed when in on state, overrides active-text | string / Component | — |
| inactive-icon | component of the icon displayed when in off state, overrides inactive-text | string / Component | — |
| active-action-icon 2.3.9 | component of the icon displayed in action when in on state | string / Component | — |
| inactive-action-icon 2.3.9 | component of the icon displayed in action when in off state | string / Component | — |
| active-text | text displayed when in on state | string | '' |
| inactive-text | text displayed when in off state | string | '' |
| active-value | switch value when in on state | boolean / string / number | true |
| inactive-value | switch value when in off state | boolean / string / number | false |
| active-color deprecated | background color when in on state ( deprecated, use CSS var --el-switch-on-color instead ) | string | '' |
| inactive-color deprecated | background color when in off state ( deprecated, use CSS var --el-switch-off-color instead ) | string | '' |
| border-color deprecated | border color of the switch ( deprecated, use CSS var --el-switch-border-color instead ) | string | '' |
| name | input name of Switch | string | '' |
| validate-event | whether to trigger form validation | boolean | true |
| before-change | before-change hook before the switch state changes. If false is returned or a Promise is returned and then is rejected, will stop switching | boolean / Function | — |
| id | id for input | string | — |
| tabindex | tabindex for input | string / number | — |
| label a11y deprecated | same as aria-label in native input | string | — |
| aria-label a11y 2.7.2 | same as aria-label in native input | string | — |
Events
| Name | Description | Type |
|---|---|---|
| change | triggers when value changes | Function |
Switch Slots
| Name | Description |
|---|---|
| active-action 2.4.4 | customize active action |
| inactive-action 2.4.4 | customize inactive action |
Exposes
| Method | Description | Type |
|---|---|---|
| focus | manual focus to the switch component | Function |
三咲智子
云游君
Jeremy
kooriookami
Aex
btea
zz
LIUCHAO
Delyan Haralanov
Xc
啝裳
C.Y.Kun
星如雨
Karolis_Stoncius_Sneakybox
wzc520pyfm
Simon He
Carter Li
류한경
opengraphica
joson
Herrington Darkholme
Alan Wang
deepthan
Sleepy Five
on the field of hope
Weiqi Wu
zazzaz
Ther-su
Hades-li
sea
qiang
0song