Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.92 KB

error-summary.md

File metadata and controls

72 lines (49 loc) · 2.92 KB
Raw

Error summary

GDS Error summary component

Note that by default an Error summary will be added to the top of your form containing links to all the errors on the page. If you do not want this you can selectively disable this behaviour by adding gfa-prepend-error-summary="false" to the form. To disable globally set the PrependErrorSummaryToForms property on GovUkFrontendAspNetCoreOptions to false.

Example

<govuk-error-summary>
    <govuk-error-summary-item href="#passport-issued-day">The date your passport was issued must be in the past</govuk-error-summary-item>
    <govuk-error-summary-item href="#postcode-input">Enter a postcode, like AA1 1AA</govuk-error-summary-item>
</govuk-error-summary>

Error message

Example - overriden title

<govuk-error-summary>
    <govuk-error-summary-title>There is a problem</govuk-error-summary-title>
    <govuk-error-summary-item href="#passport-issued-day">The date your passport was issued must be in the past</govuk-error-summary-item>
    <govuk-error-summary-item href="#postcode-input">Enter a postcode, like AA1 1AA</govuk-error-summary-item>
</govuk-error-summary>

Error message

Example - ModelState error

<govuk-error-summary>
    <govuk-error-summary-item asp-for="FullName" />
</govuk-error-summary>

Error message

API

<govuk-error-summary>

Attribute Type Description
disable-auto-focus bool Whether to disable the behavior that focuses the error summary when the page loads. The default is false.

<govuk-error-summary-title>

The content is the HTML to use within the title for the error summary. If this element is not specified then the content is There is a problem.
Must be inside a <govuk-error-summary> element.

<govuk-error-summary-description>

The content is the HTML to use within the description for the error summary.
Must be inside a <govuk-error-summary> element.

<govuk-error-summary-item>

The content is the HTML to use within the error link item. Content is required if the asp-for attribute is not specified.\

If asp-for is specified and there are no errors in ModelState then the item will not be rendered.

Must be inside a <govuk-error-summary> element.

Attribute Type Description
asp-for ModelExpression The model expression used to generate the error message. If content is specified this attribute is ignored. See documentation on forms for more information.
link-* Additional attributes to add to the generated a element.
(link attributes) If specified generates an href attribute using the specified values. See documentation on links for more information.