Skip to content

Latest commit

 

History

History
184 lines (151 loc) · 6.03 KB

alerts.md

File metadata and controls

184 lines (151 loc) · 6.03 KB
Raw
layout title description group aliases toc
docs
Alerts
Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.
components
/components/
/docs/5.0/components/
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.

{{< example >}} {{< alerts.inline >}} {{- range (index $.Site.Data "theme-colors") }}

A simple {{ .name }} alert—check it out!
{{- end -}} {{< /alerts.inline >}} {{< /example >}}

{{% callout info %}} {{< partial "callout-warning-color-assistive-technologies.md" >}} {{% /callout %}}

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") }}

A simple {{ .name }} alert with an example link. Give it a click if you like.
{{ end -}} {{< /alerts.inline >}} {{< /example >}}

Additional content

Alerts can also contain additional HTML elements like headings, paragraphs and dividers.

{{< example >}}

Well done!

Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.

Whenever you need to, be sure to use margin utilities to keep things nice and tidy.

{{< /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-dismiss="alert" attribute, which triggers the JavaScript functionality. Be sure to use the <button> element with it for proper behavior across all devices.
  • To animate alerts when dismissing them, be sure to add the .fade and .show classes.

You can see this in action with a live demo:

{{< example >}}

Holy guacamole! You should check in on some of those fields below.
{{< /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 %}}

JavaScript behavior

Triggers

Enable dismissal of an alert via JavaScript:

var alertList = document.querySelectorAll('.alert')
alertList.forEach(function (alert) {
  new bootstrap.Alert(alert)
})

Or with data attributes on a button within the alert, as demonstrated above:

<button type="button" class="btn-close" data-dismiss="alert" aria-label="Close"></button>

Note that closing an alert will remove it from the DOM.

Methods

You can create an alert instance with the alert constructor, for example:

var myAlert = document.getElementById('myAlert')
var bsAlert = new bootstrap.Alert(myAlert)

This makes an alert listen for click events on descendant elements which have the data-dismiss="alert" attribute. (Not necessary when using the data-api's auto-initialization.)

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) 
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. 
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()
})