Checkbox 复选框
Checkbox 多项选择器,需结合wui-checkbox-group和wui-checkbox组件一起使用。微信、百度、QQ小程序中还使用了 wui-form-field 组件(如果未使用easycom组件规范,请在 wui-checkbox-group 组件中手动引入、注册该组件)。
# 支持平台
| App(vue) | App(nvue) | H5 | 小程序 |
|---|---|---|---|
| ✓ | ✓ | ✓ | ✓ |
# 代码演示
部分示例演示,完整使用请参考文档API。
# 基本使用
可通过v-model直接获取选中的值,也可通过change事件来获取。
<wui-checkbox-group name="checkbox" v-model="vals" @change="change">
<view class="wui-list__item">
<wui-label>
<view class="wui-align__center">
<wui-checkbox value="1" checked></wui-checkbox>
<text class="wui-text">选中</text>
</view>
</wui-label>
<wui-label :margin="['0','0','0','40rpx']">
<view class="wui-align__center">
<wui-checkbox value="2"></wui-checkbox>
<text class="wui-text">未选中</text>
</view>
</wui-label>
</view>
</wui-checkbox-group>
# Slots
# wui-checkbox-group 组件
| 插槽名称 | 说明 |
|---|---|
| default | 标签显示内容,内部由多个wui-checkbox组成 |
# wui-checkbox 组件
| 插槽名称 | 说明 |
|---|---|
| - | - |
# wui-form-field 组件
该组件主要用于表单传递数据,仅微信、百度、QQ小程序端使用。
| 插槽名称 | 说明 |
|---|---|
| default | 标签内显示内容,内部由多个wui-checkbox组成 |
# Props
# wui-checkbox-group 组件
| 属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
|---|---|---|---|---|
| name | String | 单向选择器名称 | - | - |
| value | Array | 选中的value值,用于双向绑定,vue2使用 | [ ] | - |
| modelValue | Array | 选中的value值,用于双向绑定,vue3使用 | [ ] | - |
# wui-checkbox 组件
| 属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
|---|---|---|---|---|
| value | String | value值,当选中时会携带该值 | - | - |
| checked | Boolean | 是否选中 | false | - |
| disabled | Boolean | 是否禁用 | false | - |
| color | String | 选中时背景颜色 | #465CFF | 非Nvue端默认为空,可以通过css变量(--wui-color-primary)修改默认颜色值 |
| borderColor | String | 未选中时边框颜色 | #ccc | - |
| borderRadius | String | 圆角值 | nvue:40rpx,非nvue:50% | nvue只能传入具体值,不可使用百分比 |
| isCheckMark | Boolean | 是否只展示对号,无边框背景 | false | - |
| checkMarkColor | String | 对号颜色 | #fff | - |
| scaleRatio | Number, String | 缩放比例 | 1 | - |
# wui-form-field 组件
| 属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
|---|---|---|---|---|
| hidden | Boolean | 是否为隐藏域 | false | 微信、百度、QQ小程序 |
# Events
# wui-checkbox-group 组件
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| @change | 选中项发生变化时触发 | event.detail = { value } |
| @input vue2 | 用于组件双向绑定,使用v-model指令即可 | value |
| @update:modelValue vue3 | 用于组件双向绑定,使用v-model指令即可 | modelValue |
# wui-checkbox 组件
温馨提示
- wui-checkbox组件可独立使用。
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| @change | 选中状态发生改变时触发 | event.detail = { value, checked } |