vant/packages/vant/src/switch/README.md

Switch

Intro

Used to switch between open and closed states.

Install

Register component globally via app.use, refer to Component Registration for more registration ways.

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

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

Usage

Basic Usage

<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 />

Custom Size

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

Custom Color

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

Custom Node

Using node slot to custom the content of the node.

<van-switch v-model="checked">
  <div class="icon-wrapper">
    <van-icon :name="checked ? 'success' : 'cross'" />
  </div>
</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>

Async Control

<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: 'Confirm',
        message: 'Are you sure to toggle switch?',
      }).then(() => {
        checked.value = newValue;
      });
    };

    return {
      checked,
      onUpdateValue,
    };
  },
};

Inside a Cell

<van-cell center title="Title">
  <template #right-icon>
    <van-switch v-model="checked" />
  </template>
</van-cell>

API

Props

Attribute	Description	Type	Default
v-model	Check status of Switch	ActiveValue | InactiveValue	false
loading	Whether to show loading icon	boolean	false
disabled	Whether to disable switch	boolean	false
size	Size of switch button	number | string	26px
active-color	Background color when active	string	#1989fa
inactive-color	Background color when inactive	string	rgba(120, 120, 128, 0.16)
active-value	Value when active	any	true
inactive-value	Value when inactive	any	false

Events

Event	Description	Parameters
change	Emitted when check status changed	value: any
click	Emitted when component is clicked	event: MouseEvent

Slots

Name	Description	SlotProps
node v3.5.0	Custom the content of node	-

Types

The component exports the following type definitions:

import type { SwitchProps } from 'vant';

Theming

CSS Variables

The component provides the following CSS variables, which can be used to customize styles. Please refer to ConfigProvider component.

Name	Default Value	Description
--van-switch-size	26px	-
--van-switch-width	calc(1.8em + 4px)	-
--van-switch-height	calc(1em + 4px)	-
--van-switch-node-size	1em	-
--van-switch-node-background	var(--van-white)	-
--van-switch-node-shadow	0 3px 1px 0 rgba(0, 0, 0, 0.05)	-
--van-switch-background	rgba(120, 120, 128, 0.16)	-
--van-switch-on-background	var(--van-primary-color)	-
--van-switch-duration	var(--van-duration-base)	-
--van-switch-disabled-opacity	var(--van-disabled-opacity)	-