跳到主要内容
输入关键词开始搜索,↑ ↓ 选择,Enter 打开
没有找到匹配的文档

警告框

为典型用户操作提供有上下文的反馈信息,并使用有限但灵活的提醒消息。

层级:components

默认警报

警报可用于任何长度的文本,并且可以选择关闭按钮。警报设计用于使用主题颜色,但如果未应用主题颜色,也有中性色作为备用颜色。要进行内联关闭,请使用 alerts JavaScript 插件。

HTML
<div class="alert" role="alert">
  <p>A simple alert—check it out!</p>
</div>

变体

使用我们任何一种变体主题类来实现颜色模式适应的上下文样式。

HTML
<div class="alert theme-primary" role="alert">
  <p>A simple primary alert—check it out!</p>
</div>
<div class="alert theme-accent" role="alert">
  <p>A simple accent alert—check it out!</p>
</div>
<div class="alert theme-success" role="alert">
  <p>A simple success alert—check it out!</p>
</div>
<div class="alert theme-danger" role="alert">
  <p>A simple danger alert—check it out!</p>
</div>
<div class="alert theme-warning" role="alert">
  <p>A simple warning alert—check it out!</p>
</div>
<div class="alert theme-info" role="alert">
  <p>A simple info alert—check it out!</p>
</div>
<div class="alert theme-inverse" role="alert">
  <p>A simple inverse alert—check it out!</p>
</div>
<div class="alert theme-secondary" role="alert">
  <p>A simple secondary alert—check it out!</p>
</div>
可访问性提示:使用颜色传达含义

仅使用颜色来增加意义只提供视觉提示,这不会传达给使用辅助技术(如屏幕阅读器)的用户。请确保意义从内容本身即可明显体现(例如,可见的文本以及 足够的 颜色对比) 或通过替代方式包含,例如通过隐藏的附加文本 .visually-hidden 班级

现场示例

点击下面的按钮显示一个警告(初始使用内联样式隐藏),然后使用内置的关闭按钮将其关闭(并销毁)。

HTML
<div id="liveAlertPlaceholder"></div>
<button type="button" class="btn-solid theme-primary flex-grow-0" id="liveAlertBtn">Show live alert</button>

我们使用以下 JavaScript 来触发我们的实时警报演示:

const alertPlaceholder = document.getElementById('liveAlertPlaceholder')
const appendAlert = (message, type) => {
  const wrapper = document.createElement('div')
  wrapper.innerHTML = [
    `<div class="alert theme-${type}" role="alert">`,
    `   <p>${message}</p>`,
    '   <button type="button" class="btn-close ms-auto" data-bs-dismiss="alert" aria-label="关闭"></button>',
    '</div>'
  ].join('')

  alertPlaceholder.append(wrapper)
}

const alertTrigger = document.getElementById('liveAlertBtn')
if (alertTrigger) {
  alertTrigger.addEventListener('click', () => {
    appendAlert('Nice, you triggered this alert message!', 'success')
  })
}

使用 .alert-link 工具类,在任何警报中快速提供匹配颜色的链接。

HTML
<div class="alert theme-primary" role="alert">
  <p>A simple primary alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-accent" role="alert">
  <p>A simple accent alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-success" role="alert">
  <p>A simple success alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-danger" role="alert">
  <p>A simple danger alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-warning" role="alert">
  <p>A simple warning alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-info" role="alert">
  <p>A simple info alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-inverse" role="alert">
  <p>A simple inverse alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>
<div class="alert theme-secondary" role="alert">
  <p>A simple secondary alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.</p>
</div>

附加内容

警报还可以包含其他 HTML 元素,如标题、段落和分隔符。

HTML
<div class="alert theme-success" role="alert">
  <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>

带图标

同样,你可以使用 Flexbox 工具 和 Bootstrap 图标 来创建带图标的警告。根据你的图标和内容,你可能需要添加更多的工具类或自定义样式。

HTML
<div class="alert theme-primary d-flex align-items-center" role="alert">
  <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>

解雇

使用 alert JavaScript 插件,可以内联关闭任何警报。方法如下:

  • 确保你已加载警告插件或已编译的 Bootstrap JavaScript。
  • 添加一个 关闭按钮 并使用 flexbox 工具(例如 ms-auto)将其定位在警告中。
  • 在关闭按钮上,添加 data-bs-dismiss="alert" 属性,该属性会触发 JavaScript 功能。确保与其一起使用 <button> 元素,以便在所有设备上实现正确行为。

警报在被移除之前会淡出。插件会为过渡时间添加.hiding,因此你的标记中不需要额外的类。要立即移除警报,请添加.alert-instant。有关调整淡出的标记,请参见 过渡。

你可以通过实时演示看到其效果:

HTML
<div class="alert theme-warning" role="alert">
  <p>Something’s wrong, check the fields below and try again.</p>
  <button type="button" class="btn-close ms-auto" data-bs-dismiss="alert" aria-label="关闭"></button>
</div>

当警报被关闭时,该元素会完全从页面结构中移除。如果键盘用户使用关闭按钮关闭警报,他们的焦点会突然丢失,并且根据浏览器的不同,焦点可能会重置到页面/文档的开头。因此,我们建议包含额外的 JavaScript 来监听 closed.bs.alert 事件,并以编程方式将 focus() 设置到页面中最合适的位置。如果你计划将焦点移动到通常不会接收焦点的非交互式元素,请确保向该元素添加 tabindex="-1"。

CSS

变量

警报在.alert上使用本地 CSS 变量以进行实时自定义。CSS 变量的值是从每个组件独有的 Sass map生成的,并应用于上述类。

// stylelint-disable-next-line scss/dollar-variable-default
$alert-tokens: defaults(
  (
    --alert-gap: var(--spacer-3),
    --alert-bg: var(--bg-1),
    --alert-padding-x: var(--spacer),
    --alert-padding-y: var(--spacer),
    --alert-color: inherit,
    --alert-border-color: var(--border-color),
    --alert-border-radius: var(--radius-7),
    --alert-link-color: inherit,
    --alert-transition-property: "opacity",
    --alert-transition-duration: .15s,
    --alert-transition-timing: linear,
    --hr-border-color: var(--theme-border, var(--alert-border-color)),
  ),
  $alert-tokens
);

Sass 循环

生成修改器类的循环,并覆盖 CSS 变量。

JavaScript 行为

初始化

将元素初始化为警报

JavaScript
          const alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new bootstrap.Alert(element))
        

仅为了关闭警报,不需要通过 JS API 手动初始化组件。通过使用 data-bs-dismiss="alert",组件将会自动初始化并被正确关闭。

有关更多详细信息,请参见 触发器 部分。

通过数据属性

属性描述
data-bs-dismiss="alert"在关闭控件上,激活时会关闭(并移除)警报。

触发因素

可以通过在按钮上使用data-bs-dismiss属性来实现关闭 在警报内,如下所示:

HTML
<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="关闭"></button>

或者在警报 外部的按钮 上使用额外的 data-bs-target,如下所示:

HTML
<button type="button" class="btn-close" data-bs-dismiss="alert" data-bs-target="#my-alert" aria-label="关闭"></button>

请注意,关闭警报将会将其从 DOM 中移除。

依赖项

如果你从源代码构建 Bootstrap 的 JS,警报插件需要以下 JavaScript 文件:

文件描述
js/src/alert.ts主要警报组件
js/src/base-component.ts基础组件类
js/src/dom/data.ts元素数据存储
js/src/dom/event-handler.ts事件处理工具
js/src/dom/manipulator.ts数据属性操作
js/src/dom/selector-engine.tsDOM选择器工具
js/src/util/component-functions.ts共享组件助手
js/src/util/config.ts配置基类
js/src/util/index.ts核心实用功能

方法

显示或隐藏组件的方法会返回一个 Promise。 当过渡结束时,该 Promise 会被解析,所以 await 会在 shown.bs.* 或 hidden.bs.* 监听器运行的同一时刻继续。方法仍会立即返回,并且永远不会阻塞调用者。对已在过渡中的组件进行调用不会有任何效果,并会立即解析。在我们的 JavaScript 文档中了解更多。

你可以使用警报构造函数创建一个警报实例,例如:

JavaScript
          const bsAlert = new bootstrap.Alert('#myAlert')
        

这使一个警报监听具有 data-bs-dismiss="alert" 属性的后代元素的点击事件。(在使用 data-api 的自动初始化时不必要。)

方法描述
close通过将警报从 DOM 中移除来关闭警报。警报会先淡出,除非它有 .alert-instant. 返回一个在警报被移除后解决的承诺 (即在……之后 closed.bs.alert 事件触发)。
dispose销毁元素的警告。(移除存储在 DOM 元素上的数据)
getInstance静态方法,允许你获取与 DOM 元素关联的警报实例。例如: bootstrap.Alert.getInstance(alert).
getOrCreateInstance静态方法,返回与 DOM 元素关联的警报实例,如果尚未初始化,则创建一个新的实例。你可以这样使用它: bootstrap.Alert.getOrCreateInstance(element).

基本用法:

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

事件

Bootstrap 的警报插件提供了一些事件,用于挂钩到警报功能。

事件描述
close.bs.alert在调用 close 实例方法时立即触发。
closed.bs.alert在警报关闭并且 CSS 过渡完成后触发。
JavaScript
          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()
})