# @brighthr/component-checkbox 中文文档

规范地址：https://npmcn.com/package/%40brighthr/component-checkbox/

版本：2\.0\.8
npm 元数据更新时间：2026-02-13T14:53:49.444Z
中文译文更新时间：2026-11-09T21:20:53.835Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40brighthr/component-checkbox
原文对照：https://npmcn.com/package/%40brighthr/component-checkbox/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：33.2 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react \>=16\.9\.0
- 首次发布：2022-10-25T08:42:57.160Z
- 最新版本发布：2026-02-13T14:53:49.290Z
- 近 30 天下载量：1721（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：42（近 12 个月 2 个）

## 中文简介

要安装,请在工程根部的指令行中输入以下内容:

## 安装

```sh
npm install @brighthr/component-checkbox
```

也可以使用：`pnpm add @brighthr/component-checkbox`、`yarn add @brighthr/component-checkbox`、`bun add @brighthr/component-checkbox`

## README

## 复选框

要安装,请在工程根部的指令行中输入以下内容:

```
npm i @brighthr/component-checkbox
```

要在您的工程中执行复选框组件, 您需要添加导入 :

```javascript
import Checkbox from '@brighthr/component-checkbox';
```

在您的工程中添加导入后, 您可以简单地使用 :

```jsx
<Checkbox />
```

## 道具

| 名称 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| 复选框按钮 | `boolean` | `false` | 若为 `true`,使复选框显示按钮. |
| 复选框按钮大小 | `'sm'` `'base'` | `'base'` | 设置按钮外观的大小,如果 `checkboxButton` 实值 `true`。 。 。 . |
| 复选框 | `'left'` `'right'` | `'left'` | 设置复选框的位置. |
| 检查 | `boolean` | `false` | 若为 `true`,复选框将显示所选. |
| 循环检查框 | `boolean` | `false` | 若为 `true`,复选框将循环. |
| 说明 | `string` |  | 设置要显示的描述 . |
| 已禁用 | `boolean` | `false` | 若为 `true`,禁用带有灰色覆盖的复选框. |
| 图标Name | `string` |  | 设置要显示的图标, 如果空出则不显示图标 . |
| 标签 | `string` |  | 设置标签. |

## 常见问题

### @brighthr/component-checkbox 是什么？

要安装,请在工程根部的指令行中输入以下内容:

### 如何安装 @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 和提交记录判断。