复选框

基于 React Aria 构建的 16px 复选框。选中和不确定状态使用 Figma 内部高亮显示主要渐变,并且刻度线通过描边动画绘制自身。

安装

您可以使用我们的 CLI 或手动添加此复选框组件:

已支持深色模式,此 组件 会自动使用 BoardUI 的语义设计变量。 设置主题切换.

CLI 将组件源(及其内部依赖项)复制到您的项目中并安装任何所需的 npm 包。

npx boardui@latest add checkbox

使用共享 UI 包或自定义导入别名? 配置您的安装路径 在运行 CLI 之前。复制粘贴示例使用默认导入。

尺寸

两种尺寸通过 尺寸 属性 - MD (16px,默认值)和 SM (14px,用于密集表格)。

MD-16 像素
sm-14px
<Checkbox size="md" defaultSelected /> {/* 16px (default) */}<Checkbox size="sm" defaultSelected /> {/* 14px */}

标签和控制

通行证 儿童 对于标签 - React Aria 会自动将其与输入关联起来。使用 isSelected + onChange 对于受控状态,或 defaultSelected 对于不受控制的。

{/* children become the label - clicking it toggles the box */}<Checkbox defaultSelected>Remember me</Checkbox><Checkbox>Send me product updates</Checkbox> {/* Controlled */}<Checkbox isSelected={checked} onChange={setChecked}>Terms</Checkbox>

卡

带有标题和可选描述的可选卡片 - 整个卡片切换复选框并显示悬停背景。它是一个单独的注册表项: npx boardui add checkbox-card.

import { CheckboxCard } from "@/components/base/checkbox/checkbox-card"; <CheckboxCard title="Item title" description="This is for you to check." /><CheckboxCard defaultSelected title="Item title" description="This is for you to check." /><CheckboxCard title="No description" />