介紹

在一組備選項中進行多選。

實例演示

引入

通過以下方式來全局注冊組件，更多注冊方式請參考組件注冊。

import { createApp } from 'vue';
import { Checkbox, CheckboxGroup } from 'vant';

const app = createApp();
app.use(Checkbox);
app.use(CheckboxGroup);

代碼演示

基礎用法

通過 v-model 綁定復選框的勾選狀態(tài)。

<van-checkbox v-model="checked">復選框</van-checkbox>

import { ref } from 'vue';

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

禁用狀態(tài)

通過設置 disabled 屬性可以禁用復選框。

<van-checkbox v-model="checked" disabled>復選框</van-checkbox>

自定義形狀

將 shape 屬性設置為 square，復選框的形狀會變成方形。

<van-checkbox v-model="checked" shape="square">復選框</van-checkbox>

自定義顏色

通過 checked-color 屬性設置選中狀態(tài)的圖標顏色。

<van-checkbox v-model="checked" checked-color="#ee0a24">復選框</van-checkbox>

自定義大小

通過 icon-size 屬性可以自定義圖標的大小。

<van-checkbox v-model="checked" icon-size="24px">復選框</van-checkbox>

自定義圖標

通過 icon 插槽自定義圖標，可以通過 slotProps 判斷是否為選中狀態(tài).

<van-checkbox v-model="checked">
  自定義圖標
  <template #icon="props">
    <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
  </template>
</van-checkbox>

<style>
  .img-icon {
    height: 20px;
  }
</style>

import { ref } from 'vue';

export default {
  setup() {
    const checked = ref(true);
    return {
      checked,
      activeIcon: 'https://img.yzcdn.cn/vant/user-active.png',
      inactiveIcon: 'https://img.yzcdn.cn/vant/user-inactive.png',
    };
  },
};

禁用文本點擊

設置 label-disabled 屬性后，點擊圖標以外的內容不會觸發(fā)復選框切換。

<van-checkbox v-model="checked" label-disabled>復選框</van-checkbox>

復選框組

復選框可以與復選框組一起使用，復選框組通過 v-model 數組綁定復選框的勾選狀態(tài)。

<van-checkbox-group v-model="checked">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
</van-checkbox-group>

import { ref } from 'vue';

export default {
  setup() {
    const checked = ref(['a', 'b']);
    return { checked };
  },
};

水平排列

將 direction 屬性設置為 horizontal 后，復選框組會變成水平排列。

<van-checkbox-group v-model="checked" direction="horizontal">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
</van-checkbox-group>

import { ref } from 'vue';

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

限制最大可選數

通過 max 屬性可以限制復選框組的最大可選數。

<van-checkbox-group v-model="checked" :max="2">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
  <van-checkbox name="c">復選框 c</van-checkbox>
</van-checkbox-group>

全選與反選

通過 CheckboxGroup 實例上的 toggleAll 方法可以實現全選與反選。

<van-checkbox-group v-model="checked" ref="checkboxGroup">
  <van-checkbox name="a">復選框 a</van-checkbox>
  <van-checkbox name="b">復選框 b</van-checkbox>
  <van-checkbox name="c">復選框 c</van-checkbox>
</van-checkbox-group>

<van-button type="primary" @click="checkAll">全選</van-button>
<van-button type="primary" @click="toggleAll">反選</van-button>

import { ref } from 'vue';

export default {
  setup() {
    const checked = ref([]);
    const checkboxGroup = ref(null);

    const checkAll = () => {
      checkboxGroup.value.toggleAll(true);
    }
    const toggleAll = () => {
      checkboxGroup.value.toggleAll();
    },

    return {
      checked,
      checkAll,
      toggleAll,
      checkboxGroup,
    };
  },
};

搭配單元格組件使用

此時你需要再引入 Cell 和 CellGroup 組件，并通過 Checkbox 實例上的 toggle 方法觸發(fā)切換。

<van-checkbox-group v-model="checked">
  <van-cell-group>
    <van-cell
      v-for="(item, index) in list"
      clickable
      :key="item"
      :title="`復選框 ${item}`"
      @click="toggle(index)"
    >
      <template #right-icon>
        <van-checkbox
          :name="item"
          :ref="el => checkboxRefs[index] = el"
          @click.stop
        />
      </template>
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

import { ref, onBeforeUpdate } from 'vue';

export default {
  setup() {
    const checked = ref([]);
    const checkboxRefs = ref([]);
    const toggle = (index) => {
      checkboxRefs.value[index].toggle();
    };

    onBeforeUpdate(() => {
      checkboxRefs.value = [];
    });

    return {
      list: ['a', 'b'],
      toggle,
      checked,
      checkboxRefs,
    };
  },
};

API

Checkbox Props

CheckboxGroup Props

Checkbox Events

CheckboxGroup Events

Checkbox Slots

CheckboxGroup 方法

通過 ref 可以獲取到 CheckboxGroup 實例并調用實例方法，詳見組件實例方法。

toggleAll 方法示例

const { checkboxGroup } = this.$refs;

// 全部反選
checkboxGroup.toggleAll();
// 全部選中
checkboxGroup.toggleAll(true);
// 全部取消
checkboxGroup.toggleAll(false);

// 全部反選，并跳過禁用的復選框
checkboxGroup.toggleAll({
  skipDisabled: true,
});
// 全部選中，并跳過禁用的復選框
checkboxGroup.toggleAll({
  checked: true,
  skipDisabled: true,
});

Checkbox 方法

通過 ref 可以獲取到 Checkbox 實例并調用實例方法，詳見組件實例方法。

主題定制

樣式變量

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