# @brighthr/component-button 中文文档

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

版本：3\.0\.8
npm 元数据更新时间：2026-06-12T10:59:07.357Z
中文译文更新时间：2026-11-09T23:43:44.770Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：32.4 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react \>=16\.9\.0
- 首次发布：2021-11-17T12:28:09.662Z
- 最新版本发布：2026-06-12T10:59:07.187Z
- 近 30 天下载量：1697（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 2 个）

## 中文简介

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

## 安装

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

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

## README

## 按钮

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

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

要在您的项目中执行按钮组件, 您需要添加导入:

```javascript
import Button from '@brighthr/component-button';
```

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

```jsx
<Button />
```

## 道具

| 名称 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| 颜色 | `'primary'` `'accent'` `'error'` `'white'` | `'accent'` | 设置按钮的颜色. |
| 全网风 | `boolean` | `false` | 设置按钮宽度到 `100%`。 。 。 . |
| 图标Name | `string` |  | 设置要显示的图标, 使用 `calendar-dates` 如果空闲. |
| 图标 | `'left'` `'right'` |  | 设置图标的位置,如果图标留空,则不会显示. |
| 正在丢失 | `boolean` | `false` | 若为 `true`装入旋转器会显示. |
| 大纲按钮 | `boolean` | `false` | 若为 `true`,按钮将有一个白色背景. |
| 大小 | `'xs'` `'sm'` `'base'` `'lg'` `'xl'` | `'base'` | 设置按钮的大小. |
| 文本 | `string` |  | 设置按钮文本. |
| 文本按钮 | `boolean` | `false` | 若为 `true`,使按钮显示文字. |

## 常见问题

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

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

### 如何安装 @brighthr/component-button？

在项目目录运行 npm install @brighthr/component-button，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.9\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @brighthr/component-button 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @brighthr/component-button 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @brighthr/component-button 可以商用吗？

@brighthr/component-button 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @brighthr/component-button 的下载量有多少？

根据 npm 官方下载统计，@brighthr/component-button 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,697 次，日均约 57 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @brighthr/component-button 还在维护吗？

最新版本 3\.0\.8 发布于 2026/06/12（4 个月前）；至今共发布 67 个版本，其中过去 12 个月发布了 2 个；首次发布于 2021/11/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。