当前位置: 首页 > 文档资料 > Vant 中文文档 >

Switch 开关

优质
小牛编辑
134浏览
2023-12-01

介绍

用于在打开和关闭状态之间进行切换。

引入

import { createApp } from 'vue';
import { Switch } from 'vant';

const app = createApp();
app.use(Switch);

代码演示

基础用法

通过 v-model 绑定开关的选中状态,true 表示开,false 表示关。

<van-switch v-model="checked" />
export default {
  data() {
    return {
      checked: true,
    };
  },
};

禁用状态

通过 disabled 属性来禁用开关,禁用状态下开关不可点击。

<van-switch v-model="checked" disabled />

加载状态

通过 loading 属性设置开关为加载状态,加载状态下开关不可点击。

<van-switch v-model="checked" loading />

自定义大小

通过 size 属性自定义开关的大小。

<van-switch v-model="checked" size="24px" />

自定义颜色

active-color 属性表示打开时的背景色,inactive-color 表示关闭时的背景色。

<van-switch v-model="checked" active-color="#07c160" inactive-color="#ee0a24" />

异步控制

需要异步控制开关时,可以使用 modelValue 属性和 update:model-value 事件代替 v-model,并在事件回调函数中手动处理开关状态。

<van-switch :model-value="checked" @update:model-value="onUpdateValue" />
export default {
  data() {
    return {
      checked: true,
    };
  },
  methods: {
    onUpdateValue(checked) {
      Dialog.confirm({
        title: '提醒',
        message: '是否切换开关?',
      }).then(() => {
        this.checked = checked;
      });
    },
  },
};

搭配单元格使用

<van-cell center title="标题">
  <template #right-icon>
    <van-switch v-model="checked" size="24" />
  </template>
</van-cell>

API

Props

参数说明类型默认值
v-model开关选中状态anyfalse
loading是否为加载状态booleanfalse
disabled是否为禁用状态booleanfalse
size开关尺寸,默认单位为pxnumber / string30px
active-color打开时的背景色string#1989fa
inactive-color关闭时的背景色stringwhite
active-value打开时对应的值anytrue
inactive-value关闭时对应的值anyfalse

Events

事件名说明回调参数
change开关状态切换时触发value: any
click点击时触发event: Event