4.76.0

Error Page

An error page

Demo

Customizable example

Omit status and supply the summary, description, steps, and illustration.

Responsive Demo Pages

Standard Width 401 403 404 500 Sign in Customer 404
Side Nav

narrowwidth is deprecated and ignored. Narrow layouts come from the card's container query.

API

Tag

Name Description
<aui-error-page>

Custom Element to show a full-page error dialog with summary, details, and steps to take.

Slots

Name Required Description
steps

Alternative steps

actions

buttons or anchors placed between the steps and the help sentence. They stay in a row and wrap when they overflow the card.

help

Optional help sentence after the action buttons. Standardized statuses fill this except 404 and sign-in, which include that sentence in their own copy.

Attributes

Name Value Required Description
status 401 | 403 | 404 | 500 | sign-in | 404-customer

If set, the predefined error page for the status code is displayed. If not set, a custom error page is displayed.

correlationid string

Correlation-id usually in the form of aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

summary string

Sets the summary text of a custom error page.

description string

Sets the description text of a custom error page.

imagename enum: science-round | objects-01 | objects-08 | objects-17 | humans-30 | humans-31 | objects-02

Selects the illustration for an error page, overriding the default illustration when status is set. The legacy humans-30 and humans-31 illustrations remain supported for compatibility but should be replaced with a current illustration.

background boolean

When true (the default), the page behind the card uses --color-surface-muted. When false, that color is not applied and the background inherits from the page.

i18n string

A stringified JSON object which defines a list of localized strings. The keys must be one of the string IDs defined below.

Properties

Name Value Required Description
status 401 | 403 | 404 | 500 | sign-in | 404-customer

If set, the predefined error page for the status code is displayed. If not set, a custom error page is displayed.

correlationId string

Correlation-id usually in the form of aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

summary string

Sets the summary text of a custom error page.

description string

Sets the description text of a custom error page.

imageName enum: science-round | objects-01 | objects-08 | objects-17 | humans-30 | humans-31 | objects-02

Selects the illustration for an error page, overriding the default illustration when status is set. The legacy humans-30 and humans-31 illustrations remain supported for compatibility but should be replaced with a current illustration.

background boolean

When true (the default), the page behind the card uses --color-surface-muted. When false, that color is not applied and the background inherits from the page.

i18n object

A JSON object which defines a list of localized strings. The keys must be one of the string IDs defined below.

Demo

API

Tag

Name Description
<AuiErrorPage>

Custom Element to show a full-page error dialog with summary, details, and steps to take.

Slots

Name Required Description
steps

Alternative steps

actions

buttons or anchors placed between the steps and the help sentence. They stay in a row and wrap when they overflow the card.

help

Optional help sentence after the action buttons. Standardized statuses fill this except 404 and sign-in, which include that sentence in their own copy.

Props

Name Value Required Description
status 401 | 403 | 404 | 500 | sign-in | 404-customer

If set, the predefined error page for the status code is displayed. If not set, a custom error page is displayed.

correlationid string

Correlation-id usually in the form of aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

summary string

Sets the summary text of a custom error page.

description string

Sets the description text of a custom error page.

imagename enum: science-round | objects-01 | objects-08 | objects-17 | humans-30 | humans-31 | objects-02

Selects the illustration for an error page, overriding the default illustration when status is set. The legacy humans-30 and humans-31 illustrations remain supported for compatibility but should be replaced with a current illustration.

background boolean

When true (the default), the page behind the card uses --color-surface-muted. When false, that color is not applied and the background inherits from the page.

i18n object

A JSON object which defines a list of localized strings. The keys must be one of the string IDs defined below.

Skylab React links

General information about using our React package

Guidelines

Design

Design resources can be found on the Skylab design documentation site: skylab.avalara.com