zk-desktop-ui/docs/components/switch.md

ZKTeco UI Components

## Switch 开关

表示两种相互对立的状态间的切换，多用于触发「开/关」。

### 基本用法

> demo

 绑定`v-model`到一个`Boolean`类型的变量。可以使用`on-text`属性与`off-text`属性来设置开关的文字描述，使用`on-color`属性与`off-color`属性来设置开关的背景色。

```html
<zk-switch
  v-model="value1"
  on-text=""
  off-text="">
</zk-switch>
<zk-switch
  v-model="value2"
  on-color="#13ce66"
  off-color="#ff4949">
</zk-switch>

<script>
  export default {
    data() {
      return {
        value1: true,
        value2: true
      }
    }
  };
</script>
```



### 禁用状态

> demo

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

```html
<zk-switch
  v-model="value3"
  on-text=""
  off-text=""
  disabled>
</zk-switch>
<zk-switch
  v-model="value3"
  disabled>
</zk-switch>

<script>
  export default {
    data() {
      return {
        value3: true
      }
    }
  };
</script>
```



### Attributes

| 参数      | 说明    | 类型      | 可选值       | 默认值   |
|---------- |-------- |---------- |-------------  |-------- |
| disabled  | 是否禁用    | boolean   | — | false   |
| width  | switch 的宽度（像素）    | number   | — | 58（有文字）/ 46（无文字） |
| on-icon-class  | switch 打开时所显示图标的类名，<br>设置此项会忽略 `on-text`    | string   | — | — |
| off-icon-class  | switch 关闭时所显示图标的类名，<br>设置此项会忽略 `off-text`    | string   | — | — |
| on-text  | switch 打开时的文字    | string   | — | ON |
| off-text  | switch 关闭时的文字    | string   | — | OFF |
| on-color  | switch 打开时的背景色    | string   | — | #20A0FF |
| off-color  | switch 关闭时的背景色    | string   | — | #C0CCDA |
| name  | switch 对应的 name 属性    | string   | — | — |

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