The error state component repurposes the EmptyState
component to display an error to users. To further customize this component, you can also utilize all properties of the empty state component, with the exception
of children
.
Examples
Basic error state
To provide users with error details, a basic error state should contain an appropriate and informative errorTitle
and errorDescription
.
Sample error title
Sample error description
Props
ErrorState
Name | Type | Default | Description |
---|---|---|---|
customFooter | React.ReactNode | Custom footer content | |
defaultErrorDescription | React.ReactNode | A default description of the error used if no errorDescription is provided. | |
errorDescription | React.ReactNode | A description of the error, if no description is provided then it will be set to the defaultErrorDescription. | |
errorTitle | string | 'Something went wrong' | Title of the error. |
ouiaId | string | number | "ErrorState" | ErrorState OUIA ID |
View source on GitHub