Switch 开关

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { Switch } from 'vant';
const app = createApp();
app.use(Switch);

代码演示

基础用法

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

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

import { ref } from 'vue';
export default {
  setup() {
    const checked = ref(true);
    return { checked };
  },
};

禁用状态

通过 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="#ee0a24" inactive-color="#dcdee0" />

自定义按钮

通过 node 插槽自定义按钮的内容。

<van-switch v-model="checked">
  <template #node>
    <div class="icon-wrapper">
      <van-icon :name="checked ? 'success' : 'cross'" />
    </div>
  </template>
</van-switch>
<style>
  .icon-wrapper {
    display: flex;
    width: 100%;
    justify-content: center;
    font-size: 18px;
  }
  .icon-wrapper .van-icon-success {
    line-height: 32px;
    color: var(--van-blue);
  }
  .icon-wrapper .van-icon-cross {
    line-height: 32px;
    color: var(--van-gray-5);
  }
</style>

异步控制

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

<van-switch :model-value="checked" @update:model-value="onUpdateValue" />

import { ref } from 'vue';
import { Dialog } from 'vant';
export default {
  setup() {
    const checked = ref(true);
    const onUpdateValue = (newValue) => {
      Dialog.confirm({
        title: '提醒',
        message: '是否切换开关？',
      }).then(() => {
        checked.value = newValue;
      });
    };
    return {
      checked,
      onUpdateValue,
    };
  },
};

搭配单元格使用

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

API

Props

Events

Slots

类型定义

组件导出以下类型定义：

import type { SwitchProps } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。