JavaScript

借助我们基于jQuery构建的可选JavaScript插件,使Bootstrap栩栩如生。 了解每个插件,我们的数据和程序化API选项以及更多信息。

个体或编译(Individual or compiled)

可以单独包含插件(使用Bootstrap的单独的js/dist/*.js),也可以一次使用bootstrap.js或最小化的bootstrap.min.js(不要同时引入两者)来包含插件。

如果使用捆绑程序(Webpack,Rollup…),则可以使用UMD就绪的/js/dist/*.js文件。

依赖

一些插件和CSS组件依赖于其他插件。 如果您单独包含插件,请确保在文档中检查这些依赖性。 另请注意,“所有插件都依赖于jQuery”(这意味着必须在插件文件之前引入 jQuery)。 Consult our package.json ,以了解支持哪些版本的jQuery。

我们的下拉菜单,弹出窗口和工具提示还取决于[Popper.js](https://popper.js.org/)。

数据属性

几乎所有的Bootstrap插件都可以通过带有数据属性的HTML单独启用和配置(我们使用JavaScript功能的首选方式)。 请确保“仅在单个元素上使用一组数据属性” **(例如,您无法通过同一按钮触发工具提示和模态。)

但是,在某些情况下,可能需要禁用此功能。 要禁用数据属性API,请取消绑定以`data-api’命名的文档上的所有事件,如下所示:

$(document).off('.data-api')

另外,要定位特定的插件,只需将插件的名称作为名称空间以及data-api名称空间包括在内,如下所示:

$(document).off('.alert.data-api')

Selectors

当前,由于性能原因,我们使用本地方法querySelectorquerySelectorAll来查询DOM元素,因此您必须使用[有效选择器] valid selectors。 如果使用特殊的选择器,例如:`collapse:Example,请确保将其转义。

事件

Bootstrap为大多数插件的唯一操作提供自定义事件。 通常,它们以不定式和过去分词形式出现-在事件开始时触发不定式(例如show),并在事件完成时触发其过去分词形式(例如shown)行为。

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

$('#myModal').on('show.bs.modal', function (e) {
  if (!data) {
    return e.preventDefault() // stops modal from being shown
  }
})

程序化API

我们还相信您应该能够完全通过JavaScript API使用所有Bootstrap插件。 所有公共API都是单个可链接的方法,并返回所作用的集合。

$('.btn.danger').button('toggle').addClass('fat')

所有方法都应接受可选的options对象,以特定方法为目标的字符串或不包含任何内容(以默认行为启动插件):

$('#myModal').modal() // initialized with defaults
$('#myModal').modal({ keyboard: false }) // initialized with no keyboard
$('#myModal').modal('show') // initializes and invokes show immediately

每个插件还将其原始构造函数公开在Constructor属性上:$.fn.popover.Constructor。 如果您想获取一个特定的插件实例,请直接从一个元素中获取它:$(‘[rel=”popover”]’).data(‘popover’)`。

异步功能和翻译转换

所有编程API方法都是“异步的”,并且在过渡开始之后但在过渡结束之前会返回给调用方。

为了在转换完成后执行操作,您可以监听相应的事件。

$('#myCollapse').on('shown.bs.collapse', function (e) {
  // Action to execute once the collapsible area is expanded
})

此外,对转换组件的方法调用将被忽略

$('#myCarousel').on('slid.bs.carousel', function (e) {
  $('#myCarousel').carousel('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished
})

$('#myCarousel').carousel('1') // Will start sliding to the slide 1 and returns to the caller
$('#myCarousel').carousel('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
$.fn.modal.Constructor.Default.keyboard = false

没有冲突

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

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

版本号

每个Bootstrap jQuery插件的版本都可以通过插件的构造函数的“ VERSION”属性进行访问。 例如,对于工具提示插件:

$.fn.tooltip.Constructor.VERSION // => "4.4.1"

禁用JavaScript时没有特殊的后备(fallbacks)

当禁用JavaScript时,Bootstrap的插件不会特别优雅地回退。 如果您在这种情况下关心用户体验,请使用[<noscript>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/noscript)来解释这种情况(以及 如何向您的用户重新启用JavaScript),和/或添加您自己的自定义后备(fallbacks)。

第三方类库

** Bootstrap不正式支持第三方JavaScript库**,例如Prototype或jQuery UI。 尽管存在.noConflict和命名空间事件,但可能仍需要自己解决兼容性问题。

Util

所有Bootstrap的JavaScript文件都依赖于util.js,并且必须与其他JavaScript文件一起包含在其中。 如果您使用的是已编译(或精简)的bootstrap.js,则无需包含它-它已经存在。

util.js包含实用程序功能和transitionEnd事件的基本帮助器,以及CSS过渡仿真器。 其他插件使用它来检查CSS过渡支持并捕获挂起的过渡。

消毒液(Sanitizer)

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

默认的“ whiteList”值如下:

var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
var DefaultWhitelist = {
  // 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', 'alt', 'title', 'width', 'height'],
  li: [],
  ol: [],
  p: [],
  pre: [],
  s: [],
  small: [],
  span: [],
  sub: [],
  sup: [],
  strong: [],
  u: [],
  ul: []
}

如果要将新值添加到此默认whiteList中,则可以执行以下操作:

var myDefaultWhiteList = $.fn.tooltip.Constructor.Default.whiteList

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

// To allow td elements and data-option attributes on td elements
myDefaultWhiteList.td = ['data-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-]+/
myDefaultWhiteList['*'].push(myCustomRegex)

如果您因为喜欢使用专用的库(例如[DOMPurify](https://www.npmjs.com/package/dompurify))而想绕过我们的消毒剂(sanitizer),则应执行以下操作:

$('#yourTooltip').tooltip({
  sanitizeFn: function (content) {
    return DOMPurify.sanitize(content)
  }
})