Checkbox 复选框

引入

在app.json或index.json中引入组件，默认为ES6版本，ES5引入方式参见快速上手

"usingComponents": {
  "van-checkbox": "path/to/vant-weapp/dist/checkbox/index",
  "van-checkbox-group": "path/to/vant-weapp/dist/checkbox-group/index"
}

代码演示

基础用法

通过value绑定 checkbox 的勾选状态

<van-checkbox value="{{ checked }}" bind:change="onChange">复选框</van-checkbox>

Page({
  data: {
    checked: true
  },

  onChange(event) {
    this.setData({
      checked: event.detail
    });
  }
});

禁用状态

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

自定义颜色

<van-checkbox
 value="{{ checked }}"
 checked-color="#07c160"
 bind:change="onChange"
>
 复选框
</van-checkbox>

自定义图标

通过 icon 插槽自定义图标

<van-checkbox use-icon-slot value="{{ checked }}" bind:change="onChange">
  自定义图标
  <image
    slot="icon"
    src="{{ checked ? icon.active : icon.normal }}"
  />
</van-checkbox>

Page({
  data: {
    checked: true,
    icon: {
      normal: '//img.yzcdn.cn/icon-normal.png',
      active: '//img.yzcdn.cn/icon-active.png'
    }
  },

  onChange(event) {
    this.setData({
      checked: event.detail
    });
  }
});

复选框组

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

<van-checkbox-group value="{{ result }}" bind:change="onChange">
  <van-checkbox
    wx:for="{{ list }}"
    wx:key="index"
    name="{{ item }}"
  >
    复选框 {{ item }}
  </van-checkbox>
</van-checkbox-group>

Page({
  data: {
    list: ['a', 'b', 'c'],
    result: ['a', 'b']
  },

  onChange(event) {
    this.setData({
      result: event.detail
    });
  }
});

设置最大可选数

<van-checkbox-group value="{{ result }}" bind:change="onChange" max="{{ 2 }}">
  <van-checkbox
    wx:for="{{ list }}"
    wx:key="index"
    name="{{ item }}"
  >
    复选框 {{ item }}
  </van-checkbox>
</van-checkbox-group>

搭配单元格组件使用

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

<van-checkbox-group value="{{ result }}" bind:change="onChange">
  <van-cell-group >
    <van-cell
      wx:for="{{ list }}"
      wx:key="index"
      title="复选框 {{ item }}"
      value-class="value-class"
      clickable
      data-index="{{ index }}"
      bind:click="toggle"
    >
      <van-checkbox catch:tap="noop" class="checkboxes-{{ index }}" name="{{ item }}" />
    </van-cell>
  </van-cell-group>
</van-checkbox-group>

Page({
  data: {
    list: ['a', 'b', 'c'],
    result: ['a', 'b']
  },

  onChange(event) {
    this.setData({
      result: event.detail
    });
  }

  toggle(event) {
    const { index } = event.currentTarget.dataset;
    const checkbox = this.selectComponent(`.checkboxes-${index}`);
    checkbox.toggle();
  },

  noop() {}
});

.value-class {
  flex: none !important;
}

Checkbox API

参数	说明	类型	默认值
name	标识 Checkbox 名称	String	-
shape	形状，可选值为 round square	String	round
value	是否为选中状态	Boolean	false
disabled	是否禁用单选框	Boolean	false
label-disabled	是否禁用单选框内容点击	Boolean	false
label-position	文本位置，可选值为 left	String	right
use-icon-slot	是否使用 icon slot	Boolean	false
checked-color	选中状态颜色	String	#1989fa

CheckboxGroup API

参数	说明	类型	默认值
name	在表单内提交时的标识符	String	-
value	所有选中项的 name	Array	-
disabled	是否禁用所有单选框	Boolean	false
max	设置最大可选数	Number	0（无限制）

Checkbox Event

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

Checkbox 外部样式类

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

CheckboxGroup Event

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

Checkbox Slot

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

Checkbox 方法

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

方法名	参数	返回值	介绍
toggle	-	-	切换选中状态