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

Standard options

This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the component wrapper helper documentation for more detail.

  • id - accepts a string for the element ID attribute
  • data_attributes - accepts a hash of data attributes
  • aria - accepts a hash of aria attributes
  • classes - accepts a space separated string of classes, these should not be used for styling and must be prefixed with js-
  • margin_bottom - accepts a number from 0 to 9 (0px to 60px) using the GOV.UK Frontend spacing scale (defaults to no margin)
  • role - accepts a space separated string of roles
  • lang - accepts a language attribute value
  • open - accepts an open attribute value (true or false)
  • hidden - accepts an empty string, ‘hidden’, or ‘until-found’
  • tabindex - accepts an integer. The integer can also be passed as a string.
  • dir - accepts ‘rtl’, ‘ltr’, or ‘auto’.

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"
    }
  ]
} %>