Skip to content

Checkbox 复选框 ​

允许用户在选中与未选中之间切换的控件。

基础用法 ​

网页近似预览,真机效果以 HarmonyOS 渲染为准。

半选 ​

由子项驱动的“全选”复选框。

网页近似预览,真机效果以 HarmonyOS 渲染为准。

尺寸、描述与卡片 ​

sizing:'sm' | 'default' | 'lg';card 把标签与描述包进一个可按压的带边框盒子。

网页近似预览,真机效果以 HarmonyOS 渲染为准。

API ​

从组件库源码中的 @Param / @Event / @BuilderParam 声明自动提取。

SCheckbox ​

shadcn-vue 的 Checkbox:size-4 rounded-[4px] border border-input shadow-xs,选中时为 bg-primary border-primary text-primary-foreground,并显示 check 图标(size-3.5)。

变体:sizing 取 sm | default | lg;description(标签下方的弱化文字);card(带边框、可按下的选择卡片,选中时高亮)。

indeterminate 会显示 minus 标记(对应 shadcn-vue 的 'indeterminate' 模型值);点击后会触发 true,父组件应负责清除 indeterminate。可选的 label 也属于点击区域。请通过 onCheckedChange / !! 响应变化(控件自身的点击会接管 SCheckbox 上的 .onClick())。

属性类型默认值说明
checked!!boolean | undefinedundefined受控状态(配合 !! 使用)。留空则为非受控。
defaultCheckedbooleanfalse
indeterminatebooleanfalse
disabledbooleanfalse
invalidbooleanfalse错误外观(aria-invalid:destructive 边框)。
labelResourceStr | undefinedundefined显示在右侧的文字;同样可点击。
descriptionResourceStr | undefinedundefined标签下方弱化的辅助文字。
sizingChoiceSize
ChoiceSize = 'sm' | 'default' | 'lg'
'default'
cardbooleanfalse包裹复选框、标签与描述的带边框选择卡片。
tokensCheckboxTokens{}实例级令牌覆盖(实例 → 主题 --checkbox-* → 配方),参见 {@link CheckboxTokens}。
事件类型默认值说明
onCheckedChange(v: boolean) => void() => { }

MIT Licensed