vant/docs/markdown/en-US/checkbox.md

Checkbox

Install

import { Checkbox, CheckboxGroup } from 'vant';

Vue.use(Checkbox).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>

Disable Label click event

<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
    v-for="(item, index) in list"
    :key="item"
    :name="item"
  >
    Checkbox {{ item }}
  </van-checkbox>
</van-checkbox-group>

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

Maximum amount of checked options

<van-checkbox-group v-model="result" :max="2">
  <van-checkbox
    v-for="(item, index) in list"
    :name="item"
    :key="item"
  >
    Checkbox {{ item }}
  </van-checkbox>
</van-checkbox-group>

Inside a Cell

<van-checkbox-group v-model="result">
  <van-cell-group>
    <van-cell v-for="item in list" :title="`Checkbox ${item}`" :key="item">
      <van-checkbox :name="item" />
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

Checkbox API

Attribute	Description	Type	Default	Accepted Values
v-model	Check status	Boolean	false	-
name	Checkbox name	any	-	-
disabled	Diable checkbox	Boolean	false	-
label-disabled	Whether to disable label click	Boolean	false	-
shape	Checkbox shape	String	round	square

CheckboxGroup API

Attribute	Description	Type	Default	Accepted Values
v-model	Names of all checked checkboxes	Array	-	-
disabled	Disable all checkboxes	Boolean	false	-
max	Maximum amount of checked options	Number	0(Unlimited)	-

Checkbox Event

Event	Description	Parameters
change	Triggered when value changed	current value

CheckboxGroup Event

Event	Description	Parameters
change	Triggered when value changed	current value