# @benefex/icons 中文文档

规范地址：https://npmcn.com/package/%40benefex/icons/

版本：0\.51\.0
npm 元数据更新时间：2026-11-06T13:56:19.896Z
中文译文更新时间：2026-11-07T22:06:44.974Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40benefex/icons
原文对照：https://npmcn.com/package/%40benefex/icons/?lang=original
项目主页：https://github.com/benifex/onehub-icons#readme
源码仓库：https://github.com/benifex/onehub-icons

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

- 包体积（解压后）：735 kB，1007 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react 16 - 18
- 首次发布：2024-06-06T08:20:39.979Z
- 最新版本发布：2026-11-06T13:56:19.644Z
- 近 30 天下载量：7128（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：248（近 12 个月 136 个）

## 中文简介

受益图标包

## 安装

```sh
npm install @benefex/icons
```

也可以使用：`pnpm add @benefex/icons`、`yarn add @benefex/icons`、`bun add @benefex/icons`

## README

# 圆柱形

SVG 自动转换为 TSX 使用 [图像](https://react-svgr.com/)

## 添加/更新图标

-   添加或更新 svg 在 `src/svgs`
-   确保它有 `fill="currentColor` 或者说 `stroke="currentColor"`
-   确保它有一个取景框( 宽度, 高度将被去除)
-   如果图标是方向性的(它指向左或右,例如箭头、chevron或日志出图标),则添加 `data-bfx-rtl="flip"` 转到根 `<svg>` 故以RTL为镜. 见 [RTL 支持](https://npmcn.com/package/%40benefex/icons/#readme-rtl-support)。 。 。 .

### 版本

使用 [语义版本](https://semver.org/)数字 :

-   `major` 当您做出不兼容的 API 更改时的版本
-   `minor` 当您以向后兼容的方式添加功能时的版本
-   `patch` 当您使反相兼容的错误修正时的版本

所有最新版本的部署均由 [语义释放](https://github.com/semantic-release/semantic-release) 在 CircleCI 中被触发 `main` 输油管. _语义释放_ 将查看您的承诺信息,并确定如何根据其格式增加该版本。 见 [这里](https://github.com/TrigenSoftware/simple-release/blob/main/GUIDE.md) 详细了解如何运作. [承诺](https://commitlint.js.org/) 钩子用于确保您的承诺信息在推进前正确无误.

总结:

-   `feat` 是一个小版本的凸起
-   `fix` 是一个补丁版本的凸起
-   `perf` 是一个补丁版本的凸起
-   承诺 `!` 在类型(或范围)后是一个主要版本的凸起. 缩写: `feat!: add image` 或者说 `feat(new)!: add image`
-   所有其他类型都不会造成任何版本的出错

_\* 这是完全定制的,因此可以更新,以更好地满足我们的需要_

当拉出请求被合并为主时,CircleCI主工作流程运行,将进行所有必要的npm发布和git标记,同时创建包含发布注释的Github发布.

#### Beta 部署

所有牵引请求都将部署一个β版本作为公关管道的一部分. 这样就可以轻松进行测试,而无需合并您的PR. 版本将部署 `{CURRENT_MAJOR_VERSION}.0.0-PR${PULL_REQUEST_NUMBER}-BN${BUILD_NUM}`。例如: `7.0.0-PR100-BN150`

#### 检查您的分支所使用的版本

我们没有跟踪当前版本的软件包[为什么没有必要?](https://semantic-release.gitbook.io/semantic-release/support/faq#it-is-not-needed-for-semantic-release-to-do-its-job)) (中文(简体) ). 然而,要打印您的分支使用的软件包版本, 请运行 `npm run check-version`

## 使用量

### 通过 npm 安装 :

```bash
pnpm install --save @benefex/icons
```

### 导入图标 :

您可以通过可选标题道具 - [https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title (中文(简体) )](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/title)

```js
import { IconName } from '@benefex/icons';
import { Icon } from '@benefex/components';

<Icon svg={IconName} title="Icon Label" />;
```

### 动画图标

导入动画样式表一次, 然后添加 `bfx-icon--animated` 到支持图标的父目录。 目前,火花和上传图标支持动画.

```js
import '@benefex/icons/animations.css';
import { SparklesLight } from '@benefex/icons';

<span className="bfx-icon--animated">
  <SparklesLight aria-hidden="true" />
</span>;
```

### RTL 支持

方向图标在从右到左的背景中镜像 。 导入一次 RTL 样式表, 当它们坐在元素内时会翻转 `dir="rtl"` (或 `direction: rtl`:

```js
import '@benefex/icons/rtl.css';
import { ArrowRightLight } from '@benefex/icons';

<div dir="rtl">
  <ArrowRightLight aria-hidden="true" />
</div>;
```

除非样式表被导入,否则不会翻转 .

选择一个表示物理方向的图标(例如地图或指南针箭头),将其用 `dir="ltr"`图标尾随最近的 `dir`,因此只有图标受到影响:

```js
<span dir="ltr">
  <ArrowRightLight aria-hidden="true" />
</span>
```

如果无法加包装,请添加 `bfx-icon--rtl-fixed` 改为图标或其父母之一:

```js
<ArrowRightLight className="bfx-icon--rtl-fixed" aria-hidden="true" />
```

#### 将图标标记为 RTL

添加 `data-bfx-rtl="flip"` 转到根 `<svg>` 内 `src/svgs`。只有当镜像复制品是正确的RTL图标时,即艺术品是平面镜像。 不要把它添加到带有文字,标志的图标上,或者每个语言读取相同方式的符号上.

属性通过生成器时不变. 检查结果在 `Icons/RTL` 童话故事.

## 常见问题

### @benefex/icons 是什么？

受益图标包

### 如何安装 @benefex/icons？

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

### @benefex/icons 支持 TypeScript 吗？

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

### @benefex/icons 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @benefex/icons 可以商用吗？

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

### @benefex/icons 的下载量有多少？

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

### @benefex/icons 还在维护吗？

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