Checkbox 复选框

使用指南

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

  1. "usingComponents": {
  2. "van-checkbox": "path/to/vant-weapp/dist/checkbox/index",
  3. "van-checkbox-group": "path/to/vant-weapp/dist/checkbox-group/index"
  4. }

代码演示

基础用法

通过value绑定 checkbox 的勾选状态

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

禁用状态

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

自定义颜色

  1. <van-checkbox
  2. value="{{ checked }}"
  3. checked-color="#07c160"
  4. bind:change="onChange"
  5. >
  6. 复选框
  7. </van-checkbox>

自定义图标

通过 icon 插槽自定义图标

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

复选框组

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

  1. <van-checkbox-group value="{{ result }}" bind:change="onChange">
  2. <van-checkbox
  3. wx:for="{{ list }}"
  4. wx:key="index"
  5. name="{{ item }}"
  6. >
  7. 复选框 {{ item }}
  8. </van-checkbox>
  9. </van-checkbox-group>
  1. Page({
  2. data: {
  3. list: ['a', 'b', 'c'],
  4. result: ['a', 'b']
  5. },
  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
  3. wx:for="{{ list }}"
  4. wx:key="index"
  5. name="{{ item }}"
  6. >
  7. 复选框 {{ item }}
  8. </van-checkbox>
  9. </van-checkbox-group>

搭配单元格组件使用

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

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

Checkbox API

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

CheckboxGroup API

参数说明类型默认值
name在表单内提交时的标识符String-
value所有选中项的 nameArray-
disabled是否禁用所有单选框Booleanfalse
max设置最大可选数Number0(无限制)

Checkbox Event

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

CheckboxGroup Event

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

Checkbox Slot

名称说明slot-scope
-自定义文本-
icon自定义图标checked: 是否为选中状态

Checkbox 方法

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

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

更新日志

版本类型内容
0.3.5feature新增组件

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