package.docs.components.Alert.examples.Alert.md Maven / Gradle / Ivy
Show all versions of patternfly Show documentation
---
id: Alert
section: components
cssPrefix: ['pf-v6-c-alert','pf-v6-c-alert-group']
---## Alert examples
### Types
```html
Custom alert:
Custom alert title
Info alert:
Info alert title
Success alert:
Success alert title
Warning alert:
Warning alert title
Danger alert:
Danger alert title
```
### Variations
```html
Success alert:
Success alert title
Success alert description. This should tell the user more information about the alert.
Success alert:
Success alert title
Success alert description. This should tell the user more information about the alert.
This is a link.
Success alert:
Success alert title
Success alert:
Success alert title
Success alert:
Success alert title
Success alert:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur pellentesque neque cursus enim fringilla tincidunt. Proin lobortis aliquam dictum. Nam vel ullamcorper nulla, nec blandit dolor. Vivamus pellentesque neque justo, nec accumsan nulla rhoncus id. Suspendisse mollis, tortor quis faucibus volutpat, sem leo fringilla turpis, ac lacinia augue metus in nulla. Cras vestibulum lacinia orci. Pellentesque sodales consequat interdum. Sed porttitor tincidunt metus nec iaculis. Pellentesque non commodo justo. Morbi feugiat rhoncus neque, vitae facilisis diam aliquam nec. Sed dapibus vitae quam at tristique. Nunc vel commodo mi. Mauris et rhoncus leo.
This example uses ".pf-m-truncate" to limit the title to a single line and truncate any overflow text with ellipses.
Success alert:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur pellentesque neque cursus enim fringilla tincidunt. Proin lobortis aliquam dictum. Nam vel ullamcorper nulla, nec blandit dolor. Vivamus pellentesque neque justo, nec accumsan nulla rhoncus id. Suspendisse mollis, tortor quis faucibus volutpat, sem leo fringilla turpis, ac lacinia augue metus in nulla. Cras vestibulum lacinia orci. Pellentesque sodales consequat interdum. Sed porttitor tincidunt metus nec iaculis. Pellentesque non commodo justo. Morbi feugiat rhoncus neque, vitae facilisis diam aliquam nec. Sed dapibus vitae quam at tristique. Nunc vel commodo mi. Mauris et rhoncus leo.
This example uses ".pf-m-truncate" and sets "--pf-v6-c-alert__title--max-lines: 2" to limit title to two lines and truncate any overflow text with ellipses.
```
### Inline types
```html
Custom inline alert:
Custom inline alert title
Info alert:
Info inline alert title
Success alert:
Success inline alert title
Warning alert:
Warning inline alert title
Danger alert:
Danger inline alert title
```
### Inline variations
```html
Success alert:
Success alert title
Success alert description. This should tell the user more information about the alert.
Success alert:
Success alert title
Success alert description. This should tell the user more information about the alert.
This is a link.
Success alert:
Success alert title
Success alert:
Success alert title
```
### Custom icon
```html
Success alert:
Success alert title
Success alert:
Success alert title (inline)
```
### Inline plain
```html
Success alert:
Success alert title
```
### Expandable
```html
```
## Alert group examples
### Static alert group
An alert group is optional when only one static alert is needed. It becomes required when more than one alert is used in a list.
```html
-
Success alert:
Success alert title
-
Danger alert:
Danger alert title
-
```
### Toast alert group
An alert group is required to display toast alerts. An alert group that includes the `.pf-m-toast` modifier becomes a toast alert group with unique positioning in the top-right corner of the window.
Every toast alert must include a close button to dismiss the alert.
When toast alerts include a link or action, these elements are not announced as interactive elements by screen readers. Whenever you include a link or button, incorporate it into the message so that it’s clear to the user how to access the same contents or action without clicking the link or button directly in the toast. For example, if your toast alert displays a message “The build is complete. Go to the Builds page to download,” the screen reader user is given instructions on how to find their build for download.
For sighted users, interactive elements can be included in this message in one of the following ways:
* Using a link to the Builds page: "The build is complete. Go to the [Builds](#) page to download" using `Builds`
* Using a button to download: "The build is complete. Go to the Builds page to " using ``
```html isFullscreen
-
Success alert:
Success toast alert title
-
Danger alert:
Danger toast alert title
-
Info alert:
Info toast alert title
Info toast alert description. From the settings tab, click
View logs to review the details.
-
```
## Documentation
### Alert overview
Add a modifier class to the default alert to change the color: `.pf-m-success`, `.pf-m-danger`, `.pf-m-warning`, or `.pf-m-info`.
### Alert usage
| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-alert` | `` | Initiates the alert component. Always use with a status modifier class. **Required** |
| `.pf-v6-c-alert__toggle` | `` | Defines the expandable alert toggle icon. **Required for expandable alerts** |
| `.pf-v6-c-alert__toggle-icon` | `` | Defines the expandable alert toggle icon. **Required for expandable alerts** |
| `.pf-v6-c-alert__icon` | `` | Defines the alert icon. **Required** |
| `.pf-v6-c-alert__title` | `, ` | Defines the alert title. **Required** |
| `.pf-v6-c-alert__description` | `` | Defines the alert description area. |
| `.pf-v6-c-alert__action` | `` | Defines the action button wrapper. Should contain `.pf-v6-c-button.pf-m-plain` for close action or `.pf-v6-c-button.pf-m-link` for link text. It should only include one action. |
| `.pf-v6-c-alert__action-group` | `` | Defines the action button group. Should contain `.pf-v6-c-button.pf-m-link.pf-m-inline` for inline link text. **Note:** only inline link buttons are supported in the alert action group. |
| `.pf-m-custom` | `.pf-v6-c-alert` | Applies custom status styling. |
| `.pf-m-success` | `.pf-v6-c-alert` | Applies success status styling. |
| `.pf-m-danger` | `.pf-v6-c-alert` | Applies danger status styling. |
| `.pf-m-warning` | `.pf-v6-c-alert` | Applies warning status styling. |
| `.pf-m-info` | `.pf-v6-c-alert` | Applies info status styling. |
| `.pf-m-inline` | `.pf-v6-c-alert` | Applies inline styling. |
| `.pf-m-plain` | `.pf-v6-c-alert.pf-m-inline` | Applies plain styling to an inline alert. |
| `.pf-m-expandable` | `.pf-v6-c-alert` | Applies expandable styles to the alert. |
| `.pf-m-expanded` | `.pf-v6-c-alert.pf-m-expandable` | Applies expanded styles to an expandable alert. |
| `.pf-m-truncate` | `.pf-v6-c-alert__title` | Modifies the title to display a single line and truncate any overflow text with ellipses. **Note:** you can specify the max number of lines to show by setting the `--pf-v6-c-alert__title--max-lines` (the default value is `1`). |
### Alert group overview
The alert component is used to contain and align consecutive alerts. Alert groups can either be embedded alongside a page's content or in the top-right corner as a toast group using the `.pf-m-toast` modifier.
### Alert group usage
| Class | Applied to | Outcome |
| -- | -- | -- |
| `.pf-v6-c-alert-group` | `` | Creates an alert group component. **Required** |
| `.pf-v6-c-alert-group__item` | `- ` | Creates an alert group item. **Required** |
| `.pf-v6-c-alert-group__overflow-button` | `
© 2015 - 2025 Weber Informatics LLC | Privacy Policy