Vant4 Checkbox 復(fù)選框

介紹

在一組備選項(xiàng)中進(jìn)行多選。

引入

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

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

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

代碼演示

基礎(chǔ)用法

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

<van-checkbox v-model="checked">復(fù)選框</van-checkbox>

import { ref } from 'vue';

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

禁用狀態(tài)

通過設(shè)置 ?disabled? 屬性可以禁用復(fù)選框。

<van-checkbox v-model="checked" disabled>復(fù)選框</van-checkbox>

自定義形狀

將 ?shape? 屬性設(shè)置為 ?square?，復(fù)選框的形狀會(huì)變成方形。

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

自定義顏色

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

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

自定義大小

通過 ?icon-size? 屬性可以自定義圖標(biāo)的大小。

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

自定義圖標(biāo)

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

<van-checkbox v-model="checked">
  自定義圖標(biāo)
  <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://fastly.jsdelivr.net/npm/@vant/assets/user-active.png',
      inactiveIcon:
        'https://fastly.jsdelivr.net/npm/@vant/assets/user-inactive.png',
    };
  },
};

禁用文本點(diǎn)擊

設(shè)置 ?label-disabled? 屬性后，點(diǎn)擊圖標(biāo)以外的內(nèi)容不會(huì)觸發(fā)復(fù)選框切換。

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

復(fù)選框組

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

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

import { ref } from 'vue';

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

水平排列

將 ?direction? 屬性設(shè)置為 ?horizontal? 后，復(fù)選框組會(huì)變成水平排列。

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

import { ref } from 'vue';

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

限制最大可選數(shù)

通過 ?max? 屬性可以限制復(fù)選框組的最大可選數(shù)。

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

全選與反選

通過 ?CheckboxGroup? 實(shí)例上的 ?toggleAll? 方法可以實(shí)現(xiàn)全選與反選。

<van-checkbox-group v-model="checked" ref="checkboxGroup">
  <van-checkbox name="a">復(fù)選框 a</van-checkbox>
  <van-checkbox name="b">復(fù)選框 b</van-checkbox>
  <van-checkbox name="c">復(fù)選框 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,
    };
  },
};

搭配單元格組件使用

搭配單元格組件使用時(shí)，需要再引入 ?Cell? 和 ?CellGroup? 組件，并通過 ?Checkbox? 實(shí)例上的 toggle 方法觸發(fā)切換。

<van-checkbox-group v-model="checked">
  <van-cell-group inset>
    <van-cell
      v-for="(item, index) in list"
      clickable
      :key="item"
      :title="`復(fù)選框 ${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 實(shí)例并調(diào)用實(shí)例方法，詳見組件實(shí)例方法。

toggleAll 方法示例

import { ref } from 'vue';
import type { CheckboxGroupInstance } from 'vant';

const checkboxGroupRef = ref<CheckboxGroupInstance>();

// 全部反選
checkboxGroupRef?.value.toggleAll();
// 全部選中
checkboxGroupRef?.value.toggleAll(true);
// 全部取消
checkboxGroupRef?.value.toggleAll(false);

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

Checkbox 方法

通過 ref 可以獲取到 Checkbox 實(shí)例并調(diào)用實(shí)例方法，詳見組件實(shí)例方法。

類型定義

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

import type {
  CheckboxProps,
  CheckboxShape,
  CheckboxInstance,
  CheckboxLabelPosition,
  CheckboxGroupProps,
  CheckboxGroupInstance,
  CheckboxGroupDirection,
  CheckboxGroupToggleAllOptions,
} from 'vant';

?CheckboxInstance? 和 ?CheckboxGroupInstance? 是組件實(shí)例的類型，用法如下：

import { ref } from 'vue';
import type { CheckboxInstance, CheckboxGroupInstance } from 'vant';

const checkboxRef = ref<CheckboxInstance>();
const checkboxGroupRef = ref<CheckboxGroupInstance>();

checkboxRef.value?.toggle();
checkboxGroupRef.value?.toggleAll();

主題定制

樣式變量

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