Skip to content

Latest commit

 

History

History
235 lines (170 loc) · 9.22 KB

alerts.md

File metadata and controls

235 lines (170 loc) · 9.22 KB
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
/docs/components/alerts/
true

Examples

Alerts are available for any length of text, as well as an optional close button. For proper styling, use one of the four required contextual classes (e.g., .alert-success). For inline dismissal, use the alerts JavaScript plugin.

Boosted also adds a dedicated icon for each contextual class using .alert-icon, matching [functional colors in palette]({{<docsref "customize/color-theme#functional">}}):

  • success,
  • info,
  • warning,
  • danger.

{{< callout info >}} Heads up! As of v5.3.0, the alert-variant() Sass mixin is deprecated. Alert variants now have their CSS variables overridden in a Sass loop. {{< /callout >}}

{{< example >}}

Success

Success notification text goes here.

Info

Information notification text goes here.

Warning

Warning notification text goes here.

Error

Error notification text goes here.

{{< /example >}}

{{< callout info >}} {{< partial "callouts/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.

{{< example stackblitz_add_js="true" >}}

Show live alert {{< /example >}}

We use the following JavaScript to trigger our live alert demo:

{{< js-docs name="live-alert" file="site/assets/js/partials/snippets.js" >}}

Sizes

Alerts come with a smaller variant: .alert-sm.

{{< example >}}

Success

Success notification text goes here.

Info

Information notification text goes here.

Warning

Warning notification text goes here.

Error

Error notification text goes here.

{{< /example >}}

Additional content

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

As of Boosted, it's recommended to wrap your additional content in a <div> to ensure proper alignment and, for headings, to always use the .alert-heading class.

{{< example >}}

Success

Success notification text with a link goes here.

Description text with a link goes here.

{{< /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 Boosted 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 <button> element with it for proper behavior across all devices.
  • On the close button, add the data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-title="Close" attributes, which add a tooltip for better accessibility. You also need to [enable tooltips]({{< docsref "/components/tooltips#enable-tooltips" >}}) (if not already done).
  • 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 stackblitz_add_js="true" >}}

Warning

Warning notification text goes here.

Close
{{< /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 >}}

{{% enable-btn-close-tooltip 4 alerts %}}

Dark variant

{{< deprecated-in "5.3.3" >}}

{{< callout-deprecated-dark-variants "alert" >}}

CSS

Variables

{{< added-in "5.2.0" >}}

As part of Boosted's evolving CSS variables approach, alerts now use local CSS variables on .alert for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

{{< scss-docs name="alert-css-vars" file="scss/_alert.scss" >}}

Customization through CSS variables can be seen on the .alert-sm class where we override specific values without adding duplicate CSS selectors.

{{< scss-docs name="alert-sm-css-vars" file="scss/_alert.scss" >}}

Sass variables

{{< scss-docs name="alert-variables" file="scss/_variables.scss" >}}

Sass mixins

{{< deprecated-in "5.3.0" >}}

{{< scss-docs name="alert-variant-mixin" file="scss/mixins/_alert.scss" >}}

Sass loops

Loop that generates the modifier classes with an overriding of CSS variables.

{{< scss-docs name="alert-modifiers" file="scss/_alert.scss" >}}

JavaScript behavior

Initialize

Initialize elements as alerts

const alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new boosted.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 section for more details. {{< /callout >}}

Triggers

{{% js-dismiss "alert" %}}

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

Methods

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

const bsAlert = new boosted.Alert('#myAlert')

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

{{< bs-table >}}

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. For example: boosted.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 initialized. You can use it like this: boosted.Alert.getOrCreateInstance(element).
{{< /bs-table >}}

Basic usage:

const alert = boosted.Alert.getOrCreateInstance('#myAlert')
alert.close()

Events

Boosted's alert plugin exposes a few events for hooking into alert functionality.

{{< bs-table >}}

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.
{{< /bs-table >}} 
const myAlert = document.getElementById('myAlert')
myAlert.addEventListener('closed.bs.alert', event => {
  // 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()
})