在GitHub上查看

弹出模态框

使用Bootstrap的JavaScript模式插件将对话框添加到站点中,用于lightbox、用户通知或完全自定义的内容。

工作原理

在开始使用引导模式组件之前,请务必阅读以下内容,因为我们的菜单选项最近发生了变化。

  • Modals是用HTML、CSS和JavaScript构建的。它们被放置在文档中的所有其他内容之上,并从 <body> 中删除scroll,这样模态内容就可以滚动了。
  • 点击模态“背景”将自动关闭模态。
  • Bootstrap一次只支持一个模式窗口。我们不支持嵌套的modals,因为我们认为它们是糟糕的用户体验。
  • Modals使用 position: fixed,这有时对其渲染有点特殊。只要可能,请将模态HTML放在顶层位置,以避免来自其他元素的潜在干扰。在另一个固定元素中嵌套 .modal 时,可能会遇到问题。
  • 同样,由于 position: fixed,在移动设备上使用modals有一些注意事项。有关详细信息,请参阅我们的浏览器支持文档
  • 由于HTML5如何定义它的语义, autofocus HTML属性 在Bootstrap模式中没有作用。要获得相同的效果,请使用一些自定义JavaScript:
var myModal = document.getElementById('myModal')
var myInput = document.getElementById('myInput')

myModal.addEventListener('shown.bs.modal', function () {
myInput.focus()
})
组件的动画效果取决于 prefers-reduced-motion 媒体查询。请参阅辅助功能文档中的“简化运动”部分

继续阅读有关演示和使用指南。

示例

下面是一个静态模态示例(表示其 positiondisplay 已被覆盖)。包括模态页眉,模态主体(必需 padding)和模态页脚(可选)。我们要求您在可能的情况下在模式标头中包含dismiss操作,或提供另一个显式的dismiss操作。

<div class="modal" tabindex="-1">
<div class="modal-dialog">
<div class="modal-content">
  <div class="modal-header">
    <h5 class="modal-title">Modal title</h5>
    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
  </div>
  <div class="modal-body">
    <p>Modal body text goes here.</p>
  </div>
  <div class="modal-footer">
    <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
    <button type="button" class="btn btn-primary">Save changes</button>
  </div>
</div>
</div>
</div>

在线演示

通过单击下面的按钮来切换工作模式演示。它将向下滑动并从页面顶部淡入。

<!-- Button trigger modal -->
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal">
Launch demo modal
</button>

<!-- Modal -->
<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
  <div class="modal-header">
    <h5 class="modal-title" id="exampleModalLabel">Modal title</h5>
    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
  </div>
  <div class="modal-body">
    ...
  </div>
  <div class="modal-footer">
    <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
    <button type="button" class="btn btn-primary">Save changes</button>
  </div>
</div>
</div>
</div>

固定背景

当背景设置为静态时,在其外部单击时,模式不会关闭。单击下面的按钮尝试。

<!-- Button trigger modal -->
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#staticBackdrop">
Launch static backdrop modal
</button>

<!-- Modal -->
<div class="modal fade" id="staticBackdrop" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
  <div class="modal-header">
    <h5 class="modal-title" id="staticBackdropLabel">Modal title</h5>
    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
  </div>
  <div class="modal-body">
    ...
  </div>
  <div class="modal-footer">
    <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
    <button type="button" class="btn btn-primary">Understood</button>
  </div>
</div>
</div>
</div>

可滚动模态框

当模式对于用户的视口或设备而言变得太长时,它们将独立于页面本身滚动。请尝试下面的演示,以了解我们的意思。

您还可以创建一个可滚动的模式,通过添加.modal-dialog-scrollable.modal-dialog允许滚动模式的身体 。

<!-- Scrollable modal -->
<div class="modal-dialog modal-dialog-scrollable">
...
</div>

垂直居中

将模态添加 .modal-dialog-centered.modal-dialog 垂直居中。

<!-- Vertically centered modal -->
<div class="modal-dialog modal-dialog-centered">
...
</div>

<!-- Vertically centered scrollable modal -->
<div class="modal-dialog modal-dialog-centered modal-dialog-scrollable">
...
</div>

提示工具和弹窗

可以根据需要将提示工具 弹出窗口放置在模态中。关闭模态后,其中的所有提示工具和弹出窗口也将自动关闭。

<div class="modal-body">
<h5>Popover in a modal</h5>
<p>This <a href="#" role="button" class="btn btn-secondary popover-test" title="Popover title" data-bs-content="Popover body content is set in this attribute.">button</a> triggers a popover on click.</p>
<hr>
<h5>Tooltips in a modal</h5>
<p><a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> have tooltips on hover.</p>
</div>

与栅格系统相结合

通过嵌套 .container-fluid 在模态中利用Bootstrap网格系统 .modal-body。然后,像在其他任何地方一样使用普通的网格系统类。

<div class="modal-body">
<div class="container-fluid">
<div class="row">
  <div class="col-md-4">.col-md-4</div>
  <div class="col-md-4 ms-auto">.col-md-4 .ms-auto</div>
</div>
<div class="row">
  <div class="col-md-3 ms-auto">.col-md-3 .ms-auto</div>
  <div class="col-md-2 ms-auto">.col-md-2 .ms-auto</div>
</div>
<div class="row">
  <div class="col-md-6 ms-auto">.col-md-6 .ms-auto</div>
</div>
<div class="row">
  <div class="col-sm-9">
    Level 1: .col-sm-9
    <div class="row">
      <div class="col-8 col-sm-6">
        Level 2: .col-8 .col-sm-6
      </div>
      <div class="col-4 col-sm-6">
        Level 2: .col-4 .col-sm-6
      </div>
    </div>
  </div>
</div>
</div>
</div>

设置模态内容

是否有一堆按钮都以相同的内容触发相同的模式?使用 event.relatedTargetHTML data-bs-* 属性可根据单击哪个按钮来更改模式的内容。

下面是一个实时演示,后面是示例HTML和JavaScript。有关更多信息,请 阅读模态事件文档以获取有关的详细信息 relatedTarget

<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@mdo">Open modal for @mdo</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@fat">Open modal for @fat</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@getbootstrap">Open modal for @getbootstrap</button>

<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
  <div class="modal-header">
    <h5 class="modal-title" id="exampleModalLabel">New message</h5>
    <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
  </div>
  <div class="modal-body">
    <form>
      <div class="mb-3">
        <label for="recipient-name" class="col-form-label">Recipient:</label>
        <input type="text" class="form-control" id="recipient-name">
      </div>
      <div class="mb-3">
        <label for="message-text" class="col-form-label">Message:</label>
        <textarea class="form-control" id="message-text"></textarea>
      </div>
    </form>
  </div>
  <div class="modal-footer">
    <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
    <button type="button" class="btn btn-primary">Send message</button>
  </div>
</div>
</div>
</div>
var exampleModal = document.getElementById('exampleModal')
exampleModal.addEventListener('show.bs.modal', function (event) {
// Button that triggered the modal
  var button = event.relatedTarget
// Extract info from data-bs-* attributes
  var recipient = button.getAttribute('data-bs-whatever')
// If necessary, you could initiate an AJAX request here
  // and then do the updating in a callback.
  //
  // Update the modal's content.
  var modalTitle = exampleModal.querySelector('.modal-title')
var modalBodyInput = exampleModal.querySelector('.modal-body input')

modalTitle.textContent = 'New message to ' + recipient
modalBodyInput.value = recipient
})

改变动画

这个 $modal-fade-transform 变量确定 .modal-dialog 模态淡入动画之前的变换状态,这个 $modal-show-transform 变量确定 .modal-dialog 模态淡入动画结束时的变换。

例如,如果要放大动画,可以设置 $modal-fade-transform: scale(.8)

移除动画

对于仅显示而不是淡入显示的模态,请从模态标记中删除 .fade

<div class="modal" tabindex="-1" aria-labelledby="..." aria-hidden="true">
...
</div>

动态高度

如果模态的高度在打开时发生变化,则应调用 myModal.handleUpdate() 来重新调整模态的位置,以防出现滚动条。

辅助功能

确保将 aria-labelledby="..." 引用模式标题添加到中 .modal。另外,您可以使用 aria-describedby 来描述模态对话框 .modal。请注意,您不需要添加, role="dialog" 因为我们已经通过JavaScript添加了它。

嵌入YouTube视频

将YouTube视频嵌入模态中需要使用Bootstrap中没有的其他JavaScript才能自动停止播放等等。有关更多信息,请参见这篇有用的Stack Overflow帖子

可选大小

模态具有三种可选大小,可通过放置在上的修饰符类获得 .modal-dialog。这些大小会在某些断点处插入,以避免在较窄的视口上出现水平滚动条。

尺寸 Modal 最大宽度
.modal-sm 300px
默认 None 500px
.modal-lg 800px
超大 .modal-xl 1140px

我们不带修饰符类别的默认模态构成“中等”尺寸模态。

<div class="modal-dialog modal-xl">...</div>
<div class="modal-dialog modal-lg">...</div>
<div class="modal-dialog modal-sm">...</div>

全屏模式

另一个替代方法是弹出包含用户视口的模态的选项,可通过放置在上的修饰符类来使用 .modal-dialog

类型 可利用性
.modal-fullscreen 总是
.modal-fullscreen-sm-down 低于 576px
.modal-fullscreen-md-down 低于 768px
.modal-fullscreen-lg-down 低于 992px
.modal-fullscreen-xl-down 低于 1200px
.modal-fullscreen-xxl-down 低于 1400px
<!-- Full screen modal -->
<div class="modal-dialog modal-fullscreen-sm-down">
...
</div>

用法

模态插件通过数据属性或JavaScript按需切换隐藏的内容。它还会添加 .modal-open<body> 以覆盖默认的滚动行为,并生成一个, .modal-backdrop 以提供单击区域,以在模态外部单击时关闭显示的模态。

通过数据属性

无需编写JavaScript即可激活模式。设置 data-bs-toggle="modal" 的控制器元件上,像一个按钮,以及一个 data-bs-target="#foo"href="#foo",指定特定模态切换。

<button type="button" data-bs-toggle="modal" data-bs-target="#myModal">Launch modal</button>

通过JavaScript

用一行JavaScript创建一个模态:

var myModal = new bootstrap.Modal(document.getElementById('myModal'), options)

选项

可以通过数据属性或JavaScript传递选项。对于数据属性,将选项名称附加到中 data-bs-,如中所示 data-bs-backdrop=""

名字 类型 默认 描述
backdrop boolean or the string 'static' true 包括一个模式背景元素。或者,指定static 不关闭点击模式的背景。
keyboard boolean true 按下退出键时关闭模式
focus boolean true 初始化时将重点放在模态上。

方法

异步方法和转换

所有API方法都是异步的,并开始过渡。一旦转换开始但在转换结束之前,它们将返回给呼叫者。另外,在过渡组件上的方法调用将被忽略

有关更多信息,请参见我们的JavaScript文档。

传递选项

将您的内容激活为模式。 接受一个可选的 object 对象。

var myModal = new bootstrap.Modal(document.getElementById('myModal'), {
keyboard: false
})

切换

手动切换模态。 在实际显示或隐藏模式之前 (即在 shown.bs.modal 或者 hidden.bs.modal 事件发生之前)返回调用方.

myModal.toggle()

显示

手动打开模式文件。 在模式实际显示之前(即在 shown.bs.modal 事件发生之前)。

myModal.show()

隐藏

手动隐藏模式。在实际隐藏模式之前(即 hidden.bs.modal 事件发生之前)返回调用方。

myModal.hide()

手动更新

如果模态的高度在打开时发生变化,则手动重新调整模态的位置(即,如果出现滚动条)。

myModal.handleUpdate()

处置

销毁元素的模态。(删除DOM元素上存储的数据)

myModal.dispose()

获取实例

允许您获取与DOM元素关联的模式实例的静态方法

var myModalEl = document.getElementById('myModal')
var modal = bootstrap.Modal.getInstance(myModalEl) // Returns a Bootstrap modal instance

事件

Bootstrap的modal类公开了一些事件,用于连接到modal功能。所有模态事件都在模态本身触发(即在 <div class="modal">)。

事件类型 描述
show.bs.modal show 调用实例方法时,将立即触发此事件。如果是由单击引起的,则clicked元素可用作 relatedTarget 事件的属性。
shown.bs.modal 当模式对用户可见时将触发此事件(将等待CSS转换完成)​​。如果是由单击引起的,则clicked元素可用作 relatedTarget 事件的属性。
hide.bs.modal 调用 hide 实例后,将立即触发此事件。
hidden.bs.modal 在向用户隐藏模式后,将触发此事件(将等待CSS转换完成)​​。
hidePrevented.bs.modal 当显示模态时显示此事件,其背景为, static 并在模态外部单击或使用键盘选项或 data-bs-keyboard 将设置为来执行退出键 false
var myModalEl = document.getElementById('myModal')
myModalEl.addEventListener('hidden.bs.modal', function (event) {
// do something...
})