Skip to content

ErrorDisplay ​

Overview ​

Displays a dismissible error message card, reports the error to Sentry, and optionally renders a router-link for navigation.

Theme entry: ErrorDisplay

Props ​

NameTypeRequiredDefaultDescription
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
erroredbooleanfalseWhether there is an error to display.
errorobjectnullThe error object to display; supports a single error or an array of errors.
whileTextstring"loading"Phrase inserted into the default message as "There was an error while <whileText>."
ignoreListFilterErrorsbooleanfalseWhen true, ListFilterError instances are silently ignored and not displayed.
ignoreFormValidationErrorsbooleanfalseWhen true, server feedback errors that can be ingested into form state are silently ignored.
ignoreAbortedRequestsbooleantrueWhen true, errors whose message contains "aborted" are silently ignored.
redirectParamsobject|stringnullVue Router location passed to a <router-link> rendered below the error message.
redirectTitlestring"Click here to go back."Link text displayed for the router-link when redirectParams is set.
dismissiblebooleanfalseWhen true, a close button is shown that emits dismiss-error when clicked.

Slots ​

default ​

Scoped slot.

Bindings ​

NameDescription
redirectParams
redirectTitle
whileText
error

Events ​

NameDescription
dismiss-errorEmitted when the user closes the error message card.

Full event reference

Source ​

client/lib/display/error-display/ErrorDisplay.vue