Checkbox
To install, type the following into the command line at the root of your project:
npm i @brighthr/component-checkbox
To implement the Checkbox component into your project you’ll need to add the import:
import Checkbox from '@brighthr/component-checkbox';
After adding import into your project you can use it simply like:
<Checkbox />
Props
| Name | Type | Default | Description |
|---|
| checkboxButton | boolean | false | If true, gives the checkbox a button appearance. |
| checkboxButtonSize | 'sm' 'base' | 'base' | Sets the size of the button appearance if checkboxButton is true. |
| checkboxPosition | 'left' 'right' | 'left' | Sets the position of the checkbox. |
| checked | boolean | false | If true, the checkbox will show as selected. |
| circularCheckbox | boolean | false | If true, the checkbox will be circular. |
| description | string | | Sets a description to show. |
| disabled | boolean | false | If true, disables the checkbox with a gray overlay. |
| iconName | string | | Sets the icon to display, no icon is displayed if left empty. |
| label | string | | Sets the label. |
关于 @brighthr/component-checkbox 的常见问题
@brighthr/component-checkbox 是什么？
To install, type the following into the command line at the root of your project:
如何安装 @brighthr/component-checkbox？
在项目目录运行 npm install @brighthr/component-checkbox，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（>=16.9.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。
@brighthr/component-checkbox 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@brighthr/component-checkbox 支持 ESM 还是 CommonJS？
同时提供 ES Module 与 CommonJS 入口，import 和 require() 都可以使用，打包工具会自动选择合适的版本。
@brighthr/component-checkbox 可以商用吗？
@brighthr/component-checkbox 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@brighthr/component-checkbox 的下载量有多少？
根据 npm 官方下载统计，@brighthr/component-checkbox 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,721 次，日均约 57 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@brighthr/component-checkbox 还在维护吗？
最新版本 2.0.8 发布于 2026/02/13（8 个月前）；至今共发布 42 个版本，其中过去 12 个月发布了 2 个；首次发布于 2022/10/25。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。