# @hcl-software/enchanted-icons 中文文档

规范地址：https://npmcn.com/package/%40hcl-software/enchanted-icons/

版本：2\.1\.0
npm 元数据更新时间：2026-11-10T16:31:25.532Z
中文译文更新时间：2026-11-17T18:04:54.362Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.5 MB，3836 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^19\.2\.7，react-dom ^19\.2\.7，@mui/material ^7\.3\.11
- 首次发布：2024-04-19T12:59:30.872Z
- 最新版本发布：2026-11-10T16:31:25.145Z
- 近 30 天下载量：4996（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 6 个）

## 中文简介

被魔法图标是HCL Software产品中使用的图标的集合.

## 安装

```sh
npm install @hcl-software/enchanted-icons
```

也可以使用：`pnpm add @hcl-software/enchanted-icons`、`yarn add @hcl-software/enchanted-icons`、`bun add @hcl-software/enchanted-icons`

## README

# HCL 软件智能图标包

被魔法图标是HCL Software产品中使用的图标的集合. 此软件包既暴露了外部图标,也暴露了自创 [碳反应图标包](https://github.com/carbon-design-system/carbon/tree/main/packages/icons) 并暴露那些随时可以使用材料UI组件的人.

(C) 2024 HCL美国公司Apache-2.0许可证 [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)

[![npm](https://nodei.co/npm/@hcl-software/enchanted-icons.png)](https://www.npmjs.com/package/@hcl-software/enchanted-icons)

## \* 安装

```sh
npm install @hcl-software/enchanted-icons
```

## 使用量

在大多数情况下,"魔法组件"使用正确的图标来遵守"魔法设计"语言;然而,可能存在使用的合理理由 图标. **直接使用此库的图标时, 总是与您的 UX 联系人协商 .**

### 实例

#### 图标大小

```jsx
import CheckmarkIcon from '@hcl-software/enchanted-icons/dist/carbon/es/checkmark';
...
<CheckmarkIcon fontSize="small" />
```

或者说

```jsx
import CheckmarkIcon from '@hcl-software/enchanted-icons/dist/carbon/es/checkmark';
...
<CheckmarkIcon fontSize="16px" />
```

#### 图标颜色

```jsx
import CheckmarkIcon from '@hcl-software/enchanted-icons/dist/carbon/es/checkmark';
...
<CheckmarkIcon color="success" />
```

说明: 强烈建议使用"魔法"主题颜色的主题名称,而不是明确的rgba值. 譬如说, `"success"` 或者说 `"action"`。这确保了整个UI和一段时间内颜色的一致性.

#### 图标按钮

一个常见的规律是将图标与被选中的图标结合使用 `<IconButton>`

```jsx
import IconButton from '@hcl-software/enchanted-react-components/dist/IconButton';
import RocketIcon from '@hcl-software/enchanted-icons/dist/carbon/es/rocket';
...
<IconButton size="small" aria-label="launch"><RocketIcon /></IconButton>
```

说明: 在这种情况下,图标的大小由 `size` 页:1 `<IconButton>`。图标颜色由不同的按钮状态(活动状态、禁用状态等)控制,不应被覆盖.

### 高级

此库的图标可以取取 MUI 支持的任何道具 `<SvgIcon>` 组件。 见 [https://v5.mui.com/material-ui/api/svg-icon/ 页面存档备份,存于互联网档案馆](https://v5.mui.com/material-ui/api/svg-icon/)  
**在应用任何高级样式之前, 总是咨询您的 UX 联系人 .**

## 常见问题

### @hcl-software/enchanted-icons 是什么？

被魔法图标是HCL Software产品中使用的图标的集合\.

### 如何安装 @hcl-software/enchanted-icons？

在项目目录运行 npm install @hcl-software/enchanted-icons，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.2\.7）、react-dom（^19\.2\.7）、@mui/material（^7\.3\.11）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @hcl-software/enchanted-icons 支持 TypeScript 吗？

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

### @hcl-software/enchanted-icons 支持 ESM 还是 CommonJS？

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

### @hcl-software/enchanted-icons 可以商用吗？

@hcl-software/enchanted-icons 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @hcl-software/enchanted-icons 的下载量有多少？

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

### @hcl-software/enchanted-icons 还在维护吗？

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

