Components

Error message

Follow the validation pattern and show an error message when there is a validation error. In the error message explain what went wrong and how to fix it.

FIXME

Error: The date your passport was issued must be in the past

FIXME
<p class="govuk-error-message">
  <span class="govuk-visually-hidden">Error:</span>
  The date your passport was issued must be in the
  past
</p>
<ErrorMessage>
  The date your passport was issued must be in the
  past
</ErrorMessage>
Props
NameTypeDefaultDescription
idother'id' attribute to place on the base HTML element
classBlockotherBlock name override in BEM style classes applied to all elements
classModifiersotherBEM style modifiers to apply to the base HTML element
classNameotherExtra classes to apply to the base HTML element
defaultCheckedother
defaultValueother
suppressContentEditableWarningother
suppressHydrationWarningother
accessKeyother
autoCapitalizeother
autoFocusother
contentEditableother
contextMenuother
dirother
draggableother
enterKeyHintother
hiddenother
langother
nonceother
slotother
spellCheckother
styleother
tabIndexother
titleother
translateother
radioGroupother
roleother
aboutother
contentother
datatypeother
inlistother
prefixother
propertyother
relother
resourceother
revother
typeofother
vocabother
autoCorrectother
autoSaveother
colorother
itemPropother
itemScopeother
itemTypeother
itemIDother
itemRefother
resultsother
securityother
unselectableother
inputModeotherHints at the type of data that might be entered by the user while editing the element or its contents
isotherSpecify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendantotherIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomicotherIndicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocompleteotherIndicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabelotherDefines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescriptionotherDefines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busyother
aria-checkedotherIndicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcountotherDefines the total number of columns in a table, grid, or treegrid.
aria-colindexotherDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextextotherDefines a human readable text alternative of aria-colindex.
aria-colspanotherDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controlsotherIdentifies the element (or elements) whose contents or presence are controlled by the current element.
aria-currentotherIndicates the element that represents the current item within a container or set of related elements.
aria-describedbyotherIdentifies the element (or elements) that describes the object.
aria-descriptionotherDefines a string value that describes or annotates the current element.
aria-detailsotherIdentifies the element that provides a detailed, extended description for the object.
aria-disabledotherIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffectotherIndicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessageotherIdentifies the element that provides an error message for the object.
aria-expandedotherIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowtootherIdentifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbedotherIndicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopupotherIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hiddenotherIndicates whether the element is exposed to an accessibility API.
aria-invalidotherIndicates the entered value does not conform to the format expected by the application.
aria-keyshortcutsotherIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-labelotherDefines a string value that labels the current element.
aria-labelledbyotherIdentifies the element (or elements) that labels the current element.
aria-levelotherDefines the hierarchical level of an element within a structure.
aria-liveotherIndicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modalotherIndicates whether an element is modal when displayed.
aria-multilineotherIndicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectableotherIndicates that the user may select more than one item from the current selectable descendants.
aria-orientationotherIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-ownsotherIdentifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholderotherDefines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinsetotherDefines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressedotherIndicates the current "pressed" state of toggle buttons.
aria-readonlyotherIndicates that the element is not editable, but is otherwise operable.
aria-relevantotherIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-requiredotherIndicates that user input is required on the element before a form may be submitted.
aria-roledescriptionotherDefines a human-readable, author-localized description for the role of an element.
aria-rowcountotherDefines the total number of rows in a table, grid, or treegrid.
aria-rowindexotherDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextextotherDefines a human readable text alternative of aria-rowindex.
aria-rowspanotherDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selectedotherIndicates the current "selected" state of various widgets.
aria-setsizeotherDefines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sortotherIndicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemaxotherDefines the maximum allowed value for a range widget.
aria-valueminotherDefines the minimum allowed value for a range widget.
aria-valuenowotherDefines the current value for a range widget.
aria-valuetextotherDefines the human readable text alternative of aria-valuenow for a range widget.
dangerouslySetInnerHTMLother
onCopyother
onCopyCaptureother
onCutother
onCutCaptureother
onPasteother
onPasteCaptureother
onCompositionEndother
onCompositionEndCaptureother
onCompositionStartother
onCompositionStartCaptureother
onCompositionUpdateother
onCompositionUpdateCaptureother
onFocusother
onFocusCaptureother
onBlurother
onBlurCaptureother
onChangeother
onChangeCaptureother
onBeforeInputother
onBeforeInputCaptureother
onInputother
onInputCaptureother
onResetother
onResetCaptureother
onSubmitother
onSubmitCaptureother
onInvalidother
onInvalidCaptureother
onLoadother
onLoadCaptureother
onErrorother
onErrorCaptureother
onKeyDownother
onKeyDownCaptureother
onKeyPressother
onKeyPressCaptureother
onKeyUpother
onKeyUpCaptureother
onAbortother
onAbortCaptureother
onCanPlayother
onCanPlayCaptureother
onCanPlayThroughother
onCanPlayThroughCaptureother
onDurationChangeother
onDurationChangeCaptureother
onEmptiedother
onEmptiedCaptureother
onEncryptedother
onEncryptedCaptureother
onEndedother
onEndedCaptureother
onLoadedDataother
onLoadedDataCaptureother
onLoadedMetadataother
onLoadedMetadataCaptureother
onLoadStartother
onLoadStartCaptureother
onPauseother
onPauseCaptureother
onPlayother
onPlayCaptureother
onPlayingother
onPlayingCaptureother
onProgressother
onProgressCaptureother
onRateChangeother
onRateChangeCaptureother
onResizeother
onResizeCaptureother
onSeekedother
onSeekedCaptureother
onSeekingother
onSeekingCaptureother
onStalledother
onStalledCaptureother
onSuspendother
onSuspendCaptureother
onTimeUpdateother
onTimeUpdateCaptureother
onVolumeChangeother
onVolumeChangeCaptureother
onWaitingother
onWaitingCaptureother
onAuxClickother
onAuxClickCaptureother
onClickother
onClickCaptureother
onContextMenuother
onContextMenuCaptureother
onDoubleClickother
onDoubleClickCaptureother
onDragother
onDragCaptureother
onDragEndother
onDragEndCaptureother
onDragEnterother
onDragEnterCaptureother
onDragExitother
onDragExitCaptureother
onDragLeaveother
onDragLeaveCaptureother
onDragOverother
onDragOverCaptureother
onDragStartother
onDragStartCaptureother
onDropother
onDropCaptureother
onMouseDownother
onMouseDownCaptureother
onMouseEnterother
onMouseLeaveother
onMouseMoveother
onMouseMoveCaptureother
onMouseOutother
onMouseOutCaptureother
onMouseOverother
onMouseOverCaptureother
onMouseUpother
onMouseUpCaptureother
onSelectother
onSelectCaptureother
onTouchCancelother
onTouchCancelCaptureother
onTouchEndother
onTouchEndCaptureother
onTouchMoveother
onTouchMoveCaptureother
onTouchStartother
onTouchStartCaptureother
onPointerDownother
onPointerDownCaptureother
onPointerMoveother
onPointerMoveCaptureother
onPointerUpother
onPointerUpCaptureother
onPointerCancelother
onPointerCancelCaptureother
onPointerEnterother
onPointerLeaveother
onPointerOverother
onPointerOverCaptureother
onPointerOutother
onPointerOutCaptureother
onGotPointerCaptureother
onGotPointerCaptureCaptureother
onLostPointerCaptureother
onLostPointerCaptureCaptureother
onScrollother
onScrollCaptureother
onWheelother
onWheelCaptureother
onAnimationStartother
onAnimationStartCaptureother
onAnimationEndother
onAnimationEndCaptureother
onAnimationIterationother
onAnimationIterationCaptureother
onTransitionEndother
onTransitionEndCaptureother

When to use this component

Show an error message next to the field and in the error summary when there is a validation error.

Use standard messages for different components.

When not to use this component

Do not use error messages to tell a user that they are not eligible or do not have permission to do something. Or to tell them about a lack of capacity or other problem the user cannot fix - because the problem is with the service rather than with the information the user has provided.

Instead, take the user to a page that explains the problem (for example, telling them why they’re not eligible) and provides useful information about what to do next.

There are separate patterns for:

How it works

For each error:

  • put the message in red after the question text and hint text
  • use a red border to visually connect the message and the question it belongs to
  • if the error relates to a specific field within the question, give it a red border and refer to that field in the error message - for example: “you must enter a year”

To help screen reader users, the error message component includes a hidden ‘Error:’ before the error message. These users will hear, for example, “Error: The date your passport was issued must be in the past”.

If your error message is written in another language, you can change the prefix as needed, as shown in this example.

Error: The date your passport was issued must be in the past

<p class="govuk-error-message">
  <span class="govuk-visually-hidden">Error:</span>
  The date your passport was issued must be in the
  past
</p>
<ErrorMessage>
  The date your passport was issued must be in the
  past
</ErrorMessage>

Summarise all errors at the top of the page the user is on using an error summary.

Legend

FIXME

Error: Select if you are British, Irish or a citizen of a different country

FIXME
<p class="govuk-error-message">
  <span class="govuk-visually-hidden">Error:</span>
  Select if you are British, Irish or a citizen of a
  different country
</p>
<ErrorMessage>
  Select if you are British, Irish or a citizen of a
  different country
</ErrorMessage>

Label

FIXME

Error: Enter a National Insurance number in the correct format

FIXME
<p class="govuk-error-message">
  <span class="govuk-visually-hidden">Error:</span>
  Enter a National Insurance number in the correct
  format
</p>
<ErrorMessage>
  Enter a National Insurance number in the correct
  format
</ErrorMessage>

Be clear and concise

Describe what has happened and tell them how to fix it. The message must be in plain English, use positive language and get to the point.

Do not use:

  • technical jargon like ‘form post error’, ‘unspecified error’ and ‘error 0x0000000643’
  • words like ‘forbidden’, ‘illegal’, ‘you forgot’ and ‘prohibited’
  • ‘please’ because it implies a choice
  • ‘sorry’ because it does not help fix the problem
  • ‘valid’ and ‘invalid’ because they do not add anything to the message
  • humourous, informal language like ‘oops’

Do not give an example in the error message if there is an example on the screen. For example, if you are asking for a National Insurance number and include ‘QQ 12 34 56 C’ as hint text, do not include an example in the error message.

Above all, aim for clarity.

Read the message out loud to see if it sounds like something you would say.

Be consistent

Use the same message next to the field and in the error summary so they:

  • look, sound and mean the same
  • make sense out of context
  • reduce the cognitive effort needed to understand what has happened

Use the question or form label in the error to provide context. For example, ‘Enter how many hours you work a week’ for ‘How many hours do you work a week?’

Be specific

General errors are not helpful to everyone. They do not make sense out of context. Avoid messages like:

  • ‘An error occurred’
  • ‘Answer the question’
  • ‘Select an option’
  • ‘Fill in the field’
  • ‘This field is required’

Different errors need different messages. For example, text fields may be:

  • empty
  • too long
  • too short
  • using characters that are not allowed
  • in the wrong format

An error for a specific situation is more helpful. It will tell someone what has happened and how to fix it.

Use instructions and descriptions

Some errors work better as instructions and some work better as descriptions. For example:

  • ‘Enter your first name’ is clearer, more direct and natural than ‘First name must have an entry’
  • ‘Enter a first name that is 35 characters or fewer’ is wordier, less direct and natural than ‘First name must be 35 characters or fewer’
  • ‘Enter a date after 31 August 2017 for when you started the course’ is wordier, less direct and natural than ‘Date you started the course must be after 31 August 2017’

Use both instructions and descriptions, but use them consistently. For example, use an instruction for empty fields like ‘Enter your name’, but a description like ‘Name must be 35 characters or fewer’ for entries that are too long.

Use error message templates

Use template messages for common errors on:

Track errors

Find out how often people see them. This will let you:

  • improve content
  • A/B test variations
  • redesign a journey

Research on this component

Error messages designed using this guidance have been tested with all types of users in live services, including tax credits.

Research showed users:

  • understood what went wrong
  • knew how to fix the problem
  • were able to recover from the error