# @govuk-react/error-summary

> Notice used to display form errors to user - also includes anchors to jump to relevant form sections.

Latest version **0.10.7** (published 2024-05-13) · MIT license · 0 weekly downloads

## Install

```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
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.7 |
| Published | 2024-05-13 |
| First published | 2018-06-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 10 |
| Unpacked size | 21.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Tarandeep Singh Chauhan |
| Maintainers | loque-, steve_sims, petelockey, penx, marksy |

## Links

- npm: https://www.npmjs.com/package/@govuk-react/error-summary
- Homepage: https://github.com/govuk-react/govuk-react/tree/main/components/error-summary
- npm.io page: https://npm.io/package/@govuk-react/error-summary

## Dependencies (10)

- [govuk-colours](https://npm.io/package/govuk-colours.md) ^1.1.0
- [@govuk-react/lib](https://npm.io/package/@govuk-react/lib.md) ^0.10.7
- [@govuk-react/link](https://npm.io/package/@govuk-react/link.md) ^0.10.7
- [@govuk-react/heading](https://npm.io/package/@govuk-react/heading.md) ^0.10.7
- [@govuk-react/constants](https://npm.io/package/@govuk-react/constants.md) ^0.10.7
- [@govuk-react/list-item](https://npm.io/package/@govuk-react/list-item.md) ^0.10.7
- [@govuk-react/paragraph](https://npm.io/package/@govuk-react/paragraph.md) ^0.10.7
- [@govuk-react/text-area](https://npm.io/package/@govuk-react/text-area.md) ^0.10.7
- [@govuk-react/input-field](https://npm.io/package/@govuk-react/input-field.md) ^0.10.7
- [@govuk-react/unordered-list](https://npm.io/package/@govuk-react/unordered-list.md) ^0.10.7

## Recent versions

- 0.10.7 (latest) — 2024-05-13
- 0.6.0-rc.1 (next) — 2019-02-28
- 0.10.6 — 2023-10-01
- 0.10.5 — 2022-11-22
- 0.10.4 — 2022-10-08
- 0.10.3 — 2022-08-20
- 0.10.2 — 2022-08-19
- 0.10.1 — 2022-04-08
- 0.10.0 — 2021-10-07
- 0.9.1 — 2021-09-06
- 0.9.0 — 2021-05-30
- 0.8.0 — 2021-05-16
- 0.7.1 — 2019-05-24
- 0.7.0 — 2019-03-15
- 0.6.0 — 2019-03-01
- … 15 more at https://npm.io/package/@govuk-react/error-summary/versions

## README

ErrorSummary
============

### Import
```js
  import ErrorSummary from '@govuk-react/error-summary';
```
<!-- STORY -->

Use this component at the top of a page to summarise any errors a user has made.

- https://govuk-react.github.io/govuk-react/?path=/docs/error-summary
- https://design-system.service.gov.uk/components/error-summary/

### Properties
Prop | Required | Default | Type | Description
:--- | :------- | :------ | :--- | :----------
 `description` |  | ```undefined``` | string | Optional description of the errors
 `errors` |  | ```[]``` | { targetName?: string; text?: string; }[] | Array of errors with text and target element name to scroll into view when clicked
 `heading` |  | ```There is a problem``` | string | Heading text
 `onHandleErrorClick` |  | ```undefined``` | (targetName: string) => void | onClick function to scroll the target element into view

---
_Source: https://npm.io/package/@govuk-react/error-summary · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
