- Checkbox 复选框
- 代码演示
- 基础用法
- 禁用状态
- 自定义颜色
- 自定义图标
- 复选框组
- 设置最大可选数
- 搭配单元格组件使用
- API
- Checkbox Props
- CheckboxGroup Props
- Checkbox Events
- CheckboxGroup Events
- Checkbox Slots
- Checkbox 方法
Checkbox 复选框
引入
import { Checkbox, CheckboxGroup } from 'vant';
Vue.use(Checkbox).use(CheckboxGroup);
代码演示
基础用法
通过v-model
绑定 checkbox 的勾选状态
<van-checkbox v-model="checked">复选框</van-checkbox>
export default {
data() {
return {
checked: true
};
}
};
禁用状态
<van-checkbox v-model="checked" disabled>复选框</van-checkbox>
自定义颜色
<van-checkbox v-model="checked" checked-color="#07c160">复选框</van-checkbox>
自定义图标
通过 icon 插槽自定义图标,可以通过 slot-scope
判断是否为选中状态
<van-checkbox v-model="checked">
自定义图标
<img
slot="icon"
slot-scope="props"
:src="props.checked ? icon.active : icon.normal"
>
</van-checkbox>
export default {
data() {
checked: true,
icon: {
normal: '//img.yzcdn.cn/icon-normal.png',
active: '//img.yzcdn.cn/icon-active.png'
}
}
}
复选框组
与van-checkbox-group
一起使用,选中值是一个数组,通过v-model
绑定在van-checkbox-group
上,数组中的项即为选中的Checkbox
的name
属性设置的值
<van-checkbox-group v-model="result">
<van-checkbox
v-for="(item, index) in list"
:key="item"
:name="item"
>
复选框 {{ item }}
</van-checkbox>
</van-checkbox-group>
export default {
data() {
return {
list: ['a', 'b', 'c'],
result: ['a', 'b']
};
}
};
设置最大可选数
<van-checkbox-group v-model="result" :max="2">
<van-checkbox
v-for="(item, index) in list"
:key="item"
:name="item"
>
复选框 {{ item }}
</van-checkbox>
</van-checkbox-group>
搭配单元格组件使用
此时你需要再引入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)"
>
<van-checkbox :name="item" ref="checkboxes" />
</van-cell>
</van-cell-group>
</van-checkbox-group>
export default {
methods: {
toggle(index) {
this.$refs.checkboxes[index].toggle();
}
}
}
API
Checkbox Props
参数 | 说明 | 类型 | 默认值 | 版本 |
---|
name | 标识符 | any | - | - |
shape | 形状,可选值为 square | String | round | - |
v-model | 是否为选中状态 | Boolean | false | - |
disabled | 是否禁用复选框 | Boolean | false | - |
icon-size | 图标大小,默认单位为px | String | Number | 20px | 2.0.0 |
label-disabled | 是否禁用复选框文本点击 | Boolean | false | - |
label-position | 文本位置,可选值为 left | String | right | 1.1.11 |
checked-color | 选中状态颜色 | String | #1989fa | 1.4.3 |
CheckboxGroup Props
参数 | 说明 | 类型 | 默认值 | 版本 |
---|
v-model | 所有选中项的标识符 | Array | - | - |
disabled | 是否禁用所有复选框 | Boolean | false | - |
max | 设置最大可选数,0 为无限制 | Number | 0 | - |
Checkbox Events
事件名 | 说明 | 回调参数 |
---|
change | 当绑定值变化时触发的事件 | 当前组件的值 |
click | 点击复选框时触发 | event: Event |
CheckboxGroup Events
事件名 | 说明 | 回调参数 |
---|
change | 当绑定值变化时触发的事件 | 当前组件的值 |
Checkbox Slots
名称 | 说明 | slot-scope |
---|
default | 自定义文本 | - |
icon | 自定义图标 | checked: 是否为选中状态 |
Checkbox 方法
通过 ref 可以获取到 checkbox 实例并调用实例方法