---
title: Switch
description: Switch component doc
wrapperClass: Checkbox-wrapper-class
tags:
  - 'components'
  - 'form'
---

# Switch 开关框

表示开关状态/两种状态之间的切换

## 基本用法

绑定 v-model 到一个 Boolean 类型的变量。可以使用 active-color 属性与 inactive-color 属性来设置开关的背景色。

```vue demo
<template>
  <rol-switch v-model="check" active-color="#10B981" inactive-color="#EF4444"></rol-switch>
</template>

<script>
import { ref } from 'vue'

export default {
  setup(props) {
    const check = ref(true)
    return {
      check,
    }
  },
}
</script>
```

## 文字描述

使用`active-text`属性与`inactive-text`属性来设置开关的文字描述。

```vue demo
<template>
  <rol-switch v-model="check1" active-text="停止" inactive-text="激活"></rol-switch>
  <rol-switch
    style="display: block"
    v-model="check2"
    active-text="停止"
    inactive-text="激活"
    active-color="#10B981"
    inactive-color="#EF4444"
  ></rol-switch>
</template>

<script>
import { ref } from 'vue'

export default {
  setup(props) {
    const check1 = ref(true)
    const check2 = ref(false)
    return {
      check1,
      check2,
    }
  },
}
</script>
```

## 扩展的 value 类型

设置`active-value`和`inactive-value`属性，接受`Boolean`, `String`或`Number`类型的值。

```vue demo
<template>
  <rol-tooltip :content="'Switch value: ' + check" placement="top">
    <rol-switch
      v-model="check"
      active-value="100"
      inactive-value="0"
      active-color="#10B981"
      inactive-color="#EF4444"
    ></rol-switch>
  </rol-tooltip>
</template>

<script>
import { ref } from 'vue'

export default {
  setup(props) {
    const check = ref('100')
    return {
      check,
    }
  },
}
</script>
```

## 禁用状态

设置`disabled`属性，接受一个`Boolean`，设置`true`即可禁用。

```vue demo
<template>
  <rol-switch v-model="check1" disabled></rol-switch>
  <rol-switch style="display: block" v-model="check2" disabled></rol-switch>
</template>

<script>
import { ref } from 'vue'

export default {
  setup(props) {
    const check1 = ref(true)
    const check2 = ref(false)
    return {
      check1,
      check2,
    }
  },
}
</script>
```

### 加载中

设置`loading`属性，接受一个`Boolean`，设置`true`即加载中状态。

```vue demo
<template>
  <rol-switch v-model="check1" loading></rol-switch>
  <rol-switch style="display: block" v-model="check2" loading></rol-switch>
</template>

<script>
import { ref } from 'vue'

export default {
  setup(props) {
    const check1 = ref(true)
    const check2 = ref(false)
    return {
      check1,
      check2,
    }
  },
}
</script>
```

### Attributes

| 参数                | 说明                                                                  | 类型                      | 可选值 | 默认值  |
| ------------------- | --------------------------------------------------------------------- | ------------------------- | ------ | ------- |
| value / v-model     | 绑定值，必须等于`active-value`或`inactive-value`，默认为`Boolean`类型 | boolean / string / number | —      | —       |
| disabled            | 是否禁用                                                              | boolean                   | —      | false   |
| loading             | 是否显示加载中                                                        | boolean                   | —      | false   |
| width               | switch 的宽度（像素）                                                 | number                    | —      | 40      |
| active-icon-class   | switch 打开时所显示图标的类名，设置此项会忽略 `active-text`           | string                    | —      | —       |
| inactive-icon-class | switch 关闭时所显示图标的类名，设置此项会忽略 `inactive-text`         | string                    | —      | —       |
| active-text         | switch 打开时的文字描述                                               | string                    | —      | —       |
| inactive-text       | switch 关闭时的文字描述                                               | string                    | —      | —       |
| active-value        | switch 打开时的值                                                     | boolean / string / number | —      | true    |
| inactive-value      | switch 关闭时的值                                                     | boolean / string / number | —      | false   |
| active-color        | switch 打开时的背景色                                                 | string                    | —      | #174287 |
| inactive-color      | switch 关闭时的背景色                                                 | string                    | —      | #dbdbdb |
| name                | switch 对应的 name 属性                                               | string                    | —      | —       |
| validate-event      | 改变 switch 状态时是否触发表单的校验                                  | boolean                   | -      | true    |

### Events

| 事件名称 | 说明                            | 回调参数   |
| -------- | ------------------------------- | ---------- |
| change   | switch 状态发生变化时的回调函数 | 新状态的值 |

### Methods

| 方法名 | 说明               | 参数 |
| ------ | ------------------ | ---- |
| focus  | 使 Switch 获取焦点 | -    |