Switch 开关

介绍

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

引入

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

代码演示

基础用法

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

  1. <van-switch v-model="checked" />
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const checked = ref(true);
  5. return { checked };
  6. },
  7. };

禁用状态

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

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

加载状态

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

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

自定义大小

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

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

自定义颜色

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

  1. <van-switch v-model="checked" active-color="#ee0a24" inactive-color="#dcdee0" />

异步控制

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

  1. <van-switch :model-value="checked" @update:model-value="onUpdateValue" />
  1. import { ref } from 'vue';
  2. import { Dialog } from 'vant';
  3. export default {
  4. setup() {
  5. const checked = ref(true);
  6. const onUpdateValue = (newValue) => {
  7. Dialog.confirm({
  8. title: '提醒',
  9. message: '是否切换开关?',
  10. }).then(() => {
  11. checked.value = newValue;
  12. });
  13. };
  14. return {
  15. checked,
  16. onUpdateValue,
  17. };
  18. },
  19. };

搭配单元格使用

  1. <van-cell center title="标题">
  2. <template #right-icon>
  3. <van-switch v-model="checked" size="24" />
  4. </template>
  5. </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

样式变量

组件提供了下列 Less 变量,可用于自定义样式,使用方法请参考主题定制

名称默认值描述
@switch-size30px-
@switch-width2em-
@switch-height1em-
@switch-node-size1em-
@switch-node-background-color@white-
@switch-node-box-shadow0 3px 1px 0 rgba(0, 0, 0, 0.05)-
@switch-background-color@white-
@switch-on-background-color@blue-
@switch-transition-duration@animation-duration-base-
@switch-disabled-opacity@disabled-opacity-
@switch-border@border-width-base solid rgba(0, 0, 0, 0.1)-

Switch 开关 - 图1