Alert

PatternFly supports several alert variants for different scenarios. Each variant has an associated status icon, background, and alert title coded to communicate the severity of an alert. Use the variant property to apply the following styling options. If no variant is specified, then the variant will be set to "custom".

PatternFly supports several properties and variations that can be used to add extra content to an alert.

• As demonstrated in the 1st variation below, use the actionLinks property to add one or more <AlertActionLink> components that place links beneath the alert message. You must pass in href and component="a" properties to have an <AlertActionLink> act as a proper link, rather than as a button.

• As demonstrated in the 2nd variation below, use a native HTML <a> element to add links within an alert message.

• As demonstrated in the 3rd variation below, use the actionClose property to add an <AlertActionCloseButton> component, which can be used to manage and customize alert dismissals.

• As demonstrated in the 4th and 5th variations below, use the component property to set the element for an alert title.

  • If there is not a description passed via children prop, then the component prop should be set to a non-heading element such as a span or div.
  • If there is a description passed via children prop, then the component prop should be a heading element. Headings should be ordered by their level and heading levels should not be skipped. For example, a heading of an h2 level should not be followed directly by an h4.

Use the timeout property to automatically dismiss an alert after a period of time. If set to true, the timeout will be 8000 milliseconds. Provide a specific value to dismiss the alert after a different number of milliseconds.

An alert can contain additional, hidden information that is made visible when users click a caret icon. This information can be expanded and collapsed each time the icon is clicked.

It is not recommended to use an expandable alert with a timeout in a toast alert group because the alert could timeout before users have time to interact with and view the entire alert.

See the toast alert considerations section of the alert accessibility documentation to understand the accessibility risks associated with using toast alerts.

Use the truncateTitle property to shorten a long title. Set truncateTitle equal to a number (passed in as {n}) to reduce the number of lines of text in the alert's title. Users may hover over or tab to a truncated title to see the full message in a tooltip.

Use the customIcon property to replace a default alert icon with a custom icon.

Use inline alerts to display an alert inline with content. All alert variants may use the isInline property to position alerts in content-heavy areas, such as within forms, wizards, or drawers.

All general alert variations can use the isInline property to apply inline styling.

Use the isPlain property to make any inline alert plain. Plain styling removes the colored background but keeps colored text and icons.

It is not recommended to use a plain inline alert with actionClose nor actionLinks because these alerts are non-dismissible and should persist until the error or action related to the alert is resolved.

Live region alerts allow you to expose dynamic content changes in a way that can be announced by assistive technologies.

By default, isLiveRegionalerts are static.

Alerts that are asynchronously appended into dynamic alert groups via the isLiveRegion property will be announced to assistive technology the moment the change happens, following the strategy used for aria-atomic, which defaults to false. This means only changes of type "addition" will be announced.

This example shows how an alert could be triggered by an asynchronous event in the application. Note that you can customize how the alert will be announced to assistive technology. See the alert accessibility for more information.

All alert group variants may combine multiple alert variants For example, the following static inline alert group includes one "success" alert and one "info" alert.

Toast alert groups are created by passing in the isToast and isLiveRegion properties.

Click the buttons in the example below to add alerts to a toast group.

Users will see an overflow message once a predefined number of alerts are displayed. They will not see any alerts beyond the display limit, which must be explicitly set.

In the following example, an overflow message will appear when more than 4 alerts would be shown. When a 5th alert would appear, an overflow message is shown instead.

When an overflow message appears in an AlertGroup using the isLiveRegion property, the "view 1 more alert" text label will be announced, but the alert message will not.

Users navigating via keyboard or another assistive technology will need a way to navigate to and reveal hidden alerts before they disappear. Alternatively, there should be a place where notifications or alerts are collected to be viewed or read later.

The following example shows how alerts can be triggered by an asynchronous event in the application. You can customize how an alert will be announced to assistive technology by adjusting the value of the aria-live property. Click the "start async" alert button below and then click the buttons in the above toast examples to demonstrate how asynchronous events add alerts to a group. Click the "stop async alerts" button to halt this behavior.

See the alert accessibility tab for more information on customizing this behavior.

Click the buttons in the example below to add dynamic alerts to a group.

In the following example, there can be a maximum of 4 alerts shown at once.

You may add multiple alerts to an alert group at once. Click the "add alert collection" button in the example below to add a batch of 3 toast alerts to a group.