Skip to content

Checkbox 复选框

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

引入

通过 easycom 自动引入,无需手动注册。

代码演示

基础用法

通过 v-model 绑定复选框的勾选状态。

html
<zq-checkbox v-model="checked" label="复选框" />
js
const checked = ref(false)

禁用状态

通过 disabled 属性禁用复选框。

html
<zq-checkbox v-model="checked" label="禁用" disabled />

自定义形状

通过 shape 属性设置形状,支持 round(圆形)和 square(方形)。

html
<zq-checkbox v-model="checked" shape="round" label="圆形" />
<zq-checkbox v-model="checked" shape="square" label="方形" />

自定义颜色

通过 checked-color 属性自定义选中时的颜色。

html
<zq-checkbox v-model="checked" checked-color="#07c160" label="自定义颜色" />

自定义图标大小

通过 icon-size 属性设置图标大小。

html
<zq-checkbox v-model="checked" :icon-size="20" label="大图标" />

标签位置

通过 label-position 属性设置标签位置,支持 leftright

html
<zq-checkbox v-model="checked" label-position="left" label="左侧标签" />

通过插槽自定义标签

html
<zq-checkbox v-model="checked">
  <text>自定义内容</text>
</zq-checkbox>

API

Props

参数说明类型默认值
v-model是否选中booleanfalse
label标签文字string''
disabled是否禁用booleanfalse
shape形状'round' | 'square''round'
checked-color选中时的颜色string''
icon-size图标大小number14
label-position标签位置'left' | 'right''right'

Events

事件名说明回调参数
update:modelValue选中状态变化时触发value: boolean
change选中状态变化时触发value: boolean

Slots

名称说明
default自定义标签内容,优先级高于 label 属性

主题定制

变量名说明
--color-primary选中时默认背景色/边框色
--color-border未选中时边框色
--color-text-primary标签文字颜色
--color-text-disabled禁用时标签颜色

Released under the MIT License.