--- layout: docs title: Toasts description: Push notifications to your visitors with a toast, a lightweight and easily customizable alert message. group: components toc: true --- Toasts are lightweight notifications designed to mimic the push notifications that have been popularized by mobile and desktop operating systems. They're built with flexbox, so they're easy to align and position. ## Overview Things to know when using the toast plugin: - Toasts are opt-in for performance reasons, so **you must initialize them yourself**. - Toasts will automatically hide if you do not specify `autohide: false`. {{< callout info >}} {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}} ## Examples ### Basic To encourage extensible and predictable toasts, we recommend a header and body. Toast headers use `display: flex`, allowing easy alignment of content thanks to our margin and flexbox utilities. Toasts are as flexible as you need and have very little required markup. At a minimum, we require a single element to contain your "toasted" content and strongly encourage a dismiss button. {{< example class="bg-light" >}} {{< /example >}} ### Live Click the button the below to show as toast (positioning with our utilities in the lower right corner) that has been hidden by default with `.hide`.
```html
``` ### Translucent Toasts are slightly translucent, too, so they blend over whatever they might appear over. {{< example class="bg-dark" >}} {{< /example >}} ### Stacking You can stack toasts by wrapping them in a toast container, which will vertically add some spacing. {{< example class="bg-light" >}}
{{< /example >}} ### Custom content Customize your toasts by removing sub-components, tweaking with [utilities]({{< docsref "/utilities/api" >}}), or adding your own markup. Here we've created a simpler toast by removing the default `.toast-header`, adding a custom hide icon from [Bootstrap Icons]({{< param icons >}}), and using some [flexbox utilities]({{< docsref "/utilities/flex" >}}) to adjust the layout. {{< example class="bg-light" >}} {{< /example >}} Alternatively, you can also add additional controls and components to toasts. {{< example class="bg-light" >}} {{< /example >}} ### Color schemes Building on the above example, you can create different toast color schemes with our [color utilities]({{< docsref "/utilities/colors" >}}). Here we've added `.bg-primary` and `.text-white` to the `.toast`, and then added `.btn-close-white` to our close button. For a crisp edge, we remove the default border with `.border-0`. {{< example class="bg-light" >}} {{< /example >}} ## Placement Place toasts with custom CSS as you need them. The top right is often used for notifications, as is the top middle. If you're only ever going to show one toast at a time, put the positioning styles right on the `.toast`. {{< example >}}
{{< placeholder width="20" height="20" background="#007aff" class="rounded me-2" text="false" title="false" >}} Bootstrap 11 mins ago
Hello, world! This is a toast message.
{{< /example >}} For systems that generate more notifications, consider using a wrapping element so they can easily stack. {{< example class="bg-dark bd-example-toasts p-0" >}}
{{< /example >}} You can also get fancy with flexbox utilities to align toasts horizontally and/or vertically. {{< example class="bg-dark bd-example-toasts d-flex" >}}
{{< /example >}} ## Accessibility Toasts are intended to be small interruptions to your visitors or users, so to help those with screen readers and similar assistive technologies, you should wrap your toasts in an [`aria-live` region](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Live_Regions). Changes to live regions (such as injecting/updating a toast component) are automatically announced by screen readers without needing to move the user's focus or otherwise interrupt the user. Additionally, include `aria-atomic="true"` to ensure that the entire toast is always announced as a single (atomic) unit, rather than announcing what was changed (which could lead to problems if you only update part of the toast's content, or if displaying the same toast content at a later point in time). If the information needed is important for the process, e.g. for a list of errors in a form, then use the [alert component]({{< docsref "/components/alerts" >}}) instead of toast. Note that the live region needs to be present in the markup *before* the toast is generated or updated. If you dynamically generate both at the same time and inject them into the page, they will generally not be announced by assistive technologies. You also need to adapt the `role` and `aria-live` level depending on the content. If it's an important message like an error, use `role="alert" aria-live="assertive"`, otherwise use `role="status" aria-live="polite"` attributes. As the content you're displaying changes, be sure to update the [`delay` timeout](#options) to ensure people have enough time to read the toast. ```html ``` When using `autohide: false`, you must add a close button to allow users to dismiss the toast. {{< example class="bg-light" >}} {{< /example >}} ## JavaScript behavior ### Usage Initialize toasts via JavaScript: ```js var toastElList = [].slice.call(document.querySelectorAll('.toast')) var toastList = toastElList.map(function (toastEl) { return new bootstrap.Toast(toastEl, option) }) ``` ### Options Options can be passed via data attributes or JavaScript. For data attributes, append the option name to `data-bs-`, as in `data-bs-animation=""`.
Name Type Default Description
animation boolean true Apply a CSS fade transition to the toast
autohide boolean true Auto hide the toast
delay number 5000 Delay hiding the toast (ms)
### Methods {{< callout danger >}} {{< partial "callout-danger-async-methods.md" >}} {{< /callout >}} #### show Reveals an element's toast. **Returns to the caller before the toast has actually been shown** (i.e. before the `shown.bs.toast` event occurs). You have to manually call this method, instead your toast won't show. ```js toast.show() ``` #### hide Hides an element's toast. **Returns to the caller before the toast has actually been hidden** (i.e. before the `hidden.bs.toast` event occurs). You have to manually call this method if you made `autohide` to `false`. ```js toast.hide() ``` #### dispose Hides an element's toast. Your toast will remain on the DOM but won't show anymore. ```js toast.dispose() ``` ### Events
Event type Description
show.bs.toast This event fires immediately when the show instance method is called.
shown.bs.toast This event is fired when the toast has been made visible to the user.
hide.bs.toast This event is fired immediately when the hide instance method has been called.
hidden.bs.toast This event is fired when the toast has finished being hidden from the user.
```js var myToastEl = document.getElementById('myToast') myToastEl.addEventListener('hidden.bs.toast', function () { // do something... }) ```