vant/docs/examples-docs/checkbox.md

Checkbox 复选框

使用指南

import { Checkbox } from 'vant';

Vue.component(Checkbox.name, Checkbox);

代码演示

基础用法

通过v-model绑定 checkbox 的勾选状态

:::demo 基础用法

<div class="van-checkbox-wrapper">
  <van-checkbox v-model="checkbox1">复选框1</van-checkbox>
</div>

export default {
  data() {
    return {
      checkbox1: true
    };
  }
};

:::

禁用状态

设置disabled属性即可，此时Checkbox不能点击。

:::demo 禁用状态

<div class="van-checkbox-wrapper">
  <van-checkbox v-model="checkbox2" disabled>复选框2</van-checkbox>
</div>

export default {
  data() {
    return {
      checkbox2: true
    };
  }
};

:::

Checkbox组

需要与van-checkbox-group一起使用，值通过v-model绑定在van-checkbox-group上，例如下面的result，此时result的值是一个数组。数组中的项即为选中的Checkbox的name属性设置的值。

:::demo Checkbox组

<div class="van-checkbox-wrapper">
  <van-checkbox-group v-model="result">
    <van-checkbox v-for="(item, index) in list" :key="index" :name="item">复选框{{item}}</van-checkbox>
  </van-checkbox-group>
</div>

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

  watch: {
    result(val) {
      console.log(val);
    }
  }
};

:::

禁用Checkbox组

禁用van-checkbox-group，此时整个组都不可点击。

:::demo 禁用Checkbox组

<div class="van-checkbox-wrapper">
  <van-checkbox-group v-model="result" disabled>
    <van-checkbox v-for="(item, index) in list" :key="index" :name="item">复选框{{item}}</van-checkbox>
  </van-checkbox-group>
</div>

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

:::

与Cell组件一起使用

此时你需要再引入Cell和CellGroup组件。

:::demo 与Cell组件一起使用

<van-checkbox-group v-model="result">
  <van-cell-group>
    <van-cell v-for="(item, index) in list" :key="index">
      <van-checkbox :name="item">复选框{{item}}</van-checkbox>
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

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

:::

Checkbox API

参数	说明	类型	默认值	可选值
disabled	是否禁用单选框	Boolean	false	-
name	根据这个来判断radio是否选中	Boolean	false	-

CheckboxGroup API

参数	说明	类型	默认值	可选值
disabled	是否禁用单选框	Boolean	false	-

Checkbox Event

事件名称	说明	回调参数
change	当绑定值变化时触发的事件	当前组件的值

CheckboxGroup Event

事件名称	说明	回调参数
change	当绑定值变化时触发的事件	当前组件的值