# @govuk-react/error-summary 中文文档

规范地址：https://npmcn.com/package/%40govuk-react/error-summary/

版本：0\.10\.7
npm 元数据更新时间：2024-05-13T14:19:00.610Z
中文译文更新时间：2026-11-16T21:18:39.663Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40govuk-react/error-summary
原文对照：https://npmcn.com/package/%40govuk-react/error-summary/?lang=original
项目主页：https://github.com/govuk-react/govuk-react/tree/main/components/error-summary

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

- 包体积（解压后）：21.8 kB，11 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：10 个
- peer 依赖：react \>=16\.8\.0，styled-components \>=5\.1
- 首次发布：2018-06-14T13:00:55.034Z
- 最新版本发布：2024-05-13T14:19:00.381Z
- 近 30 天下载量：10583（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 0 个）

## 中文简介

用于向用户显示窗体错误的通知 - 还包括要跳转到相关窗体段落的锚.

## 安装

```sh
npm install @govuk-react/error-summary
```

也可以使用：`pnpm add @govuk-react/error-summary`、`yarn add @govuk-react/error-summary`、`bun add @govuk-react/error-summary`

## README

# 错误摘要

### 导入

```js
  import ErrorSummary from '@govuk-react/error-summary';
```

使用页面上方的此组件来总结用户所犯的任何错误 .

-   https://govuk-react.github.io/govuk-react/?path=/docs/error-summary 互联网档案馆的存檔,存档日期2014-12-22
-   [https://design-system.service.gov.uk/ 组件/error-summary/ 互联网档案馆的存檔,存档日期2014-12-21](https://design-system.service.gov.uk/components/error-summary/)

### 属性

| Prop | 需求 | 默认 | 类型 | 说明 |
| :-- | :-- | :-- | :-- | :-- |
| `description` |  | `undefined` | 字符串 | 错误的可选描述 |
| `errors` |  | `[]` | {目标名? : 字符串; 文本? : 字符串;} \[\] | 单击时要滚动到视图的文本和目标元素名称的错误串列 |
| `heading` |  | `There is a problem` | 字符串 | 标题文本 |
| `onHandleErrorClick` |  | `undefined` | (目标名:字符串)% 1 无效 | 将目标元素滚动到视图中 |

## 常见问题

### @govuk-react/error-summary 是什么？

用于向用户显示窗体错误的通知 - 还包括要跳转到相关窗体段落的锚\.

### 如何安装 @govuk-react/error-summary？

在项目目录运行 npm install @govuk-react/error-summary，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.0）、styled-components（\>=5\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @govuk-react/error-summary 支持 TypeScript 吗？

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

### @govuk-react/error-summary 支持 ESM 还是 CommonJS？

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

### @govuk-react/error-summary 可以商用吗？

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

### @govuk-react/error-summary 的下载量有多少？

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

### @govuk-react/error-summary 还在维护吗？

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

