模态对话框

使用 Bootstrap 的 JavaScript 模态插件将对话框添加到您的站点以获取lightboxes、用户通知或完全自定义的内容。

在此页

怎么运行的

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

模态对话框是用 HTML、CSS 和 JavaScript 构建的。它们位于文档中的所有其他内容之上，并从<body>中删除滚动，以便模态内容滚动。
单击模态“背景”将自动关闭模态。
Bootstrap 一次只支持一个模态窗口。不支持嵌套模态对话框，因为我们认为它们是糟糕的用户体验。
模态对话框使用position: fixed，有时它的渲染可能有点特别。只要有可能，将模态 HTML 放在顶级位置，以避免受到其他元素的潜在干扰。在另一个固定元素中嵌套.modal时，您可能会遇到问题。
再一次，由于position: fixed，在移动设备上使用模态对话框有一些注意事项。有关详细信息，请参阅我们的浏览器支持文档。
由于 HTML5 定义其语义的方式， autofocusHTML 属性在 Bootstrap 模态对话框中无效。要达到相同的效果，请使用一些自定义 JavaScript：

const myModal = document.getElementById('myModal')
const myInput = document.getElementById('myInput')

myModal.addEventListener('shown.bs.modal', () => {
  myInput.focus()
})

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

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

例子

下面是一个静态模态示例（意味着它的position和display已经被覆盖）。包括模态页眉、模态正文（必需的，用于padding）和模态页脚（可选）。我们要求您尽可能在模态标题中包含关闭操作，或者提供另一个明确的关闭操作。

<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>

在上面的静态示例中，我们使用<h5>, 来避免文档页面中的标题层次结构出现问题。然而，在结构上，模态对话框代表它自己独立的文档/上下文，因此.modal-title理想情况下应该是一个<h1>. 如有必要，您可以使用字体大小实用程序来控制标题的外观。以下所有实例都使用了这种方法。

实时演示

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

<!-- 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">
        <h1 class="modal-title fs-5" id="exampleModalLabel">Modal title</h1>
        <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">
        <h1 class="modal-title fs-5" id="staticBackdropLabel">Modal title</h1>
        <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">
  <h2 class="fs-5">Popover in a modal</h2>
  <p>This <button class="btn btn-secondary" data-bs-toggle="popover" title="Popover title" data-bs-content="Popover body content is set in this attribute.">button</button> triggers a popover on click.</p>
  <hr>
  <h2 class="fs-5">Tooltips in a modal</h2>
  <p><a href="#" data-bs-toggle="tooltip" title="Tooltip">This link</a> and <a href="#" data-bs-toggle="tooltip" title="Tooltip">that link</a> have tooltips on hover.</p>
</div>

使用网格

通过嵌套.container-fluid在.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.relatedTarget和HTMLdata-bs-*属性根据单击的按钮改变模态对话框的内容。

下面是一个现场演示，后面是示例 HTML 和 JavaScript。有关详细信息，请阅读模态事件文档以了解有关relatedTarget.

HTML

<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">
        <h1 class="modal-title fs-5" id="exampleModalLabel">New message</h1>
        <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>

const exampleModal = document.getElementById('exampleModal')
exampleModal.addEventListener('show.bs.modal', event => {
  // Button that triggered the modal
  const button = event.relatedTarget
  // Extract info from data-bs-* attributes
  const 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.
  const modalTitle = exampleModal.querySelector('.modal-title')
  const modalBodyInput = exampleModal.querySelector('.modal-body input')

  modalTitle.textContent = `New message to ${recipient}`
  modalBodyInput.value = recipient
})

在对话框之间切换

通过巧妙地放置data-bs-target和data-bs-toggle属性在多个模态对话框之间切换。例如，您可以从已经打开的登录模态对话框中切换密码重置模态对话框。请注意，不能同时打开多个模态框——此方法只是在两个单独的模态框之间切换。

HTML

<div class="modal fade" id="exampleModalToggle" aria-hidden="true" aria-labelledby="exampleModalToggleLabel" tabindex="-1">
  <div class="modal-dialog modal-dialog-centered">
    <div class="modal-content">
      <div class="modal-header">
        <h1 class="modal-title fs-5" id="exampleModalToggleLabel">Modal 1</h1>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        Show a second modal and hide this one with the button below.
      </div>
      <div class="modal-footer">
        <button class="btn btn-primary" data-bs-target="#exampleModalToggle2" data-bs-toggle="modal">Open second modal</button>
      </div>
    </div>
  </div>
</div>
<div class="modal fade" id="exampleModalToggle2" aria-hidden="true" aria-labelledby="exampleModalToggleLabel2" tabindex="-1">
  <div class="modal-dialog modal-dialog-centered">
    <div class="modal-content">
      <div class="modal-header">
        <h1 class="modal-title fs-5" id="exampleModalToggleLabel2">Modal 2</h1>
        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
      </div>
      <div class="modal-body">
        Hide this modal and show the first with the button below.
      </div>
      <div class="modal-footer">
        <button class="btn btn-primary" data-bs-target="#exampleModalToggle" data-bs-toggle="modal">Back to first</button>
      </div>
    </div>
  </div>
</div>
<button class="btn btn-primary" data-bs-target="#exampleModalToggle" data-bs-toggle="modal">Open first modal</button>

淡入动画

$modal-fade-transform变量决定模态淡入动画前的变换状态，$modal-show-transform变量决定模态淡入动画结束时的变换。

例如，如果你想要一个放大动画，你可以设置$modal-fade-transform: scale(.8).

淡出动画

对于只是出现而不是淡入视图的模态对话框，请从模态对话框标记中删除.fade类。

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

动态高度

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

辅助功能

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

嵌入 YouTube 视频

在模态对话框中嵌入 YouTube 视频需要额外的 JavaScript，而不是在 Bootstrap 中自动停止播放等。有关详细信息，请参阅这篇有用的 Stack Overflow 帖子。

可选尺寸

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

尺寸	类	对话框最大宽度
小的	`.modal-sm`	`300px`
默认	没有	`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>

CSS

变量

添加于 v5.2.0

作为 Bootstrap 不断发展的 CSS 变量方法的一部分，模态对话框现在使用本地 CSS 变量.modal和.modal-backdrop增强实时定制。CSS 变量的值是通过 Sass 设置的，因此仍然支持 Sass 自定义。

  --#{$prefix}modal-zindex: #{$zindex-modal};
  --#{$prefix}modal-width: #{$modal-md};
  --#{$prefix}modal-padding: #{$modal-inner-padding};
  --#{$prefix}modal-margin: #{$modal-dialog-margin};
  --#{$prefix}modal-color: #{$modal-content-color};
  --#{$prefix}modal-bg: #{$modal-content-bg};
  --#{$prefix}modal-border-color: #{$modal-content-border-color};
  --#{$prefix}modal-border-width: #{$modal-content-border-width};
  --#{$prefix}modal-border-radius: #{$modal-content-border-radius};
  --#{$prefix}modal-box-shadow: #{$modal-content-box-shadow-xs};
  --#{$prefix}modal-inner-border-radius: #{$modal-content-inner-border-radius};
  --#{$prefix}modal-header-padding-x: #{$modal-header-padding-x};
  --#{$prefix}modal-header-padding-y: #{$modal-header-padding-y};
  --#{$prefix}modal-header-padding: #{$modal-header-padding}; // Todo in v6: Split this padding into x and y
  --#{$prefix}modal-header-border-color: #{$modal-header-border-color};
  --#{$prefix}modal-header-border-width: #{$modal-header-border-width};
  --#{$prefix}modal-title-line-height: #{$modal-title-line-height};
  --#{$prefix}modal-footer-gap: #{$modal-footer-margin-between};
  --#{$prefix}modal-footer-bg: #{$modal-footer-bg};
  --#{$prefix}modal-footer-border-color: #{$modal-footer-border-color};
  --#{$prefix}modal-footer-border-width: #{$modal-footer-border-width};

  --#{$prefix}backdrop-zindex: #{$zindex-modal-backdrop};
  --#{$prefix}backdrop-bg: #{$modal-backdrop-bg};
  --#{$prefix}backdrop-opacity: #{$modal-backdrop-opacity};

Sass 变量

$modal-inner-padding:               $spacer;

$modal-footer-margin-between:       .5rem;

$modal-dialog-margin:               .5rem;
$modal-dialog-margin-y-sm-up:       1.75rem;

$modal-title-line-height:           $line-height-base;

$modal-content-color:               null;
$modal-content-bg:                  var(--#{$prefix}body-bg);
$modal-content-border-color:        var(--#{$prefix}border-color-translucent);
$modal-content-border-width:        var(--#{$prefix}border-width);
$modal-content-border-radius:       var(--#{$prefix}border-radius-lg);
$modal-content-inner-border-radius: subtract($modal-content-border-radius, $modal-content-border-width);
$modal-content-box-shadow-xs:       $box-shadow-sm;
$modal-content-box-shadow-sm-up:    $box-shadow;

$modal-backdrop-bg:                 $black;
$modal-backdrop-opacity:            .5;

$modal-header-border-color:         var(--#{$prefix}border-color);
$modal-header-border-width:         $modal-content-border-width;
$modal-header-padding-y:            $modal-inner-padding;
$modal-header-padding-x:            $modal-inner-padding;
$modal-header-padding:              $modal-header-padding-y $modal-header-padding-x; // Keep this for backwards compatibility

$modal-footer-bg:                   null;
$modal-footer-border-color:         $modal-header-border-color;
$modal-footer-border-width:         $modal-header-border-width;

$modal-sm:                          300px;
$modal-md:                          500px;
$modal-lg:                          800px;
$modal-xl:                          1140px;

$modal-fade-transform:              translate(0, -50px);
$modal-show-transform:              none;
$modal-transition:                  transform .3s ease-out;
$modal-scale-transform:             scale(1.02);

循环

响应式全屏模态对话框是通过$breakpoints映射生成，在scss/_modal.scss.

@each $breakpoint in map-keys($grid-breakpoints) {
  $infix: breakpoint-infix($breakpoint, $grid-breakpoints);
  $postfix: if($infix != "", $infix + "-down", "");

  @include media-breakpoint-down($breakpoint) {
    .modal-fullscreen#{$postfix} {
      width: 100vw;
      max-width: none;
      height: 100%;
      margin: 0;

      .modal-content {
        height: 100%;
        border: 0;
        @include border-radius(0);
      }

      .modal-header,
      .modal-footer {
        @include border-radius(0);
      }

      .modal-body {
        overflow-y: auto;
      }
    }
  }
}

用法

模态插件通过数据属性或 JavaScript 按需切换隐藏内容。它还会覆盖默认滚动行为并生成一个.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>

关闭

关闭可以通过模态中的按钮data的属性来实现，如下所示：

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

或在模态外的按钮上使用data-bs-target如下所示：

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

虽然两种关闭模态的方法都受支持，但请记住，从模态外部关闭不符合ARIA 创作实践指南对话框（模态）模式。这样做需要您自担风险。

通过 JavaScript

使用一行 JavaScript 创建一个模态对话框：

const myModal = new bootstrap.Modal(document.getElementById('myModal'), options)
// or
const myModalAlternative = new bootstrap.Modal('#myModal', options)

选项

由于可以通过数据属性或 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}'.

名称	类型	默认	描述
`backdrop`	布尔值，`'static'`	`true`	包括模态背景元素。或者，指定`static`在单击时不关闭模态的背景。
`focus`	布尔值	`true`	初始化时将焦点放在模态上。
`keyboard`	布尔值	`true`	按下退出键时关闭模态对话框。

方法

异步方法和转换

所有 API 方法都是异步的并开始转换。它们会在转换开始但结束之前立即返回给调用者。此外，将忽略对转换组件的方法调用。

有关详细信息，请参阅我们的 JavaScript 文档。

传递选项

将您的内容激活为模态。接受一个可选的选项object。

const myModal = new bootstrap.Modal('#myModal', {
  keyboard: false
})

方法	描述
`dispose`	销毁元素的模态。（删除存储在 DOM 元素上的数据）
`getInstance`	允许您获取与 DOM 元素关联的模态实例的静态方法。
`getOrCreateInstance`	允许您获取与 DOM 元素关联的模态实例的静态方法，或者在未初始化的情况下创建一个新实例。
`handleUpdate`	如果模态框的高度在打开时发生变化（即出现滚动条），请手动重新调整模态框的位置。
`hide`	手动隐藏模态。在模态实际上被隐藏之前返回给调用者（即在`hidden.bs.modal`事件发生之前）。
`show`	手动打开模态对话框。在模态实际显示之前（即事件发生之前）返回给调用者。`shown.bs.modal`此外，您可以将 DOM 元素作为参数传递，该参数可以在模态事件中接收（作为`relatedTarget`属性）。（即`const modalToggle = document.getElementById('toggleMyModal'); myModal.show(modalToggle)`。
`toggle`	手动切换模态。在模态实际显示或隐藏之前返回给调用者（即在`shown.bs.modal`or`hidden.bs.modal`事件发生之前）。

事件

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

事件	描述
`hide.bs.modal`	`hide`调用实例方法时会立即触发此事件。
`hidden.bs.modal`	当模态对话框完成对用户隐藏时会触发此事件（将等待 CSS 转换完成）。
`hidePrevented.bs.modal`	当显示模态时会触发此事件，它的背景是`static`并且在模态之外执行单击。当按下转义键且`keyboard`选项设置为时，也会触发该事件`false`。
`show.bs.modal`	`show`调用实例方法时会立即触发此事件。如果是由单击引起的，则被单击的元素可用作`relatedTarget`事件的属性。
`shown.bs.modal`	当模态对话框对用户可见时会触发此事件（将等待 CSS 转换完成）。如果是由单击引起的，则被单击的元素可用作`relatedTarget`事件的属性。

const myModalEl = document.getElementById('myModal')
myModalEl.addEventListener('hidden.bs.modal', event => {
  // do something...
})