mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-05 19:41:45 +08:00
270 lines
6.0 KiB
Markdown
270 lines
6.0 KiB
Markdown
# Checkbox 复选框
|
|
|
|
### 介绍
|
|
|
|
在一组备选项中进行多选。
|
|
|
|
### 引入
|
|
|
|
在`app.json`或`index.json`中引入组件，详细介绍见[快速上手](#/quickstart#yin-ru-zu-jian)。
|
|
|
|
```json
|
|
"usingComponents": {
|
|
"van-checkbox": "@vant/weapp/checkbox/index",
|
|
"van-checkbox-group": "@vant/weapp/checkbox-group/index"
|
|
}
|
|
```
|
|
|
|
## 代码演示
|
|
|
|
### 基础用法
|
|
|
|
通过`value`绑定复选框的勾选状态。
|
|
|
|
```html
|
|
<van-checkbox value="{{ checked }}" bind:change="onChange">复选框</van-checkbox>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
checked: true,
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
checked: event.detail,
|
|
});
|
|
},
|
|
});
|
|
```
|
|
|
|
### 禁用状态
|
|
|
|
通过设置`disabled`属性可以禁用复选框。
|
|
|
|
```html
|
|
<van-checkbox disabled value="{{ checked }}" bind:change="onChange">
|
|
复选框
|
|
</van-checkbox>
|
|
```
|
|
|
|
### 自定义形状
|
|
|
|
将`shape`属性设置为`square`，复选框的形状会变成方形。
|
|
|
|
```html
|
|
<van-checkbox value="{{ checked }}" shape="square" bind:change="onChange">
|
|
复选框
|
|
</van-checkbox>
|
|
```
|
|
|
|
### 自定义颜色
|
|
|
|
通过`checked-color`属性可以自定义选中状态下的图标颜色。
|
|
|
|
```html
|
|
<van-checkbox
|
|
value="{{ checked }}"
|
|
checked-color="#07c160"
|
|
bind:change="onChange"
|
|
>
|
|
复选框
|
|
</van-checkbox>
|
|
```
|
|
|
|
### 自定义大小
|
|
|
|
通过`icon-size`属性可以自定义图标的大小。
|
|
|
|
```html
|
|
<van-checkbox value="{{ checked }}" icon-size="25px">复选框</van-checkbox>
|
|
```
|
|
|
|
### 自定义图标
|
|
|
|
通过 icon 插槽自定义图标。
|
|
|
|
```html
|
|
<van-checkbox use-icon-slot value="{{ checked }}" bind:change="onChange">
|
|
自定义图标
|
|
<image slot="icon" src="{{ checked ? activeIcon : inactiveIcon }}" />
|
|
</van-checkbox>
|
|
```
|
|
|
|
```js
|
|
Page({
|
|
data: {
|
|
checked: true,
|
|
activeIcon: '//img.yzcdn.cn/icon-active.png',
|
|
inactiveIcon: '//img.yzcdn.cn/icon-normal.png',
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
checked: event.detail,
|
|
});
|
|
},
|
|
});
|
|
```
|
|
|
|
### 禁用文本点击
|
|
|
|
通过设置`label-disabled`属性可以禁用复选框文本点击。
|
|
|
|
```html
|
|
<van-checkbox value="{{ checked }}" label-disabled>复选框</van-checkbox>
|
|
```
|
|
|
|
### 复选框组
|
|
|
|
需要与`van-checkbox-group`一起使用，选中值是一个数组，通过`value`绑定在`van-checkbox-group`上，数组中的项即为选中的`Checkbox`的`name`属性设置的值。
|
|
|
|
```html
|
|
<van-checkbox-group value="{{ result }}" bind:change="onChange">
|
|
<van-checkbox name="a">复选框 a</van-checkbox>
|
|
<van-checkbox name="b">复选框 b</van-checkbox>
|
|
<van-checkbox name="c">复选框 c</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
```javascript
|
|
Page({
|
|
data: {
|
|
result: ['a', 'b'],
|
|
},
|
|
|
|
onChange(event) {
|
|
this.setData({
|
|
result: event.detail,
|
|
});
|
|
},
|
|
});
|
|
```
|
|
|
|
### 限制最大可选数
|
|
|
|
```html
|
|
<van-checkbox-group value="{{ result }}" bind:change="onChange" max="{{ 2 }}">
|
|
<van-checkbox name="a">复选框 a</van-checkbox>
|
|
<van-checkbox name="b">复选框 b</van-checkbox>
|
|
<van-checkbox name="c">复选框 c</van-checkbox>
|
|
</van-checkbox-group>
|
|
```
|
|
|
|
### 搭配单元格组件使用
|
|
|
|
此时你需要再引入`Cell`和`CellGroup`组件，并通过 checkbox 的 toggle 方法手动触发切换。
|
|
|
|
```html
|
|
<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>
|
|
```
|
|
|
|
```js
|
|
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() {},
|
|
});
|
|
```
|
|
|
|
```css
|
|
.value-class {
|
|
flex: none !important;
|
|
}
|
|
```
|
|
|
|
## API
|
|
|
|
### Checkbox Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| 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` |
|
|
| icon-size | icon 大小 | _string \| number_ | `20px` |
|
|
|
|
### CheckboxGroup Props
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 |
|
|
| --- | --- | --- | --- |
|
|
| name | 在表单内提交时的标识符 | _string_ | - |
|
|
| value | 所有选中项的 name | _Array_ | - |
|
|
| disabled | 是否禁用所有单选框 | _boolean_ | `false` |
|
|
| max | 设置最大可选数 | _number_ | `0`（无限制） |
|
|
| direction `v1.7.0` | 排列方向，可选值为 `horizontal` | _string_ | `vertical` |
|
|
|
|
### Checkbox Event
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
| ----------- | ------------------------ | ------------ |
|
|
| bind:change | 当绑定值变化时触发的事件 | 当前组件的值 |
|
|
|
|
### Checkbox 外部样式类
|
|
|
|
| 类名 | 说明 |
|
|
| ------------ | -------------- |
|
|
| custom-class | 根节点样式类 |
|
|
| icon-class | 图标样式类 |
|
|
| label-class | 描述信息样式类 |
|
|
|
|
### CheckboxGroup Event
|
|
|
|
| 事件名 | 说明 | 回调参数 |
|
|
| ----------- | ------------------------ | ------------ |
|
|
| bind:change | 当绑定值变化时触发的事件 | 当前组件的值 |
|
|
|
|
### Checkbox Slot
|
|
|
|
| 名称 | 说明 |
|
|
| ---- | ---------- |
|
|
| - | 自定义文本 |
|
|
| icon | 自定义图标 |
|
|
|
|
### Checkbox 方法
|
|
|
|
通过 selectComponent 可以获取到 checkbox 实例并调用实例方法。
|
|
|
|
| 方法名 | 参数 | 返回值 | 介绍 |
|
|
| ------ | ---- | ------ | ------------ |
|
|
| toggle | - | - | 切换选中状态 |
|