mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-27 20:06:36 +08:00
186 lines
4.1 KiB
Markdown
186 lines
4.1 KiB
Markdown
## Checkbox 复选框
|
|
|
|
### 使用指南
|
|
``` javascript
|
|
import { Checkbox, CheckboxGroup } from 'vant';
|
|
|
|
Vue.use(Checkbox).use(CheckboxGroup);
|
|
```
|
|
|
|
### 代码演示
|
|
|
|
#### 基础用法
|
|
通过`v-model`绑定 checkbox 的勾选状态
|
|
|
|
```html
|
|
<van-checkbox v-model="checked">复选框</van-checkbox>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
checked: true
|
|
};
|
|
}
|
|
};
|
|
```
|
|
|
|
#### 禁用状态
|
|
|
|
```html
|
|
<van-checkbox v-model="checked" disabled>复选框</van-checkbox>
|
|
```
|
|
|
|
#### 自定义图标
|
|
通过 icon 插槽自定义图标，可以通过 `slot-scope` 判断是否为选中状态
|
|
|
|
```html
|
|
<van-checkbox v-model="checked">
|
|
自定义图标
|
|
<img
|
|
slot="icon"
|
|
slot-scope="props"
|
|
:src="props.checked ? icon.active : icon.normal"
|
|
>
|
|
</van-checkbox>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
data() {
|
|
checked: true,
|
|
icon: {
|
|
normal: '//img.yzcdn.cn/icon-normal.png',
|
|
active: '//img.yzcdn.cn/icon-active.png'
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Checkbox 组
|
|
|
|
需要与`van-checkbox-group`一起使用，选中值是一个数组，通过`v-model`绑定在`van-checkbox-group`上，数组中的项即为选中的`Checkbox`的`name`属性设置的值
|
|
|
|
```html
|
|
<van-checkbox-group v-model="result">
|
|
<van-checkbox
|
|
v-for="(item, index) in list"
|
|
:key="item"
|
|
:name="item"
|
|
>
|
|
复选框 {{ item }}
|
|
</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```javascript
|
|
export default {
|
|
data() {
|
|
return {
|
|
list: ['a', 'b', 'c'],
|
|
result: ['a', 'b']
|
|
};
|
|
}
|
|
};
|
|
```
|
|
|
|
#### 设置最大可选数
|
|
|
|
```html
|
|
<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 组件一起使用
|
|
|
|
此时你需要再引入`Cell`和`CellGroup`组件，并通过 checkbox 的 toggle 方法手动触发切换
|
|
|
|
```html
|
|
<van-checkbox-group v-model="result">
|
|
<van-cell-group>
|
|
<van-cell
|
|
v-for="item in list"
|
|
clickable
|
|
:key="item"
|
|
:title="`复选框 ${item}`"
|
|
@click="toggle(index)"
|
|
>
|
|
<van-checkbox :name="item" ref="checkboxes" />
|
|
</van-cell>
|
|
</van-cell-group>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```js
|
|
export default {
|
|
methods: {
|
|
toggle(index) {
|
|
this.$refs.checkboxes[index].toggle();
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Checkbox API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|-----------|-----------|-----------|-------------|
|
|
| name | 标识 Checkbox 名称 | `any` | - |
|
|
| v-model | 是否为选中状态 | `Boolean` | `false` |
|
|
| disabled | 是否禁用单选框 | `Boolean` | `false` |
|
|
| label-disabled | 是否禁用单选框内容点击 | `Boolean` | `false` |
|
|
| label-position | 文本位置，可选值为 `left` | `String` | `right` |
|
|
| shape | 形状，可选值为 `round` `square` | `String` | `round` |
|
|
|
|
### CheckboxGroup API
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
|-----------|-----------|-----------|-------------|
|
|
| v-model | 所有选中项的 name | `Array` | - |
|
|
| disabled | 是否禁用所有单选框 | `Boolean` | `false` |
|
|
| max | 设置最大可选数 | `Number` | `0`（无限制） |
|
|
|
|
### Checkbox Event
|
|
|
|
| 事件名称 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |
|
|
|
|
### CheckboxGroup Event
|
|
|
|
| 事件名称 | 说明 | 回调参数 |
|
|
|-----------|-----------|-----------|
|
|
| change | 当绑定值变化时触发的事件 | 当前组件的值 |
|
|
|
|
### Checkbox Slot
|
|
|
|
| 名称 | 说明 | slot-scope |
|
|
|-----------|-----------|-----------|
|
|
| - | 自定义文本 | - |
|
|
| icon | 自定义图标 | checked: 是否为选中状态 |
|
|
|
|
### Checkbox 方法
|
|
|
|
通过 ref 可以获取到 checkbox 实例并调用实例方法
|
|
|
|
| 方法名 | 参数 | 返回值 | 介绍 |
|
|
|-----------|-----------|-----------|-------------|
|
|
| toggle | - | - | 切换选中状态 |
|
|
|
|
### 更新日志
|
|
|
|
| 版本 | 类型 | 内容 |
|
|
|-----------|-----------|-----------|
|
|
| 1.1.12 | feature | 新增 icon 插槽，支持自定义图标 |
|
|
| 1.1.11 | feature | 新增 label-position 属性 |
|
|
| 1.1.8 | bugfix | 修复 v-model 类型检查错误 |
|
|
| 1.1.0 | bugfix | 修复内容为空时渲染了空 label 元素的问题 |
|