JavaScript

使用我们可选的 JavaScript 插件让 Bootstrap 栩栩如生。了解每个插件、我们的数据和编程 API 选项等。

在本页

个人或编译

插件可以单独包含（使用 Bootstrap 独立的 js/dist/*.js），或者一次使用bootstrap.js或压缩版bootstrap.min.js（不要同时包含两者）。

如果您使用打包器（Webpack、Parcel、Vite……），您可以使用支持/js/dist/*.jsUMD 的文件。

与 JavaScript 框架一起使用

虽然 Bootstrap CSS 可以与任何框架一起使用，但 Bootstrap JavaScript 并不完全兼容 React、Vue 和 Angular 等。Bootstrap 和框架都可能尝试改变相同的 DOM 元素，从而导致诸如下拉菜单卡在“打开”位置的错误。

对于那些使用此类框架的人来说，更好的选择是使用特定于框架的包而不是Bootstrap JavaScript。以下是一些最受欢迎的选项：

React: React Bootstrap
Vue：BootstrapVue（目前只支持Vue 2和Bootstrap 4）
Angular: ng-bootstrap

使用 Bootstrap 作为模块

自己试试吧！从twbs/examples 存储库下载将 Bootstrap 用作 ES 模块的源代码和工作演示。您还可以在 StackBlitz 中打开示例。

我们提供构建为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>

与 JS 打包器相比，在浏览器中使用 ESM 需要您使用完整路径和文件名而不是模块名。阅读有关浏览器中 JS 模块的更多信息。这就是为什么我们使用'bootstrap.esm.min.js'而不是'bootstrap'上面的原因。但是，我们的 Popper 依赖项使这变得更加复杂，它将 Popper 导入到我们的 JavaScript 中，如下所示：

import * as Popper from "@popperjs/core"

如果您按原样尝试此操作，您将在控制台中看到如下错误：

Uncaught TypeError: Failed to resolve module specifier "@popperjs/core". Relative references must start with either "/", "./", or "../".

要解决此问题，您可以使用importmap来解析任意模块名称以完成路径。如果您的目标浏览器不支持importmap，您将需要使用es-module-shims项目。Bootstrap 和 Popper 的工作原理如下：

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
    <title>Hello, modularity!</title>
  </head>
  <body>
    <h1>Hello, modularity!</h1>
    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="ESM in Browser" data-bs-content="Bang!">Custom popover</button>

    <script async src="https://cdn.jsdelivr.net/npm/es-module-shims@1/dist/es-module-shims.min.js" crossorigin="anonymous"></script>
    <script type="importmap">
    {
      "imports": {
        "@popperjs/core": "https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js",
        "bootstrap": "https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.esm.min.js"
      }
    }
    </script>
    <script type="module">
      import * as bootstrap from 'bootstrap'

      new bootstrap.Popover(document.getElementById('popoverButton'))
    </script>
  </body>
</html>

依赖关系

一些插件和 CSS 组件依赖于其他插件。如果您单独包含插件，请确保在文档中检查这些依赖项。

我们的下拉菜单、弹出窗口和工具提示也依赖于Popper。

数据属性

几乎所有的 Bootstrap 插件都可以通过 HTML 单独启用和配置数据属性（我们使用 JavaScript 功能的首选方式）。确保只在单个元素上使用一组数据属性（例如，您不能从同一个按钮触发工具提示和模式。）

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

选择器

出于性能原因，我们使用本机querySelector和querySelectorAll方法来查询 DOM 元素，因此您必须使用有效的选择器。如果您使用像collapse:Example之类的特殊选择器，一定要将它们转义。

事件

Bootstrap 为大多数插件的独特操作提供自定义事件。通常，这些以不定式和过去分词形式出现 - 其中不定式（例如show）在事件开始时触发，其过去分词形式（例如shown）在动作完成时触发。

所有不定式事件都提供preventDefault()功能。这提供了在开始之前停止执行动作的能力。从事件处理程序返回 false 也会自动调用preventDefault().

const myModal = document.querySelector('#myModal')

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

程序化API

所有构造函数都接受一个可选的选项对象或什么都不接受（它以其默认行为启动一个插件）：

const myModalEl = document.querySelector('#myModal')
const modal = new bootstrap.Modal(myModalEl) // initialized with defaults

const configObject = { keyboard: false }
const modal1 = new bootstrap.Modal(myModalEl, configObject) // initialized with no keyboard

如果你想获得一个特定的插件实例，每个插件都会公开一个getInstance方法。例如，要直接从元素中检索实例：

bootstrap.Popover.getInstance(myPopoverEl)

如果未在请求的元素上启动实例，则此方法将返回null。

或者，getOrCreateInstance可用于获取与 DOM 元素关联的实例，或创建一个新实例以防未初始化。

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

如果一个实例没有被初始化，它可以接受并使用一个可选的配置对象作为第二个参数。

构造函数中的 CSS 选择器

除了getInstance和getOrCreateInstance方法之外，所有插件构造函数都可以接受 DOM 元素或有效的CSS 选择器作为第一个参数。由于我们的插件仅支持单个元素，因此使用该querySelector方法可以找到插件元素。

const modal = new bootstrap.Modal('#myModal')
const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')
const offcanvas = bootstrap.Offcanvas.getInstance('#myOffcanvas')
const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')

异步函数和转换

所有编程 API 方法都是异步的，一旦转换开始就会在结束之前返回给调用者。为了在转换完成后执行一个动作，您可以监听相应的事件。

const myCollapseEl = document.querySelector('#myCollapse')

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

此外，将忽略对正在转换的组件的方法调用。

const myCarouselEl = document.querySelector('#myCarousel')
const carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance

myCarouselEl.addEventListener('slid.bs.carousel', 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 !!

`dispose`方法

虽然在hide()之后立即使用该dispose方法似乎是正确的，但它会导致不正确的结果。这是问题使用的示例：

const myModal = document.querySelector('#myModal')
myModal.hide() // it is asynchronous

myModal.addEventListener('shown.bs.hidden', event => {
  myModal.dispose()
})

默认设置

您可以通过修改插件的Constructor.Default对象来更改插件的默认设置：

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

方法和属性

每个 Bootstrap 插件都公开了以下方法和静态属性。

方法	描述
`dispose`	销毁元素的模态。（删除存储在 DOM 元素上的数据）
`getInstance`	允许您获取与 DOM 元素关联的模态实例的静态方法。
`getOrCreateInstance`	允许您获取与 DOM 元素关联的模态实例的静态方法，或者创建一个新实例以防未初始化。

静态属性	描述
`NAME`	返回插件名称。（例如`bootstrap.Tooltip.NAME`：）
`VERSION`	可以通过`VERSION`插件构造函数的属性访问每个 Bootstrap 插件的版本（示例`bootstrap.Tooltip.VERSION`：）

Sanitizer

工具提示和弹出窗口使用我们内置的清理器来清理接受 HTML 的选项。

默认allowList值如下：

const ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
const 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您可以执行以下操作：

const 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
const myCustomRegex = /^data-my-app-[\w-]+/
myDefaultAllowList['*'].push(myCustomRegex)

如果您想绕过我们的Sanitizer，因为您更喜欢使用专用库，例如 DOMPurify，您应该执行以下操作：

const yourTooltipEl = document.querySelector('#yourTooltip')
const tooltip = new bootstrap.Tooltip(yourTooltipEl, {
  sanitizeFn(content) {
    return DOMPurify.sanitize(content)
  }
})

可选择使用 jQuery

在 Bootstrap 5 中您不需要 jQuery，但仍然可以将我们的组件与 jQuery 一起使用。如果 Bootstrap在window对象中检测到jQuery，它会将我们所有的组件添加到 jQuery 的插件系统中。这允许您执行以下操作：

// to enable tooltips with the default configuration
$('[data-bs-toggle="tooltip"]').tooltip()

// to initialize tooltips with given configuration
$('[data-bs-toggle="tooltip"]').tooltip({
  boundary: 'clippingParents',
  customClass: 'myClass'
})

// to trigger the `show` method
$('#myTooltip').tooltip('show')

我们的其他组件也是如此。

无冲突

有时需要将 Bootstrap 插件与其他 UI 框架一起使用。在这些情况下，名称空间冲突偶尔会发生。如果发生这种情况，您可以调用.noConflict您希望恢复其值的插件。

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

Bootstrap 不正式支持第三方 JavaScript 库，例如 Prototype 或 jQuery UI。尽管有.noConflict命名空间事件，但可能存在需要您自己修复的兼容性问题。

jQuery 事件

Bootstrap 会检测到 jQuery，如果window对象中存在jQuery并且<body>没有设置data-bs-no-jquery属性。如果找到 jQuery，Bootstrap 将通过 jQuery 的事件系统发出事件。所以如果你想监听 Bootstrap 的事件，你必须使用 jQuery 方法 ( .on, .one) 而不是addEventListener.

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

禁用的 JavaScript

当 JavaScript 被禁用时，Bootstrap 的插件没有特殊的回退。如果您关心这种情况下的用户体验，请使用<noscript>向您的用户解释情况（以及如何重新启用 JavaScript），或添加您自己的自定义后备。