Alert

Overview Style Guidelines Code Demos Accessibility
  1. rh-alert
  1. rh-alert

Installation

Learn more about how to install on our getting started docs.

Red Hat CDN 
<script type="module">
  import '@rhds/elements/rh-alert/rh-alert.js';
</script>
Import Map Example 
<script type="importmap">
  {
    "imports": {
      "@rhds/elements/": "https://www.redhatstatic.com/dx/v1-alpha/@rhds/elements@2.0.1/elements/",
    }
  }
</script>
 NPM 
npm install @rhds/elements
<script type="module">
  import '@rhds/elements/rh-alert/rh-alert.js';
</script>
 JSPM 
<script type="module">
  import '@rhds/elements/rh-alert/rh-alert.js';
</script>
Import Map Example 
<script type="importmap">
{
  "imports": {
    "@rhds/elements/rh-alert/rh-alert.js": "./elements/rh-alert/rh-alert.js"
  },
  "scopes": {
    "./": {
      "@patternfly/pfe-core/": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.2/",
      "@patternfly/pfe-core/ssr-shims.js": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.2/core.js",
      "@rhds/elements/lib/context/color/provider.js": "./lib/context/color/provider.js",
      "@rhds/elements/": "./elements/",
      "@rhds/icons": "https://ga.jspm.io/npm:@rhds/icons@1.1.2/icons.js",
      "@rhds/tokens/css/": "https://ga.jspm.io/npm:@rhds/tokens@2.1.0-next.15/css/",
      "lit": "https://ga.jspm.io/npm:lit@3.2.0/index.js",
      "lit/": "https://ga.jspm.io/npm:lit@3.2.0/",
      "tslib": "https://ga.jspm.io/npm:tslib@2.7.0/tslib.es6.mjs"
    },
    "https://ga.jspm.io/": {
      "@lit/reactive-element": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/reactive-element.js",
      "@lit/reactive-element/decorators/": "https://ga.jspm.io/npm:@lit/reactive-element@2.0.4/development/decorators/",
      "@patternfly/pfe-core/controllers/property-observer-controller.js": "https://ga.jspm.io/npm:@patternfly/pfe-core@4.0.2/controllers/property-observer-controller.js",
      "lit": "https://ga.jspm.io/npm:lit@3.2.0/index.js",
      "lit-element/lit-element.js": "https://ga.jspm.io/npm:lit-element@4.1.0/development/lit-element.js",
      "lit-html": "https://ga.jspm.io/npm:lit-html@3.2.0/development/lit-html.js",
      "lit-html/": "https://ga.jspm.io/npm:lit-html@3.2.0/development/",
      "tslib": "https://ga.jspm.io/npm:tslib@2.7.0/tslib.es6.mjs"
    }
  }
}
</script>

rh-alert

Slots 3
Slot Name Description

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 3
Attribute DOM Property Description Type Default
state 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.
 
'default' | 'error' | 'success' | 'warning' | 'danger' | 'info'

'default'
variant 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.

 
'alternate' | 'toast' | 'inline' | undefined

unknown
dismissable 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.

 
boolean

false
Methods 0

None

 Events 1
Event Name Description
close

when the dismissable alert closes
CSS Shadow Parts 0

None

 CSS Custom Properties 0

None

 Design Tokens 30
Token Copy
--rh-border-width-md
--rh-box-shadow-lg
--rh-color-icon-status-danger
--rh-color-icon-status-info
--rh-color-icon-status-success
--rh-color-icon-status-warning
--rh-color-interactive-primary-default
--rh-color-interactive-primary-hover
--rh-color-status-danger
--rh-color-status-note
--rh-color-status-success
--rh-color-status-warning
--rh-color-surface-lightest
--rh-color-surface-status-danger
--rh-color-surface-status-info
--rh-color-surface-status-success
--rh-color-surface-status-warning
--rh-color-teal-10
--rh-color-teal-50
--rh-color-teal-70
--rh-color-text-primary
--rh-color-text-secondary
--rh-font-family-body-text
--rh-font-size-body-text-sm
--rh-font-weight-heading-bold
--rh-length-xl
--rh-size-icon-02
--rh-space-lg
--rh-space-xl
--rh-space-xs
Edit this page on GitHub