Checkbox 复选框

引入

在或index.json中引入组件，详细介绍见快速上手。

基础用法

通过value绑定复选框的勾选状态。

  1. <van-checkbox value="{{ checked }}" bind:change="onChange">复选框</van-checkbox>
  1. Page({
  2.   data: {
  3.     checked: true,
  4.   },
  6.   onChange(event) {
  7.     this.setData({
  8.       checked: event.detail,
  9.     });
  10.   },
  11. });

禁用状态

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

  1. <van-checkbox disabled value="{{ checked }}" bind:change="onChange">
  2.   复选框
  3. </van-checkbox>

自定义形状

  1. <van-checkbox value="{{ checked }}" shape="square" bind:change="onChange">
  2. </van-checkbox>

自定义颜色

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

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

  1. <van-checkbox value="{{ checked }}" icon-size="25px">复选框</van-checkbox>

自定义图标

通过 icon 插槽自定义图标。

  1. <van-checkbox use-icon-slot value="{{ checked }}" bind:change="onChange">
  2.   自定义图标
  3.   <image slot="icon" src="{{ checked ? activeIcon : inactiveIcon }}" />
  4. </van-checkbox>
  1. Page({
  2.   data: {
  3.     checked: true,
  4.     activeIcon: '//img.yzcdn.cn/icon-active.png',
  5.     inactiveIcon: '//img.yzcdn.cn/icon-normal.png',
  6.   },
  8.   onChange(event) {
  9.     this.setData({
  10.       checked: event.detail,
  12.   },
  13. });

禁用文本点击

  1. <van-checkbox value="{{ checked }}" label-disabled>复选框</van-checkbox>

复选框组

需要与van-checkbox-group一起使用，选中值是一个数组，通过value绑定在van-checkbox-group上，数组中的项即为选中的Checkbox的name属性设置的值。

  1. Page({
  2.   data: {
  3.     result: ['a', 'b'],
  4.   },
  6.   onChange(event) {
  7.     this.setData({
  8.       result: event.detail,
  9.     });
  10.   },
  11. });

限制最大可选数

  1. <van-checkbox-group value="{{ result }}" bind:change="onChange" max="{{ 2 }}">
  2.   <van-checkbox name="a">复选框 a</van-checkbox>
  3.   <van-checkbox name="b">复选框 b</van-checkbox>
  4.   <van-checkbox name="c">复选框 c</van-checkbox>
  5. </van-checkbox-group>

搭配单元格组件使用

此时你需要再引入Cell和CellGroup组件，并通过 checkbox 的 toggle 方法手动触发切换。

  1. <van-checkbox-group value="{{ result }}" bind:change="onChange">
  2.     <van-cell
  3.       wx:for="{{ list }}"
  4.       wx:key="index"
  5.       title="复选框 {{ item }}"
  6.       value-class="value-class"
  7.       clickable
  8.       data-index="{{ index }}"
  9.       bind:click="toggle"
  10.     >
  11.       <van-checkbox
  12.         catch:tap="noop"
  14.         name="{{ item }}"
  15.       />
  16.     </van-cell>
  17.   </van-cell-group>
  18. </van-checkbox-group>
  1. Page({
  2.   data: {
  3.     list: ['a', 'b', 'c'],
  4.     result: ['a', 'b']
  5.   },
  7.   onChange(event) {
  8.     this.setData({
  9.       result: event.detail
  10.     });
  11.   },
  13.   toggle(event) {
  14.     const { index } = event.currentTarget.dataset;
  15.     const checkbox = this.selectComponent(`.checkboxes-${index}`);
  16.     checkbox.toggle();
  17.   },
  19.   noop() {}
  20. });

API

CheckboxGroup Props

参数说明类型默认值
name在表单内提交时的标识符string-
value所有选中项的 nameArray-
disabled是否禁用所有单选框booleanfalse
max设置最大可选数number0（无限制）
direction v1.7.0排列方向，可选值为 horizontalstring

Checkbox Event

Checkbox 外部样式类

类名说明
custom-class根节点样式类
icon-class图标样式类
label-class描述信息样式类

CheckboxGroup Event

Checkbox Slot

名称说明
-自定义文本
icon自定义图标

通过 selectComponent 可以获取到 checkbox 实例并调用实例方法。