Installation
CDN Prerelease
We are currently working on our CDN, which will be soon moving into beta. This will be the preferred method of installation in the near future. If you are a Red Hat associate and have questions or comments about the CDN or installation process please join us in our Red Hat Design System Google chat.
In the meantime, install this component using npm
The recommended way to load RHDS is via the Red Hat Digital Experience CDN, and using an import map.
If you have full control over the page you are using, add an import map
to the <head>, pointing to the CDN, or update any existing import map.
If you are not responsible for the page's <head>, request that the
page owner makes the change on your behalf.
<script type="importmap">
{
"imports": {
"@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@1.1.0/elements/",
"@patternfly/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@patternfly/elements@2.2.2/"
}
}
</script>Once the import map is established, you can load the element with the following module, containing a bare module specifier:
<script type="module">
import '@rhds/elements/rh-alert/rh-alert.js';
</script>Note that Modules may be placed in the <head>: since they are deferred by default,
they will not block rendering.
Install RHDS using your team's preferred NPM package manager, e.g.
npm install @rhds/elementsOnce that's been accomplished, you will need to use a bundler to resolve the bare module specifiers and optionally optimize the package for your site's particular use case and needs. Comprehensive guides to bundling are beyond the scope of this page; read more about bundlers on their websites:
Public CDNs
JSPM and other public CDNs should not be used on corporate domains. Use them for development purposes only!
Add an import map to the <head>, pointing to the CDN,
or update any existing import map.
<script type="importmap">
{
"imports": {
"@rhds/elements/": "https://jspm.dev/@rhds/elements/",
"@patternfly/elements/": "https://jspm.dev/@patternfly/elements/"
}
}
</script>Once the import map is established, you can load the element with the following module, containing a bare module specifier:
<script type="module">
import '@rhds/elements/rh-alert/rh-alert.js';
</script>Note that Modules may be placed in the <head>: since they are deferred by default,
they will not block rendering.
rh-alert
Slots
- Default Slot
-
Provide a description for the alert message
-
header -
Provide a header for the alert message.
-
actions -
Provide actions that the user can take for the alert
Attributes
state-
Communicates the urgency of a message and is denoted by various styling configurations.
default- Indicates generic information or a message with no severity.info- Indicates helpful information or a message with very little to no severity.success- Indicates a success state, like if a process was completed without errors.warning- Indicates a caution state, like a non-blocking error that might need to be fixed.danger- Indicates a danger state, like an error that is blocking a user from completing a task.
- DOM Property
state- Type
-
'default' | 'error' | 'success' | 'warning' | 'danger' | 'info' - Default
-
'default'
variant-
The alternate Inline alert style includes a border instead of a line which can be used to express more urgency or better grab the attention of a user.
A Toast alert is used to present a global message about an event, update, or confirmation, like the result of a user action that cannot be presented within a specific layout or component.
- DOM Property
variant- Type
-
'alternate' | 'toast' | 'inline' | undefined - Default
-
unknown
toast-
- DOM Property
toast- Type
-
boolean - Default
-
false
dismissable-
Alert variants have different rules regarding their ability to be dismissed by a user. Default, Info, and Success Inline alerts can be dismissed by a user selecting the close button. Warning and Danger Inline alerts can be dismissed by a user resolving the issues caused by the alert. All Toast alerts can be dismissed by a user selecting the close button or waiting for them to time out.
- DOM Property
dismissable- Type
-
boolean - Default
-
false
Methods
None
Events
close-
when the dismissable alert closes
Event Type:AlertCloseEvent
CSS Shadow Parts
None
CSS Custom Properties
None
Design Tokens
Related elements or patterns
Feedback
To give feedback about anything on this page, contact us.
Red Hat legal and privacy links
- About Red Hat
- Jobs
- Events
- Locations
- Contact Red Hat
- Red Hat Blog
- Diversity, equity, and inclusion
- Cool Stuff Store
- Red Hat Summit
Red Hat legal and privacy links
