Bootstrap V5.3 : JavaScript 中文翻译版

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

单独或编译

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

如果您使用打包器（Webpack、Parcel、Vite等），则可以使用已准备好 UMD 的文件。/js/dist/*.js

与 JavaScript 框架一起使用

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

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

React：React Bootstrap自己试试吧！从 twbs/examples 存储库下载将 Bootstrap 与 React、Next.js 和 React Bootstrap 一起使用的源代码和工作演示。您还可以在 StackBlitz 中打开该示例。
Vue：BootstrapVue（Bootstrap 4）
Vue 3：BootstrapVueNext（Bootstrap 5，目前处于 alpha 阶段）
Angular：ng-bootstrap 或 ngx-bootstrap

将 Bootstrap 用作模块

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

我们提供了一个构建为（和）的 Bootstrap 版本，如果您的目标浏览器支持它，它允许您将 Bootstrap 用作浏览器中的模块。ESMbootstrap.esm.jsbootstrap.esm.min.js

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

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

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

import * as Popper from "@popperjs/core"

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

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

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

<!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/bootstrap@5.3.8/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-sRIl4kxILFvY47J16cr9ZwB07vP4J8+LH7qKQnuqkuIAvNWLzeN8tE5YBujZqJLB" crossorigin="anonymous">
    <title>Hello, modularity!</title>
  </head>
  <body>
    <h1>Hello, modularity!</h1>
    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" 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/core@2.11.8/dist/esm/popper.min.js",
        "bootstrap": "https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/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 传递，因此您可以将选项名称附加到，如。通过数据属性传递选项时，请确保将选项名称的大小写类型从“camelCase”更改为“kebab-case”。例如，使用代替。data-bs-data-bs-animation="{value}"data-bs-custom-class="beautifier"data-bs-customClass="beautifier"

从 Bootstrap 5.2.0 开始，所有组件都支持实验性保留数据属性，该属性可以将简单的组件配置作为 JSON 字符串容纳。当元素具有和属性时，最终值将是，并且单独的数据属性将覆盖上给出的值。此外，现有数据属性能够容纳 JSON 值，例如 .data-bs-configdata-bs-config='{"delay":0, "title":123}'data-bs-title="456"title456data-bs-configdata-bs-delay='{"show":0,"hide":150}'

最终配置对象是、的合并结果，其中最新给定的键值覆盖其他键值。data-bs-configdata-bs-js object

选择

出于性能原因，我们使用 native 和 methods 来查询 DOM 元素，因此您必须使用有效的选择器。如果您使用特殊的选择器，例如，请务必转义它们。querySelectorquerySelectorAllcollapse:Example

事件

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

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

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

myModal.addEventListener('show.bs.modal', event => {
  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

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

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

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

构造函数中的 CSS 选择器

除了 and 方法之外，所有插件构造函数都可以接受 DOM 元素或有效的 CSS 选择器作为第一个参数。插件元素是通过该方法找到的，因为我们的插件只支持单个元素。getInstancegetOrCreateInstancequerySelector

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`方法

虽然立即使用该方法似乎是正确的，但它会导致不正确的结果。下面是问题使用的示例：disposehide()

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`	每个 Bootstrap 插件的版本都可以通过插件构造函数的属性访问（示例：`VERSIONbootstrap.Tooltip.VERSION`)

液

我们的工具提示和弹出窗口组件能够将任意 HTML 呈现到页面（如果配置为这样做）。为了防止跨站脚本（XSS）攻击，这些组件使用我们的内置内容清理程序来清理任何接受 HTML 的选项，然后再将其呈现到页面。默认情况下，内容清理处于启用状态。

默认允许的标签和属性如下。在清理过程中，任何未明确允许的标记或属性都将被移除：

js/src/util/sanitizer.js

const ARIA_ATTRIBUTE_PATTERN = /^aria-[w-]*$/i

export 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: [],
  dd: [],
  div: [],
  dl: [],
  dt: [],
  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: []
}

使用这些高级选项时要小心。有关详细信息，请参阅 OWASP 的跨站点脚本预防备忘单。仅由禁用或修改内容清理引起的漏洞不被视为 Bootstrap 安全模型的范围内。

您可以向此默认值添加新值：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)

您还可以用专用库替换我们的清理器，例如 DOMPurify：

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

（可选）使用 jQuery

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

// 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 事件

如果对象中存在 jQuery 并且没有在上设置属性，Bootstrap 将检测 jQuery 。如果找到 jQuery，Bootstrap 将通过 jQuery 的事件系统发出事件。因此，如果您想监听 Bootstrap 的事件，则必须使用 jQuery 方法（，）而不是。jQuerywindowdata-bs-no-jquery<body>.on.oneaddEventListener

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

禁用的 JavaScript

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

Bootstrap V5.3 中文手册

入门指南 Getting started

定制化 Customize

布局方式 Layout

内容样式 Content

表单控件 Forms

组件集合 Components

辅助工具 Helpers

工具类库 Utilities

功能扩展 Extend

关于Bootstrap

JavaScript

单独或编译

与 JavaScript 框架一起使用

将 Bootstrap 用作模块

依赖

数据属性

选择

事件

编程 API

构造函数中的 CSS 选择器

异步函数和转换

`dispose`方法

默认设置

方法和性质

液

（可选）使用 jQuery

无冲突

jQuery 事件

禁用的 JavaScript

JavaScript

单独或编译

与 JavaScript 框架一起使用

将 Bootstrap 用作模块

依赖

数据属性

选择

事件

编程 API

构造函数中的 CSS 选择器

异步函数和转换

dispose方法

默认设置

方法和性质

液

（可选）使用 jQuery

无冲突

jQuery 事件

禁用的 JavaScript

`dispose`方法