View on GitHub

JavaScript

用我們在 jQuery 上建置 JavaScript 插件將 Bootstrap 生動起來。瞭解每個外掛程式、資料和 API 以及更多的選項。

On this page

單獨或編譯

插件可以獨立的被加入（使用 Bootstrap 獨立的 js/dist/*.js）或是使用 bootstrap.js 或壓縮的 bootstrap.min.js（切勿同時插入這兩個檔案）將所有外掛程式一次性全部加入。

如果您使用 bundler (Webpack, Rollup…)，可以使用 UMD 就緒的 /js/dist/*.js 檔案。

使用 Bootstrap 作為模組

我們提供了一個建構為 ESM (bootstrap.esm.js 和 bootstrap.esm.min.js) 的 Bootstrap 版本，如果您的目標瀏覽器支援，則可以在瀏覽器中將 Bootstrap 作為模組使用。

<script type="module">
  import { Toast } from 'bootstrap.esm.min.js'

  Array.from(document.querySelectorAll('.toast'))
    .forEach(toastNode => new Toast(toastNode))
</script>

不兼容的插件

由於瀏覽器的限制，Bootstrap 的某些插件（即 Dropdown, Tooltip 和 Popover 插件）不能用在帶有 module 類型的 <script> 標籤中，因為它們依賴於Popper。有關此問題的更多資訊，請參見這裡。

相依外掛程式

某些外掛程式和 CSS 元件依賴於其他的插件。若你將外掛程式獨立加入，確保檢查文件中是否有上述的相依關係。

下拉式選單、工具提示及彈出提示框也同樣相依於 Popper。

是否可以繼續使用 jQuery? 這是有可能的!

Bootstrap 5 被設計成不需要使用 jQuery，但仍有機會將我們的元件與 jQuery 一起做使用。如果 Bootstrap 在 window 物件檢測到 jQuery，它將會把 Bootstrap 的所有元件加入 jQuery 的插件系統中；這意味著您將能夠用 $('[data-bs-toggle="tooltip"]').tooltip() 來啟用工具提示。我們的其他元件也是如此運作。

資料屬性 (Data attributes)

幾乎所有的 Bootstrap 插件都可以單獨透過 HTML 的資料屬性（我們偏好於用此方式使用 JavaScript 函式）來啟用和配置。務必在一個獨立的元素僅使用一套資料屬性（比如，你無法從同一個按鍵同時觸發一個工具提示和互動視窗）。

選擇器

目前為了查詢 DOM 元素，出於性能原因我們使用原生的方法 querySelector 和 querySelectorAll，因此你必須使用 valid selectors。如果使用特殊選擇器，例如： collapse:Example，請務必將它們轉義。

事件

Bootstrap 為大多數插件的特殊行為提供了自定義的事件。一般而言，事件都具有不定式和過去分詞的形式 - 其中不定式（比如 show）在事件開始時被觸發，其過去分詞形式（比如 shown）在某一動作完成時被觸發。

所有的不定式事件提供了 preventDefault() 的功能。這個功能讓某個動作開始前停止執行預設行為，從事件控制中的返回 false 也將自動調用 preventDefault()。

var myModal = document.getElementById('myModal')

myModal.addEventListener('show.bs.modal', function (event) {
  if (!data) {
    return event.preventDefault() // stops modal from being shown
  }
})

jQuery 事件

如果 jQuery 存在於 window 物件中，且沒有任何 data-bs-no-jquery 屬性被設置在 <body> 上，Bootstrap 將會去檢測 jQuery。如果 jQuery 被找到了，基於 jQuery 的事件系統 Bootstrap 將會發出事件。因此，如果想要監聽 Bootstrap 的事件，則必須使用 jQuery 的方法（.on， .one）而不是 addEventListener。

$('#myTab a').on('shown.bs.tab', function () {
  // do something...
})

程序化 API

所有建構式 (constructor) 都接受一個可選擇性的物件，或沒有任何內容（插件的預設行為）：

var myModalEl = document.getElementById('myModal')

var modal = new bootstrap.Modal(myModalEl) // initialized with defaults
var modal = new bootstrap.Modal(myModalEl, { keyboard: false }) // initialized with no keyboard

若你想獲得一個特定的插件實例，每一個插件都有公開一個 getInstance 的方法。為了直接從元素中檢索它，請執行這個操作：bootstrap.Popover.getInstance(myPopoverEl)。

CSS selectors in constructors

You can also use a CSS selector as the first argument instead of a DOM element to initialize the plugin. Currently the element for the plugin is found by the querySelector method since our plugins support a single element only.

var modal = new bootstrap.Modal('#myModal')
var dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')

非同步函式及轉換

所有程式的 API 方法都是非同步的，且會在轉換的一開始就回傳，並在轉換結束之前回傳完畢。

為了在轉換完成後執行動作，你可以監聽相應的事件。

var myCollapseEl = document.getElementById('#myCollapse')

myCollapseEl.addEventListener('shown.bs.collapse', function (event) {
  // Action to execute once the collapsible area is expanded
})

除此之外，轉換元件的方法調用將會被忽略

var myCarouselEl = document.getElementById('myCarousel')
var carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance

myCarouselEl.addEventListener('slid.bs.carousel', function (event) {
  carousel.to('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished
})

carousel.to('1') // Will start sliding to the slide 1 and returns to the caller
carousel.to('2') // !! Will be ignored, as the transition to the slide 1 is not finished !!

預設設定

你可以通過修改插件 Constructor.Default 物件，更改插件的預設設置。

// changes default for the modal plugin's `keyboard` option to false
bootstrap.Modal.Default.keyboard = false

無衝突 (只發生在使用 jQuery 的時候)

有時必須和其他 UI 框架一起使用 Bootstrap 插件。在此情形中，有時會出現命名空間的衝突。若出現此情況，你可以在意圖恢復其數值的插件上調用 .noConflict。

var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value
$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality

版本號

可以通過插件建構函式的 VERSION 屬性訪問每個 Bootstrap 的插件版本。比如，對工具提示插件：

bootstrap.Tooltip.VERSION // => "5.0.0"

當 JavaScript 禁用時無特殊回饋

當禁用 JavaScript 時，Bootstrap 的插件不會有特別回饋。若你擔心此等情況中的使用者體驗，使用 <noscript> 以向你的用戶解釋此情形（以及如何重啟 JavaScript 的方式）和/或添加你自己定義的回饋。

第三方函式庫

Bootstrap 不支持第三方 JavaScript 函式庫，如 Prototype 或 jQuery UI。儘管有 .noConflict 和命名空間的事件，還是可能會出現兼容性的問題，您需要自己修復。

清理工具 (Sanitizer)

工具提示和彈出視窗使用我們內置的清理工具來清理接受 HTML 的選項。

預設的 allowList 如下:

var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
var DefaultAllowlist = {
  // Global attributes allowed on any supplied element below.
  '*': ['class', 'dir', 'id', 'lang', 'role', ARIA_ATTRIBUTE_PATTERN],
  a: ['target', 'href', 'title', 'rel'],
  area: [],
  b: [],
  br: [],
  col: [],
  code: [],
  div: [],
  em: [],
  hr: [],
  h1: [],
  h2: [],
  h3: [],
  h4: [],
  h5: [],
  h6: [],
  i: [],
  img: ['src', 'srcset', 'alt', 'title', 'width', 'height'],
  li: [],
  ol: [],
  p: [],
  pre: [],
  s: [],
  small: [],
  span: [],
  sub: [],
  sup: [],
  strong: [],
  u: [],
  ul: []
}

如果要把新的值添加到預設的 allowList，則可以執行以下操作：

var myDefaultAllowList = bootstrap.Tooltip.Default.allowList

// To allow table elements
myDefaultAllowList.table = []

// To allow td elements and data-bs-option attributes on td elements
myDefaultAllowList.td = ['data-bs-option']

// You can push your custom regex to validate your attributes.
// Be careful about your regular expressions being too lax
var myCustomRegex = /^data-my-app-[\w-]+/
myDefaultAllowList['*'].push(myCustomRegex)

如果您因為喜歡使用專用函式庫（例如 DOMPurify）而想繞過我們的清理工具，則應執行以下操作：

var yourTooltipEl = document.getElementById('yourTooltip')
var tooltip = new bootstrap.Tooltip(yourTooltipEl, {
  sanitizeFn: function (content) {
    return DOMPurify.sanitize(content)
  }
})