# Checkbox 多选框
# Checkbox 概述
基本组件-多选框。主要用于一组可选项的多项选择,或者单独用于标记切换某种状态。
# Checkbox 代码演示
# 单独使用
使用 v-model
可以双向绑定数据。
# 组合使用
使用Checkbox-group
配合数组来生成组合。在组合使用时,Checkbox
使用 label
来自动判断选中状态。每个 Checkbox
的内容可以自定义,如不填写则默认使用 label
的值。
设置属性 vertical
可以垂直显示,按钮样式下无效。
# 不可用
通过设置disabled
属性来禁用多选框。
# 与其它组件通信
与其它组件进行数据联动。
# 全选
在实现全选效果时,你可能会用到 indeterminate
属性。示例代码只是一种写法,业务中可以用更多的方法,比如计算属性
# Checkbtn 多选按钮组
多选按钮,以数组的形式返回按钮的value
# Checkbox API
# Checkbox props
属性 | 说明 | 类型 | 默认值 |
---|---|---|---|
value | 只在单独使用时有效。可以使用 v-model 双向绑定数据 | Boolean | false |
label | 只在组合使用时有效。指定当前选项的 value 值,组合会自动判断是否选中 | String | Number | Boolean | - |
disabled | 是否禁用当前项 | Boolean | false |
indeterminate | 设置 indeterminate 状态,只负责样式控制 | Boolean | false |
size | 多选框的尺寸,可选值为 large、small、default 或者不设置 | String | - |
true-value | 选中时的值,当使用类似 1 和 0 来判断是否选中时会很有用 | String, Number, Boolean | true |
false-value | 没有选中时的值,当使用类似 1 和 0 来判断是否选中时会很有用 | String, Number, Boolean | false |
text | 显示文字,层级高于label,低于slot (v1.0.37) | String, Number | null |
tabindex | 设置输入框 tabindex (v1.0.47) | String | Number | 0 |
# Checkbox events
事件名 | 说明 | 返回值 |
---|---|---|
on-change | 只在单独使用时有效。在选项状态发生改变时触发,通过修改外部的数据改变时不会触发 | true | false |
on-focus | 获取焦点时生效 | event |
on-blur | 失去焦点时生效 | event |
# CheckboxGroup props
属性 | 说明 | 类型 | 默认值 |
---|---|---|---|
value | 指定选中项目的集合,可以使用 v-model 双向绑定数据 | Array | [] |
label-in-value | 在返回选项时,是否将 label 和 value 一并返回,默认只返回 value ( checkbox 时返回的是 value 为 label 值。label 为 text 值) (v1.0.37) | Boolean | false |
vertical | 是否垂直排列,按钮样式下无效 (v1.0.34) | Boolean | false |
# CheckboxGroup events
事件名 | 说明 | 返回值 |
---|---|---|
on-change | 在选项状态发生改变时触发,返回已选中的数组。通过修改外部的数据改变时不会触发,如需返回 label,详见 label-in-value 属性 | [...] |
# Checkbtn props(只在v1.0.20及以上有效)
属性 | 说明 | 类型 | 默认值 |
---|---|---|---|
value | 必填,当前按钮关键字,属性值,用于多选按钮组返回 | String | - |
label | 当前按钮的显示文字 | String | - |
disabled | 是否禁用当前按钮项 | Boolean | false |
icon | 选中时按钮角标 | string | right |
# Checkbtn events (只在v1.0.20及以上有效)
事件名 | 说明 | 返回值 |
---|---|---|
on-click | 点击时触发 | event 当前触发时间目标源stautus 当前按钮项的选中状态 |
# Checkbtn slot (只在v1.0.20及以上有效)
属性名 | 说明 |
---|---|
- | 默认分发,替代按钮项的 label |