Toasts

通过 Toast、轻量级且易于自定义的警报消息向访问者推送通知。

当前页

Toast 是轻量级通知，旨在模仿移动和桌面操作系统已普及的推送通知。它们采用弹性框构建，因此易于对齐和定位。

概述

使用 Toast 插件时需要了解的事项：

出于性能原因，Toast 是选择加入的，因此 您必须自己初始化它们。
如果您未指定autohide: false，Toasts 将自动隐藏。

此组件的动画效果取决于prefers-reduced-motion媒体查询。请参阅我们的辅助功能文档的减少运动部分。

示例

基本

为了鼓励可扩展和可预测的 Toast，我们建议使用标头和正文。Toast 标题使用display: flex，由于我们的边距和弹性框实用程序，可以轻松对齐内容。

Toast可以根据您的需要灵活，并且几乎没有所需的标记。至少，我们需要一个元素来包含您的"toasted"内容，并强烈建议使用关闭按钮。

Hello, world! This is a toast message.

html

<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
  <div class="toast-header">
    <img src="..." class="rounded me-2" alt="...">
    <strong class="me-auto">Bootstrap</strong>
    <small>11 mins ago</small>
    <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
  </div>
  <div class="toast-body">
    Hello, world! This is a toast message.
  </div>
</div>

以前，我们的脚本动态添加了.hide类来完全隐藏 toast（使用display:none，而不仅仅是opacity:0）。现在不再需要这样做了。但是，为了向后兼容，我们的脚本将继续切换类（即使没有实际需要），直到下一个主要版本。

现场示例

单击下面的按钮以显示默认情况下隐藏的 Toast（我们的实用程序位于右下角）。

Hello, world! This is a toast message.

<button type="button" class="btn btn-primary" id="liveToastBtn">Show live toast</button>

<div class="toast-container position-fixed bottom-0 end-0 p-3">
  <div id="liveToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
    <div class="toast-header">
      <img src="..." class="rounded me-2" alt="...">
      <strong class="me-auto">Bootstrap</strong>
      <small>11 mins ago</small>
      <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
    </div>
    <div class="toast-body">
      Hello, world! This is a toast message.
    </div>
  </div>
</div>

我们使用以下 JavaScript 来触发我们的实时 toast 演示：

const toastTrigger = document.getElementById('liveToastBtn')
const toastLiveExample = document.getElementById('liveToast')

if (toastTrigger) {
  const toastBootstrap = bootstrap.Toast.getOrCreateInstance(toastLiveExample)
  toastTrigger.addEventListener('click', () => {
    toastBootstrap.show()
  })
}

半透明

Toast 略带半透明，与它们下面的东西融为一体。

Hello, world! This is a toast message.

html

<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
  <div class="toast-header">
    <img src="..." class="rounded me-2" alt="...">
    <strong class="me-auto">Bootstrap</strong>
    <small class="text-body-secondary">11 mins ago</small>
    <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
  </div>
  <div class="toast-body">
    Hello, world! This is a toast message.
  </div>
</div>

Stac堆叠 king

您可以通过将Toast 包裹在Toast 容器中来堆叠Toast ，这将垂直增加一些间距。

See? Just like this.

Heads up, toasts will stack automatically

html

<div class="toast-container position-static">
  <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
    <div class="toast-header">
      <img src="..." class="rounded me-2" alt="...">
      <strong class="me-auto">Bootstrap</strong>
      <small class="text-body-secondary">just now</small>
      <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
    </div>
    <div class="toast-body">
      See? Just like this.
    </div>
  </div>

  <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
    <div class="toast-header">
      <img src="..." class="rounded me-2" alt="...">
      <strong class="me-auto">Bootstrap</strong>
      <small class="text-body-secondary">2 seconds ago</small>
      <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
    </div>
    <div class="toast-body">
      Heads up, toasts will stack automatically
    </div>
  </div>
</div>

自定义内容

通过删除子组件、使用 utilities调整它们或添加自己的标记来自定义 Toast。在这里，我们通过删除默认的.toast-header，从Bootstrap Icons中添加自定义隐藏图标，并使用一些flexbox实用程序来调整布局，从而创建了一个更简单的Toast。

Hello, world! This is a toast message.

html

<div class="toast align-items-center" role="alert" aria-live="assertive" aria-atomic="true">
  <div class="d-flex">
    <div class="toast-body">
      Hello, world! This is a toast message.
    </div>
    <button type="button" class="btn-close me-2 m-auto" data-bs-dismiss="toast" aria-label="Close"></button>
  </div>
</div>

或者，还可以向 Toast 添加其他控件和组件。

Hello, world! This is a toast message.

html

<div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
  <div class="toast-body">
    Hello, world! This is a toast message.
    <div class="mt-2 pt-2 border-top">
      <button type="button" class="btn btn-primary btn-sm">Take action</button>
      <button type="button" class="btn btn-secondary btn-sm" data-bs-dismiss="toast">Close</button>
    </div>
  </div>
</div>

配色方案

基于上述示例，您可以使用我们的 color 和 background实用程序创建不同的 Toast 配色方案。在这里，我们将.text-bg-primary添加到.toast，然后在关闭按钮中添加了 .btn-close-white。为了获得清晰的边缘，我们删除了带有.border-0的默认边框。

Hello, world! This is a toast message.

html

<div class="toast align-items-center text-bg-primary border-0" role="alert" aria-live="assertive" aria-atomic="true">
  <div class="d-flex">
    <div class="toast-body">
      Hello, world! This is a toast message.
    </div>
    <button type="button" class="btn-close btn-close-white me-2 m-auto" data-bs-dismiss="toast" aria-label="Close"></button>
  </div>
</div>

放置

根据需要使用自定义 CSS 放置 Toast。右上角通常用于通知，顶部中间也是如此。如果您一次只展示一个Toast ，请将定位样式放在.toast上。

Hello, world! This is a toast message.

html

<form>
  <div class="mb-3">
    <label for="selectToastPlacement">Toast placement</label>
    <select class="form-select mt-2" id="selectToastPlacement">
      <option value="" selected>Select a position...</option>
      <option value="top-0 start-0">Top left</option>
      <option value="top-0 start-50 translate-middle-x">Top center</option>
      <option value="top-0 end-0">Top right</option>
      <option value="top-50 start-0 translate-middle-y">Middle left</option>
      <option value="top-50 start-50 translate-middle">Middle center</option>
      <option value="top-50 end-0 translate-middle-y">Middle right</option>
      <option value="bottom-0 start-0">Bottom left</option>
      <option value="bottom-0 start-50 translate-middle-x">Bottom center</option>
      <option value="bottom-0 end-0">Bottom right</option>
    </select>
  </div>
</form>
<div aria-live="polite" aria-atomic="true" class="bg-body-secondary position-relative bd-example-toasts rounded-3">
  <div class="toast-container p-3" id="toastPlacement">
    <div class="toast">
      <div class="toast-header">
        <img src="..." class="rounded me-2" alt="...">
        <strong class="me-auto">Bootstrap</strong>
        <small>11 mins ago</small>
      </div>
      <div class="toast-body">
        Hello, world! This is a toast message.
      </div>
    </div>
  </div>
</div>

对于生成更多通知的系统，请考虑使用包装元素，以便它们可以轻松堆叠。

See? Just like this.

Heads up, toasts will stack automatically

html

<div aria-live="polite" aria-atomic="true" class="position-relative">
  <!-- Position it: -->
  <!-- - `.toast-container` for spacing between toasts -->
  <!-- - `top-0` & `end-0` to position the toasts in the upper right corner -->
  <!-- - `.p-3` to prevent the toasts from sticking to the edge of the container  -->
  <div class="toast-container top-0 end-0 p-3">

    <!-- Then put toasts within -->
    <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
      <div class="toast-header">
        <img src="..." class="rounded me-2" alt="...">
        <strong class="me-auto">Bootstrap</strong>
        <small class="text-body-secondary">just now</small>
        <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
      </div>
      <div class="toast-body">
        See? Just like this.
      </div>
    </div>

    <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
      <div class="toast-header">
        <img src="..." class="rounded me-2" alt="...">
        <strong class="me-auto">Bootstrap</strong>
        <small class="text-body-secondary">2 seconds ago</small>
        <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
      </div>
      <div class="toast-body">
        Heads up, toasts will stack automatically
      </div>
    </div>
  </div>
</div>

您还可以使用flexbox实用程序来水平和/或垂直对齐Toast 。

Hello, world! This is a toast message.

html

<!-- Flexbox container for aligning the toasts -->
<div aria-live="polite" aria-atomic="true" class="d-flex justify-content-center align-items-center w-100">

  <!-- Then put toasts within -->
  <div class="toast" role="alert" aria-live="assertive" aria-atomic="true">
    <div class="toast-header">
      <img src="..." class="rounded me-2" alt="...">
      <strong class="me-auto">Bootstrap</strong>
      <small>11 mins ago</small>
      <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
    </div>
    <div class="toast-body">
      Hello, world! This is a toast message.
    </div>
  </div>
</div>

可访问性

Toast 旨在对访问者或用户造成小干扰，因此为了帮助那些使用屏幕阅读器和类似辅助技术的人，您应该将 Toast 包装在 [aria-live 区域。对实时区域的更改（例如注入/更新 Toast 组件）由屏幕阅读器自动宣布，而无需移动用户的焦点或以其他方式中断用户。此外，包括aria-atomic="true"，以确保整个 Toast 始终作为单个（原子）单元宣布，而不仅仅是宣布更改的内容（如果仅更新 Toast 的部分内容，或者在以后显示相同的 Toast 内容，这可能会导致问题）。如果所需的信息对流程很重要，例如表单中的错误列表，则使用 alert component 代替 toast。

请注意，实时区域需要在生成或更新 Toast 之前存在于标记中。如果同时动态生成两者并将它们注入页面，则辅助技术通常不会宣布它们。

您还需要根据内容调整 role和aria-live级别。如果是像错误这样的重要消息，请使用role="alert" aria-live="assertive"，否则使用 role="status" aria-live="polite"属性。

随着显示内容的更改，请务必更新 delay超时，以便用户有足够的时间阅读 Toast。

<div class="toast" role="alert" aria-live="polite" aria-atomic="true" data-bs-delay="10000">
  <div role="alert" aria-live="assertive" aria-atomic="true">...</div>
</div>

使用autohide: false时，必须添加关闭按钮以允许用户关闭 Toast。

Hello, world! This is a toast message.

html

<div role="alert" aria-live="assertive" aria-atomic="true" class="toast" data-bs-autohide="false">
  <div class="toast-header">
    <img src="..." class="rounded me-2" alt="...">
    <strong class="me-auto">Bootstrap</strong>
    <small>11 mins ago</small>
    <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
  </div>
  <div class="toast-body">
    Hello, world! This is a toast message.
  </div>
</div>

虽然从技术上讲，可以在 Toast 中添加可聚焦/可操作的控件（例如其他按钮或链接），但应避免在自动隐藏 Toast 时执行此操作。即使为 Toast 提供较长的 delay超时，键盘和辅助技术用户也可能发现很难及时到达 Toast 以采取行动（因为 Toast 在显示时不会获得焦点）。如果您绝对必须有进一步的控制，我们建议使用带有autohide: false的 Toast。

CSS

变量

Added in v5.2.0

作为 Bootstrap 不断发展的 CSS 变量方法的一部分，Toast 现在在.toast上使用本地 CSS 变量来增强实时自定义。CSS 变量的值是通过 Sass 设置的，因此仍然支持 Sass 自定义。

scss/_toasts.scss

--#{$prefix}toast-zindex: #{$zindex-toast};
--#{$prefix}toast-padding-x: #{$toast-padding-x};
--#{$prefix}toast-padding-y: #{$toast-padding-y};
--#{$prefix}toast-spacing: #{$toast-spacing};
--#{$prefix}toast-max-width: #{$toast-max-width};
@include rfs($toast-font-size, --#{$prefix}toast-font-size);
--#{$prefix}toast-color: #{$toast-color};
--#{$prefix}toast-bg: #{$toast-background-color};
--#{$prefix}toast-border-width: #{$toast-border-width};
--#{$prefix}toast-border-color: #{$toast-border-color};
--#{$prefix}toast-border-radius: #{$toast-border-radius};
--#{$prefix}toast-box-shadow: #{$toast-box-shadow};
--#{$prefix}toast-header-color: #{$toast-header-color};
--#{$prefix}toast-header-bg: #{$toast-header-background-color};
--#{$prefix}toast-header-border-color: #{$toast-header-border-color};

Sass 变量

scss/_variables.scss

$toast-max-width:                   350px;
$toast-padding-x:                   .75rem;
$toast-padding-y:                   .5rem;
$toast-font-size:                   .875rem;
$toast-color:                       null;
$toast-background-color:            rgba(var(--#{$prefix}body-bg-rgb), .85);
$toast-border-width:                var(--#{$prefix}border-width);
$toast-border-color:                var(--#{$prefix}border-color-translucent);
$toast-border-radius:               var(--#{$prefix}border-radius);
$toast-box-shadow:                  var(--#{$prefix}box-shadow);
$toast-spacing:                     $container-padding-x;

$toast-header-color:                var(--#{$prefix}secondary-color);
$toast-header-background-color:     rgba(var(--#{$prefix}body-bg-rgb), .85);
$toast-header-border-color:         $toast-border-color;

用法

通过 JavaScript 初始化 toasts：

const toastElList = document.querySelectorAll('.toast')
const toastList = [...toastElList].map(toastEl => new bootstrap.Toast(toastEl, option))

触发器

可以通过在 toast 中的按钮上的data-bs-dismiss属性来实现关闭，如下所示：

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

或在 toast 外部的按钮上，使用额外的data-bs-target，如下所示：

<button type="button" class="btn-close" data-bs-dismiss="toast" data-bs-target="#my-toast" aria-label="Close"></button>

选项

由于选项可以通过数据属性或 JavaScript 传递，因此您可以将选项名称附加到 data-bs-，如 data-bs-animation="{value}"。通过数据属性传递选项时，请确保将选项名称的大小写类型从“camelCase”更改为“kebab-case”。例如，使用data-bs-custom-class="beautifier"而不是data-bs-customClass="beautifier"。

从 Bootstrap 5.2.0 开始，所有组件都支持一个实验性保留数据属性data-bs-config，该属性可以将简单的组件配置作为 JSON 字符串。当元素具有 data-bs-config='{"delay":0, "title":123}' 和 data-bs-title="456" 属性时，最终的 title 值将为 456，单独的数据属性将覆盖 data-bs-config 上给出的值。此外，现有的数据属性能够容纳JSON值，如data-bs-delay='{"show":0,"hide":150}'。

名称	类型	默认值	描述
`animation`	boolean	`true`	将 CSS 淡入淡出过渡应用于Toast 。
`autohide`	boolean	`true`	延迟后自动隐藏Toast 。
`delay`	number	`5000`	在隐藏Toast 之前延迟（以毫秒为单位）。

方法

所有 API 方法都是异步的，并且会启动转换。 它们在转换开始后但在转换结束之前立即返回给调用方。此外，对转换组件的方法调用将被忽略。在我们的 JavaScript 文档中了解更多信息。

方法	描述
`dispose`	隐藏元素的Toast 。您的Toast 将保留在 DOM 上，但不会再显示。
`getInstance`	静态方法，允许您获取与DOM元素关联的Toast实例。例如：`const myToastEl = document.getElementById('myToastEl')` `const myToast = bootstrap.Toast.getInstance(myToastEl)` 返回一个 Bootstrap toast 实例。
`getOrCreateInstance`	静态方法，允许您获取与DOM元素关联的toast实例，或创建一个新的实例，以防它未初始化。 `const myToastEl = document.getElementById('myToastEl')` `const myToast = bootstrap.Toast.getOrCreateInstance(myToastEl)` 返回一个 Bootstrap toast 实例。
`hide`	隐藏元素的Toast 。在 Toast 实际隐藏之前（即在`hidden.bs.toast`事件发生之前）返回给调用方。如果将`autohide`设置为`false`，则必须手动调用此方法。
`isShown`	根据 Toast 的可见性状态返回布尔值。
`show`	显示元素的Toast 。在实际显示 Toast 之前（即在`shown.bs.toast` 事件发生之前）返回给调用方。您必须手动调用此方法，而不是显示您的 Toast。

事件

事件	描述
`hide.bs.toast`	调用`hide`实例方法后，将立即触发此事件。
`hidden.bs.toast`	当 Toast 完成对用户隐藏时，将触发此事件。
`show.bs.toast`	调用`show`实例方法时，此事件会立即触发。
`shown.bs.toast`	当 Toast 对用户可见时，将触发此事件。

const myToastEl = document.getElementById('myToast')
myToastEl.addEventListener('hidden.bs.toast', () => {
  // do something...
})