mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-27 03:01:14 +08:00
144 lines
3.3 KiB
Markdown
144 lines
3.3 KiB
Markdown
## Switch
|
|
|
|
Switch is used for switching between two opposing states.
|
|
|
|
### Basic usage
|
|
:::demo Bind `v-model` to a `Boolean` typed variable. The `active-color` and `inactive-color` attribute decides the background color in two states.
|
|
|
|
```html
|
|
<el-switch v-model="value1">
|
|
</el-switch>
|
|
<el-switch
|
|
v-model="value2"
|
|
active-color="#13ce66"
|
|
inactive-color="#ff4949">
|
|
</el-switch>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
value1: true,
|
|
value2: true
|
|
}
|
|
}
|
|
};
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
### Text description
|
|
:::demo You can add `active-text` and `inactive-text` attribute to show texts.
|
|
|
|
```html
|
|
<el-switch
|
|
v-model="value1"
|
|
active-text="Pay by month"
|
|
inactive-text="Pay by year">
|
|
</el-switch>
|
|
<el-switch
|
|
style="display: block"
|
|
v-model="value2"
|
|
active-color="#13ce66"
|
|
inactive-color="#ff4949"
|
|
active-text="Pay by month"
|
|
inactive-text="Pay by year">
|
|
</el-switch>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
value1: true,
|
|
value2: true
|
|
}
|
|
}
|
|
};
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
### Extended value types
|
|
|
|
:::demo You can set `active-value` and `inactive-value` attributes. They both receive a `Boolean`, `String` or `Number` typed value.
|
|
|
|
```html
|
|
<el-tooltip :content="'Switch value: ' + value" placement="top">
|
|
<el-switch
|
|
v-model="value"
|
|
active-color="#13ce66"
|
|
inactive-color="#ff4949"
|
|
active-value="100"
|
|
inactive-value="0">
|
|
</el-switch>
|
|
</el-tooltip>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
value: '100'
|
|
}
|
|
}
|
|
};
|
|
</script>
|
|
```
|
|
|
|
:::
|
|
|
|
### Disabled
|
|
|
|
:::demo Adding the `disabled` attribute disables Switch.
|
|
|
|
```html
|
|
<el-switch
|
|
v-model="value1"
|
|
disabled>
|
|
</el-switch>
|
|
<el-switch
|
|
v-model="value2"
|
|
disabled>
|
|
</el-switch>
|
|
|
|
<script>
|
|
export default {
|
|
data() {
|
|
return {
|
|
value1: true,
|
|
value2: false
|
|
}
|
|
}
|
|
};
|
|
</script>
|
|
```
|
|
:::
|
|
|
|
### Attributes
|
|
|
|
| Attribute | Description | Type | Accepted Values | Default |
|
|
|-----| ----| ----| ----|---- |
|
|
| value / v-model | binding value | boolean / string / number | — | — |
|
|
| disabled | whether Switch is disabled | boolean | — | false |
|
|
| width | width of Switch | number | — | 40 |
|
|
| active-icon-class | class name of the icon displayed when in `on` state, overrides `active-text` | string | — | — |
|
|
| inactive-icon-class |class name of the icon displayed when in `off` state, overrides `inactive-text`| string | — | — |
|
|
| 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 | background color when in `on` state | string | — | #409EFF |
|
|
| inactive-color | background color when in `off` state | string | — | #C0CCDA |
|
|
| name | input name of Switch | string | — | — |
|
|
| validate-event | whether to trigger form validation | boolean | - | true |
|
|
|
|
### Events
|
|
|
|
| Event Name | Description | Parameters |
|
|
| ---- | ----| ---- |
|
|
| change | triggers when value changes | value after changing |
|
|
|
|
### Methods
|
|
| Method | Description | Parameters |
|
|
| ------|--------|------- |
|
|
| focus | focus the Switch component | — |
|