# Checkbox 多选框

这是一个选择控件,通过单击在选中和未选中之间切换。

# 属性对比(只显示有差异的)

Checkbox
Checkbox-Button
WinDesign Element-ui
size
可选值: large / medium / small / mini
可选值: medium / small / mini
true-value
属性名: true-value
属性名: true-label
false-value
属性名: false-value
属性名: false-label
wrap
Checkbox-Group WinDesign Element-ui
discrete
round
plain
wrap
fill
text-color

# 代码演示

国际化(多语言)

1、超出换行显示全部 2、以单词换行

Vue.use(WinDesign, { i18nOverflow: true })
1

# API

# Checkbox Attributes

参数 说明 类型 可选值 默认值 Version
border 是否加边框样式(仅 checkbox 生效) Boolean — false
checked 当前是否勾选 Boolean — false
disabled 是否禁用 Boolean — false
false-value 多选框未被选中时的值 String | Number — — v1.4.4
indeterminate 是否半选状态(仅为样式层面的控制) Boolean — false
label 选中值(只有在checkbox-group时有效) String | Number | Boolean — —
name 原生 name 属性 String — —
true-value 多选框被选中时的值 String | Number — — v1.4.4
value / v-model 绑定值 String | Boolean | Number — —
wrap 是否换行(仅针对边距样式调整) Boolean — — v2.2.2
size Checkbox 的尺寸,仅在 border 为真时有效 string large / medium / small / mini — V2.2.5
size Checkbox 的尺寸(默认) string large / medium / default — V2.4.37
disabled-highlight 是否使已选且禁用的文字凸显 Boolean — false V2.3.10
text-overflow 文字超出时是否换行 string visible / hidden hidden V2.4.1
tight 是否开启紧凑版(左右间距均为 8px) Boolean — false V2.4.33

# Checkbox-Button Attributes

参数 说明 类型 可选值 默认值 Version
show-badge 是否显示右上角角标(仅 checkbox-button 有效,适用于轻量化且非圆角按钮) Boolean — false V2.3.2
border 是否加边框样式(仅 checkbox 生效) Boolean — false
checked 当前是否勾选 Boolean — false
disabled 是否禁用 Boolean — false
false-value 多选框未被选中时的值 String | Number — — v1.4.4
label 选中值(只有在checkbox-group时有效) String | Number | Boolean — —
name 原生 name 属性 String — —
true-value 多选框被选中时的值 String | Number — — v1.4.4
value / v-model 绑定值 String | Boolean | Number — —
disabled-highlight 是否使已选且禁用的文字凸显 Boolean — false V2.4.19
tight 是否开启紧凑版(左右间距均为 8px) Boolean — false V2.4.33

# Checkbox 、Checkbox-Button Events

事件名称 说明 回调参数
change 当绑定值变化时触发的事件 更新后的值

# Checkbox-Group Attributes

参数 说明 类型 可选值 默认值 Version
discrete 按钮组是否离散(按钮不相连) Boolean — — v1.7.10
disabled 是否禁用 Boolean — false v1.7.12
max 可被勾选的最大项数 Number — —
min 可被勾选的最小项数 Number — —
plain 轻量级按钮组 Boolean — — v1.5.1
round 圆角按钮样式(仅按钮样式组可用) Boolean — — v1.5.0
value / v-model 绑定值 Array — —
size 多选框组尺寸,仅对按钮形式的 Checkbox 或带有边框的 Checkbox 有效 String 'large' | 'medium' | 'small' | 'mini' 'medium'
wrap 是否换行(仅针对边距样式调整) Boolean — — v2.2.2
direction 横向/纵向排列 String — 'horizontal' v2.4.27
tight 是否开启紧凑版(左右间距均为 8px) Boolean — false V2.4.33

# Checkbox-Group Events

事件名称 说明 回调参数 Version
change 当绑定值变化时触发的事件 更新后的值
上次更新: 11/4/2025, 2:11:29 PM