1. Component Guide
  2. Form error summary
Component

Form error summary

Used at the top of the page, to summarise validation errors.

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

Message to alert the user to a problem goes here

Optional description of the errors and how to correct them

How to call this component

<%= render "govuk_publishing_components/components/error_summary", {
  id: "error-summary",
  title: "Message to alert the user to a problem goes here",
  description: "Optional description of the errors and how to correct them",
  items: [
    {
      text: "Descriptive link to the question with an error",
      href: "#example-error-1"
    }
  ]
} %>

Accessibility acceptance criteria

  • should be focused on page load, to ensure this error is noticed by assistive tech
  • list of errors should be clickable and focus the inputs with errors

Links in the component must:

  • accept focus
  • be focusable with a keyboard
  • be usable with a keyboard
  • indicate when they have focus
  • change in appearance when touched (in the touch-down state)
  • change in appearance when hovered
  • be usable with touch
  • be usable with voice commands
  • have visible text
  • have meaningful text

Other examples

With many errors (preview)

Message to alert the user to a problem goes here

Optional description of the errors and how to correct them

<%= render "govuk_publishing_components/components/error_summary", {
  title: "Message to alert the user to a problem goes here",
  description: "Optional description of the errors and how to correct them",
  items: [
    {
      text: "Descriptive link to the question with an error 1",
      href: "#example-error-1"
    },
    {
      text: "Descriptive link to the question with an error 2",
      href: "#example-error-2"
    },
    {
      text: "Description of error without link"
    }
  ]
} %>

With data attributes (preview)

The example shown applies a tracking attribute specifically for use by Google Tag Manager in Content Publisher.

Other data attributes can also be applied as required. Note that the component does not include built in tracking. If this is required consider using the track click script.

Message to alert the user to a problem goes here

Optional description of the errors and how to correct them

  • Descriptive link to the question with an error 1
<%= render "govuk_publishing_components/components/error_summary", {
  title: "Message to alert the user to a problem goes here",
  description: "Optional description of the errors and how to correct them",
  data_attributes: {
    tracking: "GTM-123AB"
  },
  items: [
    {
      text: "Descriptive link to the question with an error 1"
    }
  ]
} %>