Skip to content

Checkbox 多选框

在一组备选项中进行多选。

基础用法

单独使用可以表示两种状态之间的切换,写在标签中的内容为 checkbox 按钮后的介绍。

受控和非受控模式

VkCheckbox 组件支持两种使用模式:非受控模式(使用 v-model)和受控模式(使用 :value + 事件)。

非受控模式

使用 v-model 进行双向数据绑定,组件内部管理状态。

当前值: false

受控模式

使用 :checked 单向绑定配合 @change@update:modelValue 事件,由父组件完全控制状态。

当前值: false

当前值: false

禁用状态

多选框不可用状态。

多选框组

适用于多个勾选框绑定到同一个数组的情景,通过是否勾选来表示这一组选项中选中的项。

不确定状态

indeterminate 属性用以表示 checkbox 的不确定状态,一般用于实现全选的效果。

可选项目数量的限制

使用 minmax 属性能够限制可以被勾选的项目的数量。

尺寸

使用 size 属性改变多选框大小。

API

Checkbox Props

名称类型默认值说明
size'small' | 'medium' | 'large''medium'多选框大小
disabledbooleanfalse是否禁用
valuestring | number | boolean选中状态的值(在 checkbox-group 下有效)
labelstring多选框的文本
indeterminatebooleanfalse设置不确定状态,仅负责样式控制
checkedbooleanfalse当前是否勾选
customClassstring自定义类名
customStylestring | object自定义样式

CheckboxGroup Props

名称类型默认值说明
size'small' | 'medium' | 'large''medium'多选框组大小
disabledbooleanfalse是否禁用
minnumber可被勾选的 checkbox 的最小数量
maxnumber可被勾选的 checkbox 的最大数量
customClassstring自定义类名
customStylestring | object自定义样式

Checkbox Events

名称参数说明
change(value: boolean) => void当绑定值变化时触发

CheckboxGroup Events

名称参数说明
change(value: CheckboxValue[]) => void当绑定值变化时触发

Checkbox Slots

名称说明
default多选框的文本

CheckboxGroup Slots

名称说明
default多选框组的内容

Checkbox Methods

名称说明
focus使多选框获取焦点
blur使多选框失去焦点

基于 MIT 协议发布