跳到主要內容 跳到文檔導航
Check
in English

模態

使用 Bootstrap 的 JavaScript 模態插件向您的站點添加對話框,用於燈箱、用戶通知或完全自定義的內容。

這個怎麼運作

在開始使用 Bootstrap 的模態組件之前,請務必閱讀以下內容,因為我們的菜單選項最近發生了變化。

  • 模態框是用 HTML、CSS 和 JavaScript 構建的。它們位於文檔中的所有其他內容之上,並從中刪除滾動,<body>以便模態內容滾動。
  • 單擊模態“背景”將自動關閉模態。
  • Bootstrap 一次只支持一個模式窗口。不支持嵌套模式,因為我們認為它們是糟糕的用戶體驗。
  • 模態使用position: fixed,它的渲染有時可能有點特別。只要有可能,將您的模態 HTML 放在頂級位置,以避免來自其他元素的潛在干擾。.modal在另一個固定元素中嵌套 a 時,您可能會遇到問題。
  • 再一次,由於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媒體查詢。請參閱 我們可訪問性文檔的減少運動部分

繼續閱讀演示和使用指南。

例子

下面是一個靜態模態示例(意味著它的positiondisplay已被覆蓋)。包括模態標題、模態正文(需要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>

現場演示

通過單擊下面的按鈕來切換工作模式演示。它將向下滑動並從頁面頂部淡入。

<!-- 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" data-bs-toggle="popover" 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="#" 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.relatedTargetHTMLdata-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">
        <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>
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-targetdata-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">
        <h5 class="modal-title" id="exampleModalToggleLabel">Modal 1</h5>
        <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">
        <h5 class="modal-title" id="exampleModalToggleLabel2">Modal 2</h5>
        <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>
<a class="btn btn-primary" data-bs-toggle="modal" href="#exampleModalToggle" role="button">Open first modal</a>

更改動畫

變量決定模態淡入動畫前$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-describedbyon 來描述您的模態對話框.modal。請注意,您不需要添加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:                  $white;
$modal-content-border-color:        var(--#{$prefix}border-color-translucent);
$modal-content-border-width:        $border-width;
$modal-content-border-radius:       $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 Authoring Practices Guide dialog (modal) 模式不匹配。這樣做需要您自擔風險。

通過 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並且單獨的數據屬性將覆蓋給定的值 on 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 手動切換模式。在模態框實際顯示或隱藏之前(即在or事件發生之前)返回給調用者。shown.bs.modalhidden.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...
})