# @aurodesignsystem/auro-toast 中文文档

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

版本：4\.1\.0
npm 元数据更新时间：2026-09-24T21:27:49.401Z
中文译文更新时间：2026-11-07T05:23:47.280Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：634 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2023-07-18T23:04:08.144Z
- 最新版本发布：2026-09-24T21:27:48.942Z
- 近 30 天下载量：4408（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：48（近 12 个月 13 个）

## 中文简介

auro-toast HTML 自定义元素

## 安装

```sh
npm install @aurodesignsystem/auro-toast
```

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

## README

# 土司

这个 `<auro-toast>` 元素为 a [HTML 自定义元素](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) 为了向访客发出无侵扰性的吐司(或推)通知.

这个 `<auro-toaster>` 包装元素是一个 [HTML 自定义元素](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) 在屏幕下方使用 `<auro-toast>` 键.

## 使用大小写

这个 `<auro-toast>` 使用实例包括:

-   发送错误按下通知
-   发送成功的推动通知
-   发送任何类型的推动通知

## 安装

[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-toast/release.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-toast/actions/workflows/release.yml) [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-toast?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-toast) [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-toast?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-toast
```

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

确定每个项目中的依赖性 `<auro-toast>` 组件.

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

### 使用 CDN 软件

在项目无法处理JS资产的情况下,有预处理后的资产可供使用. IE11等后遗症浏览器不再被支持.

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

## 基本示例

```html
<auro-button id="basicToastBtn">
  Show default notification
</auro-button>
<!--
NOTE: The manually added style is NOT necessary for use,
Demo purposes ONLY!
-->
<auro-toast style="display: block; margin: 0.5rem 0;" id="basicToast">
  Default notification with no error type.
</auro-toast>
```

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

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

当您安装您所描述的组件时 `Install` 页面中,该类会自动导入,组件会在全球注册.

然而,如果需要将同一组件的多个版本加载到一页上(例如,当两个工程依赖于不同的版本时),可以手动在自定义元素名下注册类来避免冲突.

您可以仅导入组件类并使用 `register(name)` 唯一名称的方法 :

```js
// Import the class only
import { AuroToast } from '@aurodesignsystem/auro-toast/class';
// Register with a custom name if desired
AuroToast.register('custom-toast');
```

这将创建一个新的自定义元素 `<custom-toast>` 行为就像 `<auro-toast>`,允许两者在同一页上共存,而互不干涉.

显示默认通知 没有出错类型的默认通知 .

见代码

```html
<auro-button id="customToastBtn">
  Show default notification
</auro-button>
<custom-toast style="display: block; margin: 0.5rem 0;" id="customToast">
  Default notification with no error type.
</custom-toast>
```

## 常见问题

### @aurodesignsystem/auro-toast 是什么？

auro-toast HTML 自定义元素

### 如何安装 @aurodesignsystem/auro-toast？

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

### @aurodesignsystem/auro-toast 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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

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

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