Vant4 Switch 開關(guān)

介紹

用于在打開和關(guān)閉狀態(tài)之間進(jìn)行切換。

引入

通過以下方式來全局注冊(cè)組件，更多注冊(cè)方式請(qǐng)參考組件注冊(cè)。

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

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

代碼演示

基礎(chǔ)用法

通過 ?v-model? 綁定開關(guān)的選中狀態(tài)，?true? 表示開，?false? 表示關(guān)。

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

import { ref } from 'vue';

export default {
  setup() {
    const checked = ref(true);
    return { checked };
  },
};

禁用狀態(tài)

通過 ?disabled? 屬性來禁用開關(guān)，禁用狀態(tài)下開關(guān)不可點(diǎn)擊。

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

加載狀態(tài)

通過 ?loading? 屬性設(shè)置開關(guān)為加載狀態(tài)，加載狀態(tài)下開關(guān)不可點(diǎn)擊。

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

自定義大小

通過 ?size? 屬性自定義開關(guān)的大小。

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

自定義顏色

?active-color? 屬性表示打開時(shí)的背景色，?inactive-color? 表示關(guān)閉時(shí)的背景色。

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

自定義按鈕

通過 ?node? 插槽自定義按鈕的內(nèi)容。

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

異步控制

需要異步控制開關(guān)時(shí)，可以使用 ?modelValue? 屬性和 ?update:model-value? 事件代替 ?v-model?，并在事件回調(diào)函數(shù)中手動(dòng)處理開關(guān)狀態(tài)。

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

import { ref } from 'vue';
import { showConfirmDialog } from 'vant';

export default {
  setup() {
    const checked = ref(true);
    const onUpdateValue = (newValue) => {
      showConfirmDialog({
        title: '提醒',
        message: '是否切換開關(guān)？',
      }).then(() => {
        checked.value = newValue;
      });
    };

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

搭配單元格使用

<van-cell center title="標(biāo)題">
  <template #right-icon>
    <van-switch v-model="checked" />
  </template>
</van-cell>

API

Props

Events

Slots

類型定義

組件導(dǎo)出以下類型定義：

import type { SwitchProps } from 'vant';

主題定制

樣式變量

組件提供了下列 CSS 變量，可用于自定義樣式，使用方法請(qǐng)參考 ConfigProvider 組件。