Alert
Source: https://getbootstrap.com/docs/6.0/components/alert
Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages.
Default alert
Alerts are available for any length of text, as well as an optional close button. Alerts are designed to be used with theme colors, but have neutral fallback colors for when no theme color is applied. For inline dismissal, use the alerts JavaScript plugin.
<p>A simple alert—check it out!</p>
</div>`} />
Variants
Use any of our variant theme classes for color mode adaptive, contextual styling.
<Example class="vstack gap-3" code={getData('theme-colors').map((themeColor) => <div class="alert theme-${themeColor.name}" role="alert">
<p>A simple ${themeColor.name} alert—check it out!</p>
</div>)} />
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 addStackblitzJs class="d-flex flex-column align-items-start gap-3" code={<div id="liveAlertPlaceholder"></div>
<button type="button" class="btn-solid theme-primary flex-grow-0" id="liveAlertBtn">Show live alert</button>} />
We use the following JavaScript to trigger our live alert demo:
Link color
Use the .alert-link utility class to quickly provide matching colored links within any alert.
<Example class="vstack gap-3" code={getData('theme-colors').map((themeColor) => <div class="alert theme-${themeColor.name}" role="alert">
<p>A simple ${themeColor.name} alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>)} />
Additional content
Alerts can also contain additional HTML elements like headings, paragraphs and dividers.
<vstack>
<h4 class="alert-heading mb-2">Well done!</h4>
<p>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.</p>
<hr class="my-3">
<p class="mb-0">Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p>
</vstack>
</div>`} />
With icons
Similarly, you can use flexbox utilities and Bootstrap Icons to create alerts with icons. Depending on your icons and content, you may want to add more utilities or custom styles.
<svg xmlns="http://www.w3.org/2000/svg" class="bi flex-shrink-0" viewBox="0 0 16 16" role="img" aria-label="Warning:">
<path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5zm.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2z"/>
</svg>
<p>An example alert with an icon</p>
</div>`} />
Dismiss
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 and use flexbox utilities (e.g.
ms-auto) to position it within the alert. - 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.
An alert fades out before it is removed. The plugin adds .hiding for the length of the transition, so no extra classes are needed in your markup. Add .alert-instant to remove the alert at once instead. See Transitions for the tokens that tune the fade.
You can see this in action with a live demo:
<p>Something’s wrong, check the fields below and try again.</p>
</div>`} />
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.
CSS
Variables
Sass loops
Loop that generates the modifier classes with an overriding of CSS variables.
JavaScript behavior
Initialize
Initialize elements as alerts
const alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new bootstrap.Alert(element))
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.
Via data attributes
| Attribute | Description |
|---|---|
data-bs-dismiss="alert" |
On a close control, dismisses (and removes) the alert when activated. |
Triggers
Note that closing an alert will remove it from the DOM.
Dependencies
Methods
You can create an alert instance with the alert constructor, for example:
const bsAlert = new bootstrap.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.)
| Method | Description |
|---|---|
close |
Closes an alert by removing it from the DOM. The alert fades out first, unless it has .alert-instant. Returns a promise that resolves once the alert is removed (i.e. after the closed.bs.alert event fires). |
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: 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 initialized. You can use it like this: bootstrap.Alert.getOrCreateInstance(element). |
Basic usage:
const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')
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. |
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()
})
