模态（Modal）

使用 Bootstrap 的 JavaScript 模式插件将对话框添加到您的网站，用于灯箱、用户通知或完全自定义的内容。

当前页

工作原理

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

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

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

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

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

Keep reading for demos and usage guidelines.

示例

模态组件

下面是一个 static 模态示例（意味着它的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>

工具提示和弹出框

工具提示和 popovers 可以根据需要放置在模态中。关闭模态时，也会自动关闭其中的任何工具提示和弹出框。

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

使用网格

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

<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 和 HTML data-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>

Change animation

$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。此外，您可以在“.modal”上使用aria-describedby 描述您的模态对话框。请注意，您不需要添加role="dialog" ，因为我们已经通过JavaScript添加了它。

嵌入优酷视频

在模态中嵌入YouTube视频需要额外的JavaScript而不是在Bootstrap中自动停止播放等等。请参阅这篇有用的堆栈溢出帖子了解更多信息。

可选尺寸

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

Size	Class	Modal max-width
Small	`.modal-sm`	`300px`
Default	None	`500px`
Large	`.modal-lg`	`800px`
Extra large	`.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`	Always
`.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

变量

Added in v5.2.0

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

scss/_modal.scss

--#{$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};

scss/_modal.scss

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

Sass 变量

scss/_variables.scss

$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);

Sass loop

响应式全屏模式通过$breakpoints映射和scss/_modal.scss中的循环生成。

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>

解除（Dismiss）

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

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

或在 modal 外部的按钮上，使用额外的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`	boolean, `'static'`	`true`	包括一个模态背景元素。或者，为单击时不会关闭模式的背景指定`static`。
`focus`	boolean	`true`	初始化时将焦点放在模式上。
`keyboard`	boolean	`true`	按下转义键时关闭模式。

方法

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

传递选项

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

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

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

事件

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

事件	Desciptio描述n
`hide.bs.modal`	调用 `hide`实例方法后，将立即触发此事件。
`hidden.bs.modal`	当模态完成对用户隐藏时，将触发此事件（将等待 CSS 转换完成）。
`hidePrevented.bs.modal`	当显示模态时，将触发此事件，其背景为`static`，并在模态外部执行单击。当按下 esc 键并将`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...
})