--- layout: docs title: Alerts description: Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. group: components toc: true --- ## Examples Alerts are available for any length of text, as well as an optional close button. For proper styling, use one of the eight **required** contextual classes (e.g., `.alert-success`). For inline dismissal, use the [alerts JavaScript plugin](#dismissing). {{< example >}} {{< alerts.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{- end -}} {{< /alerts.inline >}} {{< /example >}} {{< callout info >}} {{< partial "callout-warning-color-assistive-technologies.md" >}} {{< /callout >}} ### Live example Click the button below to show an alert (hidden with inline styles to start), then dismiss (and destroy) it with the built-in close button.
```html ``` We use the following JavaScript to trigger our live alert demo: ```js var alertPlaceholder = document.getElementById('liveAlertPlaceholder') var alertTrigger = document.getElementById('liveAlertBtn') function alert(message, type) { var wrapper = document.createElement('div') wrapper.innerHTML = '' alertPlaceholder.append(wrapper) } if (alertTrigger) { alertTrigger.addEventListener('click', function () { alert('Nice, you triggered this alert message!', 'success') }) } ``` ### Link color Use the `.alert-link` utility class to quickly provide matching colored links within any alert. {{< example >}} {{< alerts.inline >}} {{- range (index $.Site.Data "theme-colors") }} {{ end -}} {{< /alerts.inline >}} {{< /example >}} ### Additional content Alerts can also contain additional HTML elements like headings, paragraphs and dividers. {{< example >}} {{< /example >}} ### Icons Similarly, you can use [flexbox utilities]({{< docsref "/utilities/flex" >}}) and [Bootstrap Icons]({{< param icons >}}) to create alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles. {{< example >}} {{< /example >}} Need more than one icon for your alerts? Consider using more Bootstrap Icons and making a local SVG sprite like so to easily reference the same icons repeatedly. {{< example >}} {{< /example >}} ### Dismissing Using the alert JavaScript plugin, it's possible to dismiss any alert inline. Here's how: - Be sure you've loaded the alert plugin, or the compiled Bootstrap JavaScript. - Add a [close button]({{< docsref "/components/close-button" >}}) and the `.alert-dismissible` class, which adds extra padding to the right of the alert and positions the close button. - On the close button, add the `data-bs-dismiss="alert"` attribute, which triggers the JavaScript functionality. Be sure to use the ` {{< /example >}} {{< callout warning >}} When an alert is dismissed, the element is completely removed from the page structure. If a keyboard user dismisses the alert using the close button, their focus will suddenly be lost and, depending on the browser, reset to the start of the page/document. For this reason, we recommend including additional JavaScript that listens for the `closed.bs.alert` event and programmatically sets `focus()` to the most appropriate location in the page. If you're planning to move focus to a non-interactive element that normally does not receive focus, make sure to add `tabindex="-1"` to the element. {{< /callout >}} ## Sass ### Variables {{< scss-docs name="alert-variables" file="scss/_variables.scss" >}} ### Variant mixin Used in combination with `$theme-colors` to create contextual modifier classes for our alerts. {{< scss-docs name="alert-variant-mixin" file="scss/mixins/_alert.scss" >}} ### Loop Loop that generates the modifier classes with the `alert-variant()` mixin. {{< scss-docs name="alert-modifiers" file="scss/_alert.scss" >}} ## JavaScript behavior ### Initialize Initialize elements as alerts ```js var alertList = document.querySelectorAll('.alert') var alerts = [].slice.call(alertList).map(function (element) { return new bootstrap.Alert(element) }) ``` {{< callout info >}} For the sole purpose of dismissing an alert, it isn't necessary to initialize the component manually via the JS API. By making use of `data-bs-dismiss="alert"`, the component will be initialized automatically and properly dismissed. See the [triggers](#triggers) section for more details. {{< /callout >}} ### Triggers Dismissal can be achieved with `data` attributes on a button **within the alert** as demonstrated above: ```html ``` or on a button **outside the alert** using the `data-bs-target` as demonstrated above: ```html ``` **Note that closing an alert will remove it from the DOM.** ### Methods
Method Description
close Closes an alert by removing it from the DOM. If the .fade and .show classes are present on the element, the alert will fade out before it is removed.
dispose Destroys an element's alert. (Removes stored data on the DOM element)
getInstance Static method which allows you to get the alert instance associated to a DOM element, you can use it like this: bootstrap.Alert.getInstance(alert)
getOrCreateInstance Static method which returns an alert instance associated to a DOM element or create a new one in case it wasn't initialised. You can use it like this: bootstrap.Alert.getOrCreateInstance(element)
```js var alertNode = document.querySelector('.alert') var alert = bootstrap.Alert.getInstance(alertNode) alert.close() ``` ### Events Bootstrap's alert plugin exposes a few events for hooking into alert functionality.
Event Description
close.bs.alert Fires immediately when the close instance method is called.
closed.bs.alert Fired when the alert has been closed and CSS transitions have completed.
```js var myAlert = document.getElementById('myAlert') myAlert.addEventListener('closed.bs.alert', function () { // do something, for instance, explicitly move focus to the most appropriate element, // so it doesn't get lost/reset to the start of the page // document.getElementById('...').focus() }) ```