# @aurodesignsystem-dev/auro-icon 中文文档

规范地址：https://npmcn.com/package/%40aurodesignsystem-dev/auro-icon/

版本：0\.0\.0-pr287\.18
npm 元数据更新时间：2026-11-03T19:37:17.032Z
中文译文更新时间：2026-11-07T05:23:47.316Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40aurodesignsystem-dev/auro-icon
原文对照：https://npmcn.com/package/%40aurodesignsystem-dev/auro-icon/?lang=original
项目主页：https://github.com/AlaskaAirlines/auro-icon#readme
源码仓库：https://github.com/AlaskaAirlines/auro-icon

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

- 包体积（解压后）：400 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2025-09-26T18:06:25.112Z
- 最新版本发布：2026-11-03T19:37:16.729Z
- 近 30 天下载量：4201（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 86 个）

## 中文简介

auro- icon HTML 自定义元素

## 安装

```sh
npm install @aurodesignsystem-dev/auro-icon
```

也可以使用：`pnpm add @aurodesignsystem-dev/auro-icon`、`yarn add @aurodesignsystem-dev/auro-icon`、`bun add @aurodesignsystem-dev/auro-icon`

## README

# 图标

图标代表概念,并在选项和行动上加入上下文.

这个 `<auro-icon>` 元素可以显示 [Auro 图标库](https://auro.alaskaair.com/icons)设置图标 `category` 财务报告和审定财务报表 `name`。 。 。 .

## 使用大小写

使用 `<auro-icon>` 当人们:

-   从添加附近文本上下文的图标中受益
-   需要快速识别其图标的动作或选项
-   在视觉提示上寻找绕过界面的路

## 安装

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-icon/release.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-icon/actions/workflows/release.yml) [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-icon?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-icon) [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-icon?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0) ![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)

```shell
$ npm i @aurodesignsystem/auro-icon
```

### 定义项目中的依赖性

导入每个项目中使用的组件 `<auro-icon>`。 。 。 .

```js
import "@aurodesignsystem/auro-icon";
```

### 使用 CDN 软件

如果你的项目不能处理JS资产,使用预先处理的资产. IE11等后遗症浏览器不支持.

```html
<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-icon@latest/+esm"></script>
```

## 基本实例

```html
<auro-icon category="interface" name="pin-trip-filled">Your trip starts here</auro-icon>
```

## 自定义版本管理组件注册

每个Auro组件有两个关键部分: [类](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes) 和自定义元素定义. 类定义了组件的行为,而自定义元素则以特定的名称注册,以便用于HTML.

安装安装部分中描述的组件, 导入此类, 并为您在全球注册该组件 .

然而,如果需要在同一页上加载多个版本的同构件(例如两个项目依赖于不同的版本),则在自定义元素名下手动注册该类以避免冲突.

要做到这一点,只需导入组件类并调用 `register(name)` 唯一名称的方法 :

```js
// Import the class only
import { AuroIcon } from '@aurodesignsystem/auro-icon/class';

// Register with a custom name if desired
AuroIcon.register('custom-icon');
```

这创造了一个 `<custom-icon>` 与 `<auro-icon>` 并且不会与同一页的内容相冲突.

你的旅行从这里开始

见代码

```html
<custom-icon category="interface" name="pin-trip-filled">Your trip starts here</custom-icon>
```

## 常见问题

### @aurodesignsystem-dev/auro-icon 是什么？

auro- icon HTML 自定义元素

### 如何安装 @aurodesignsystem-dev/auro-icon？

在项目目录运行 npm install @aurodesignsystem-dev/auro-icon，或使用 pnpm add / yarn add / bun add。

### @aurodesignsystem-dev/auro-icon 支持 TypeScript 吗？

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

### @aurodesignsystem-dev/auro-icon 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @aurodesignsystem-dev/auro-icon 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @aurodesignsystem-dev/auro-icon 可以商用吗？

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

### @aurodesignsystem-dev/auro-icon 的下载量有多少？

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

### @aurodesignsystem-dev/auro-icon 还在维护吗？

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

