# @gemeente-denhaag/alert 中文文档

规范地址：https://npmcn.com/package/%40gemeente-denhaag/alert/

版本：4\.1\.5
npm 元数据更新时间：2026-11-09T14:42:57.568Z
中文译文更新时间：2026-11-16T02:34:02.351Z
软件包许可：EUPL-1\.2

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

原始 npm 页面：https://www.npmjs.com/package/%40gemeente-denhaag/alert
原文对照：https://npmcn.com/package/%40gemeente-denhaag/alert/?lang=original
源码仓库：https://github.com/nl-design-system/denhaag

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

- 包体积（解压后）：47.6 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：react 18 \|\| 19，react-dom 18 \|\| 19
- 首次发布：2021-09-22T07:42:00.302Z
- 最新版本发布：2026-11-09T14:42:57.115Z
- 近 30 天下载量：4074（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：425（近 12 个月 12 个）

## 中文简介

警报组件

## 安装

```sh
npm install @gemeente-denhaag/alert
```

也可以使用：`pnpm add @gemeente-denhaag/alert`、`yarn add @gemeente-denhaag/alert`、`bun add @gemeente-denhaag/alert`

## README

# 警报

[![npm version](https://img.shields.io/npm/v/@gemeente-denhaag/alert.svg)](https://www.npmjs.com/package/@gemeente-denhaag/alert) ![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/nl-design-system/denhaag/Build%20and%20deploy%20Storybook%20to%20Azure%20Web%20App/main?logo=github&style=flat-square)

警示是向用户提供信息的信息. 警报放在其适用的页面或部分的上方,并在页面或部分标题下方.

## 何时使用

使用通知告知用户系统状态的重要变化,持续情况,更新或变化. 如果您需要突出通信, 请使用此组件 。 与用户沟通和立即提供反馈对于建立信任十分重要。 虽然通知是同用户沟通的有效方法,但通知具有破坏性,应尽量少用.

## 替代品和相关构成部分

-   使用亮点通知用户重要和临时的更新
-   使用卡片组合界面中的类似概念

[导航到卡](https://npmcn.com/package/%40gemeente-denhaag/?path=/docs/components-cards-card--case)

## 解剖学

警报包括:

1.  支持图标:一目了然地告知用户提示类型.
2.  标题:给用户一个快速的提醒概览.
3.  关闭图标( 可选) : 关闭提醒 .
4.  文本:提供用户可以采取的更多细节和可操作的步骤.
5.  按钮(可选):允许用户执行与通知相关的动作的按钮,或导航到更多细节的页面.
6.  集装箱

## 设计属性

**类型**

-   标题:桑斯人/lg/400
-   文本:桑斯语/md/400

**颜色** 有4个变种.

-   错误:支持图标Red/3,标题Red/5,关闭图标Red/5,文本Red/5,按钮Red/3,容器Red/1
-   信息:支持图标 Blue/3,标题 Blue/5,关闭图标 Blue/5,文本 Blue/5,按钮 Blue/3,容器 Blue/5
-   成功:支持图标Green/3,标题Green/5,关闭图标Green/5,文本Green/5,按钮Green/3,集装箱Green/1
-   警告:支持图标Orange/3,标题Orange/5,紧接图标Orange/5,文字Orange/5,按钮Orange/3,容器Orange/1

**按钮** 以下按钮被使用: 介质,主语,只用文本.

**结构**

-   支持图标:高度和宽度 24px, 贴上和贴上右 24px, 边距左 24px
-   标题:边框-上部 24px
-   关闭图标:高度和宽度 24px, 贴地-左 24px, 边右 24px
-   文字: 从下到下 16px
-   按钮: 边距下方 24px

## 无障碍

-   警示使用图标和颜色的组合来显示其意义和重要性.
-   \[技术无障碍要求\]

**表单中的错误提醒**

_错误提醒_ 如果用户提交长或复杂有出错的表格,使用出错提示来总结出错. 将提示放在表单上方,提交表单时将焦点移动到横幅上. 这将使所有用户能够按逻辑顺序从表格中滚动,解决问题.

_内入错误_ 总是包含特定窗体字段的内置出错消息,这样用户在纠正出错的同时知道上下文中该做什么.

## 内容准则

**标题** 标题应遵循标题和分标题的内容准则.

**文本** 案文应:

• 简洁:尽可能将内容限制为一至两句 • 澄清主要任务的益处 • 以大写和小写字母写出,并包含适当的通点 • 不重复标题 • 解释如何解决问题,特别是警告和错误标语

**按钮** 按钮应该:

• 明确和可预测:用户应能够预期点击按钮后会发生什么. • 由行动驱动:按钮应始终以强有力的动词来起带头作用,鼓励采取行动。 要给用户提供足够的上下文,您可以在按钮上使用{动词}+{名词}格式,但一般动作如Save, Close, Cancel或OK等除外. • 可扫描:避免不必要的词如"the","a"或"an"等.

## 最佳做法

### 说吧

警报应:

-   放在正确的上下文中:
    -   与整个页面有关的警报应放在该页的顶端,页头下方。 它们应占据内容区的全宽.
    -   与页面某一部分(如地图、弹出式或模式)有关的警报应放在该部分的一节标题下。 这些横幅的相距较小,设计简单以适应内容上下文.
    -   与比一节更具体的内容有关的警报应直接放在该内容上下.
-   专注于一个主题、信息片或需要采取的行动.
-   除非载有关键信息或是用户需要采取的一个重要步骤,否则可予受理.
-   简洁而可扫描:用户不应该花太多时间去想出要知道和做什么.
-   仅限于几项主要行动呼吁,但主要行动不超过一项.
-   谨慎和节制地只用于最重要的信息.
-   使用默认图标获取成功、信息、警告和出错状态.

### 别

警报应:

-   不作为用户定期需要的信息或行动的主要取用点.
-   别粘了.
-   页面上最多不超过2个横幅.
-   不涵盖其他内容.
-   不包含也可以显示为按钮的链接 .

## 图案

**通知状态** 通知状态有助于传递信息。 这些状态与颜色和图标对应,为用户提供一致的,通用的经验.

**使用量**

-   出错:将出错或关键故障通知用户,并可选地阻止用户在问题解决之前继续
-   信息:向用户提供与其当前行动或任务无关的额外信息
-   成功:确认一项任务如预期的那样完成
-   警告:通知用户,他们正在采取不可取或可能有意外结果的行动

## 常见问题

### @gemeente-denhaag/alert 是什么？

警报组件

### 如何安装 @gemeente-denhaag/alert？

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

### @gemeente-denhaag/alert 支持 TypeScript 吗？

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

### @gemeente-denhaag/alert 支持 ESM 还是 CommonJS？

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

### @gemeente-denhaag/alert 可以商用吗？

@gemeente-denhaag/alert 使用 EUPL-1\.2 许可。声明的许可为 EUPL-1\.2，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @gemeente-denhaag/alert 的下载量有多少？

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

### @gemeente-denhaag/alert 还在维护吗？

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

