vant/src/checkbox/README.md

Checkbox

Install

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

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

Usage

Basic Usage

<van-checkbox v-model="checked">Checkbox</van-checkbox>

export default {
  data() {
    return {
      checked: true,
    };
  },
};

Disabled

<van-checkbox v-model="checked" disabled>Checkbox</van-checkbox>

Custom Shape

<van-checkbox v-model="checked" shape="square">Checkbox</van-checkbox>

Custom Color

<van-checkbox v-model="checked" checked-color="#07c160">Checkbox</van-checkbox>

Custom Icon Size

<van-checkbox v-model="checked" icon-size="24px">Checkbox</van-checkbox>

Custom Icon

Use icon slot to custom icon.

<van-checkbox v-model="checked">
  customize icon
  <template #icon="props">
    <img class="img-icon" :src="props.checked ? activeIcon : inactiveIcon" />
  </template>
</van-checkbox>

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

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

Disable Label Click

<van-checkbox v-model="checked" label-disabled>Checkbox</van-checkbox>

Checkbox Group

When Checkboxes are inside a CheckboxGroup, the checked checkboxes's name is an array and bound with CheckboxGroup by v-model.

<van-checkbox-group v-model="result">
  <van-checkbox name="a">Checkbox a</van-checkbox>
  <van-checkbox name="b">Checkbox b</van-checkbox>
</van-checkbox-group>

export default {
  data() {
    return {
      result: ['a', 'b'],
    };
  },
};

Horizontal

<van-checkbox-group v-model="result" direction="horizontal">
  <van-checkbox name="a">Checkbox a</van-checkbox>
  <van-checkbox name="b">Checkbox b</van-checkbox>
</van-checkbox-group>

export default {
  data() {
    return {
      result: [],
    };
  },
};

Maximum amount of checked options

<van-checkbox-group v-model="result" :max="2">
  <van-checkbox name="a">Checkbox a</van-checkbox>
  <van-checkbox name="b">Checkbox b</van-checkbox>
  <van-checkbox name="c">Checkbox c</van-checkbox>
</van-checkbox-group>

Toggle All

<van-checkbox-group v-model="result" ref="checkboxGroup">
  <van-checkbox name="a">Checkbox a</van-checkbox>
  <van-checkbox name="b">Checkbox b</van-checkbox>
  <van-checkbox name="c">Checkbox c</van-checkbox>
</van-checkbox-group>

<van-button type="primary" @click="checkAll">Check All</van-button>
<van-button type="primary" @click="toggleAll">Toggle All</van-button>

export default {
  data() {
    return {
      result: [],
    };
  },
  methods: {
    checkAll() {
      this.$refs.checkboxGroup.toggleAll(true);
    },
    toggleAll() {
      this.$refs.checkboxGroup.toggleAll();
    },
  },
};

Inside a Cell

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

import { ref, onBeforeUpdate } from 'vue';

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

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

    return {
      list: ['a', 'b'],
      result,
      toggle,
      checkboxes,
    };
  },
};

API

Checkbox Props

Attribute	Description	Type	Default
v-model (value)	Check status	boolean	false
name	Checkbox name	any	-
shape	Can be set to square	string	round
disabled	Disable checkbox	boolean	false
label-disabled	Whether to disable label click	boolean	false
label-position	Can be set to left	string	right
icon-size	Icon size	number | string	20px
checked-color	Checked color	string	#1989fa
bind-group	Whether to bind with CheckboxGroup	boolean	true

CheckboxGroup Props

Attribute	Description	Type	Default
v-model (value)	Names of all checked checkboxes	any[]	-
disabled	Whether to disable all checkboxes	boolean	false
max	Maximum amount of checked options	number | string	0(Unlimited)
direction v2.5.0	Direction, can be set to horizontal	string	vertical
icon-size	Icon size of all checkboxes	number | string	20px
checked-color	Checked color of all checkboxes	string	#1989fa

Checkbox Events

Event	Description	Parameters
change	Triggered when value changed	checked: boolean
click	Triggered when click checkbox	event: Event

CheckboxGroup Events

Event	Description	Parameters
change	Triggered when value changed	names: any[]

Checkbox Slots

Name	Description	SlotProps
default	Custom label	-
icon	Custom icon	checked: boolean

CheckboxGroup Methods

Use ref to get CheckboxGroup instance and call instance methods.

Name	Description	Attribute	Return value
toggleAll	Toggle check status of all checkboxes	checked?: boolean	-

Checkbox Methods

Use ref to get Checkbox instance and call instance methods.

Name	Description	Attribute	Return value
toggle	Toggle check status	checked?: boolean	-