vant/src/checkbox/README.zh-CN.md

Checkbox 复选框

引入

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

Vue.use(Checkbox);
Vue.use(CheckboxGroup);

代码演示

基础用法

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

<van-checkbox v-model="checked">复选框</van-checkbox>

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

禁用状态

通过设置disabled属性可以禁用复选框

<van-checkbox v-model="checked" disabled>复选框</van-checkbox>

自定义形状

将shape属性设置为square，复选框的形状会变成方形

<van-checkbox v-model="checked" shape="square">复选框</van-checkbox>

自定义颜色

通过checked-color属性可以自定义选中状态下的图标颜色

<van-checkbox v-model="checked" checked-color="#07c160">复选框</van-checkbox>

自定义大小

通过icon-size属性可以自定义图标的大小

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

自定义图标

通过 icon 插槽自定义图标，可以通过slotProps判断是否为选中状态

<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>

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

禁用文本点击

设置label-disabled属性后，点击图标以外的内容不会触发复选框切换

<van-checkbox v-model="checked" label-disabled>复选框</van-checkbox>

复选框组

复选框可以与复选框组一起使用，复选框组通过v-model数组绑定复选框的勾选状态

<van-checkbox-group v-model="result">
  <van-checkbox name="a">复选框 a</van-checkbox>
  <van-checkbox name="b">复选框 b</van-checkbox>
</van-checkbox-group>

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

水平排列

将direction属性设置为horizontal后，复选框组会变成水平排列

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

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

限制最大可选数

通过max属性可以限制复选框组的最大可选数

<van-checkbox-group v-model="result" :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="result" 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="info" @click="toggleAll">反选</van-button>

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

搭配单元格组件使用

此时你需要再引入Cell和CellGroup组件，并通过Checkbox实例上的 toggle 方法触发切换

<van-checkbox-group v-model="result">
  <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="checkboxes" />
    </template>
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

export default {
  data() {
    return {
      list: ['a', 'b'],
      result: []
    };
  },
  methods: {
    toggle(index) {
      this.$refs.checkboxes[index].toggle();
    }
  }
}

API

Checkbox Props

参数	说明	类型	默认值
v-model (value)	是否为选中状态	boolean	false
name	标识符	any	-
shape	形状，可选值为 square	string	round
disabled	是否禁用复选框	boolean	false
label-disabled	是否禁用复选框文本点击	boolean	false
label-position	文本位置，可选值为 left	string	right
icon-size	图标大小，默认单位为px	number | string	20px
checked-color	选中状态颜色	string	#1989fa
bind-group v2.2.4	是否与复选框组绑定	boolean	true

CheckboxGroup Props

参数	说明	类型	默认值
v-model (value)	所有选中项的标识符	any[]	-
disabled	是否禁用所有复选框	boolean	false
max	最大可选数，0为无限制	number | string	0
direction v2.5.0	排列方向，可选值为horizontal	string	vertical
icon-size v2.2.3	所有复选框的图标大小，默认单位为px	number | string	20px
checked-color v2.2.3	所有复选框的选中状态颜色	string	#1989fa

Checkbox Events

事件名	说明	回调参数
change	当绑定值变化时触发的事件	checked: boolean
click	点击复选框时触发	event: Event

CheckboxGroup Events

事件名	说明	回调参数
change	当绑定值变化时触发的事件	names: any[]

Checkbox Slots

名称	说明	SlotProps
default	自定义文本	-
icon	自定义图标	checked: boolean

CheckboxGroup 方法

通过 ref 可以获取到 CheckboxGroup 实例并调用实例方法，详见组件实例方法

方法名	说明	参数	返回值
toggleAll	切换所有复选框，传true为选中，false为取消选中，不传参为取反	checked?: boolean	-

Checkbox 方法

通过 ref 可以获取到 Checkbox 实例并调用实例方法，详见组件实例方法

方法名	说明	参数	返回值
toggle	切换选中状态，传true为选中，false为取消选中，不传参为取反	checked?: boolean	-