Checkbox 复选框

使用指南

在 app.json 或 index.json 中引入组件

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

禁用状态

<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 }}"
      clickable
      data-name="{{ item }}"
      bind:click="toggle"
    >
      <van-checkbox catch:tap="noop" class="checkboxes-{{ item }}" 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 { name } = event.currentTarget.dataset;
    const checkbox = this.selectComponent(`.checkboxes-${name}`);
    checkbox.toggle();
  },
  noop() {}
});

Checkbox API

CheckboxGroup API

Checkbox Event

CheckboxGroup Event

Checkbox Slot

Checkbox 方法

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

更新日志

原文: https://youzan.github.io/vant-weapp/#/checkbox