9.1 KiB
| layout | title | description | group | toc |
|---|---|---|---|---|
| docs | JavaScript | Bring Bootstrap to life with our optional JavaScript plugins. Learn about each plugin, our data and programmatic API options, and more. | getting-started | true |
Individual or compiled
Plugins can be included individually (using Bootstrap's individual js/dist/*.js), or all at once using bootstrap.js or the minified bootstrap.min.js (don't include both).
If you use a bundler (Webpack, Rollup...), you can use /js/dist/*.js files which are UMD ready.
Using Bootstrap as a module
We provide a version of Bootstrap built as ESM (bootstrap.esm.js and bootstrap.esm.min.js) which allows you to use Bootstrap as a module in your browser, if your targeted browsers support it.
{{< highlight html >}}
{{< /highlight >}}
{{< callout warning >}}
Incompatible plugins
Due to browser limitations, some of our plugins, namely Dropdown, Tooltip and Popover plugins, cannot be used in a <script> tag with module type because they depend on Popper.js. For more information about the issue see here.
{{< /callout >}}
Dependencies
Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs.
Our dropdowns, popovers and tooltips also depend on Popper.js.
Still want to use jQuery? It's possible!
Bootstrap 5 is designed to be used without jQuery, but it's still possible to use our components with jQuery. If Bootstrap detects jQuery in the window object it'll add all of our components in jQuery's plugin system; this means you'll be able to do $('[data-toggle="tooltip"]').tooltip() to enable tooltips. The same goes for our other components.
Data attributes
Nearly all Bootstrap plugins can be enabled and configured through HTML alone with data attributes (our preferred way of using JavaScript functionality). Be sure to only use one set of data attributes on a single element (e.g., you cannot trigger a tooltip and modal from the same button.)
{{< callout warning >}}
Selectors
Currently to query DOM elements we use the native methods querySelector and querySelectorAll for performance reasons, so you have to use valid selectors.
If you use special selectors, for example: collapse:Example be sure to escape them.
{{< /callout >}}
Events
Bootstrap provides custom events for most plugins' unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. show) is triggered at the start of an event, and its past participle form (ex. shown) is triggered on the completion of an action.
All infinitive events provide preventDefault() functionality. This provides the ability to stop the execution of an action before it starts. Returning false from an event handler will also automatically call preventDefault().
{{< highlight js >}} var myModal = document.getElementById('myModal')
myModal.addEventListener('show.bs.modal', function (e) { if (!data) { return e.preventDefault() // stops modal from being shown } }) {{< /highlight >}}
{{< callout warning >}}
jQuery events
Bootstrap will detect jQuery if jQuery is present in the window object and there is no data-no-jquery attribute set on <body>. If jQuery is found, Bootstrap will emit events thanks to jQuery's event system. So if you want to listen to Bootstrap's events, you'll have to use the jQuery methods (.on, .one) instead of addEventListener.
{{< highlight js >}} $('#myTab a').on('shown.bs.tab', function () { // do something... }) {{< /highlight >}} {{< /callout >}}
Programmatic API
All constructors accept an optional options object or nothing (which initiates a plugin with its default behavior):
{{< highlight js >}} 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 {{< /highlight >}}
If you'd like to get a particular plugin instance, each plugin exposes a getInstance method. In order to retrieve it directly from an element, do this: bootstrap.Popover.getInstance(myPopoverEl).
Asynchronous functions and transitions
All programmatic API methods are asynchronous and return to the caller once the transition is started but before it ends.
In order to execute an action once the transition is complete, you can listen to the corresponding event.
{{< highlight js >}} var myCollapseEl = document.getElementById('#myCollapse')
myCollapseEl.addEventListener('shown.bs.collapse', function (e) { // Action to execute once the collapsible area is expanded }) {{< /highlight >}}
In addition a method call on a transitioning component will be ignored.
{{< highlight js >}} var myCarouselEl = document.getElementById('myCarousel') var carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance
myCarouselEl.addEventListener('slid.bs.carousel', function (e) { 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 !! {{< /highlight >}}
Default settings
You can change the default settings for a plugin by modifying the plugin's Constructor.Default object:
{{< highlight js >}}
// changes default for the modal plugin's keyboard option to false
bootstrap.Modal.Default.keyboard = false
{{< /highlight >}}
No conflict (only if you use jQuery)
Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call .noConflict on the plugin you wish to revert the value of.
{{< highlight js >}}
var bootstrapButton = .fn.button.noConflict() // return .fn.button to previously assigned value
$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality
{{< /highlight >}}
Version numbers
The version of each of Bootstrap's plugins can be accessed via the VERSION property of the plugin's constructor. For example, for the tooltip plugin:
{{< highlight js >}} bootstrap.Tooltip.VERSION // => "{{< param current_version >}}" {{< /highlight >}}
No special fallbacks when JavaScript is disabled
Bootstrap's plugins don't fall back particularly gracefully when JavaScript is disabled. If you care about the user experience in this case, use <noscript> to explain the situation (and how to re-enable JavaScript) to your users, and/or add your own custom fallbacks.
{{< callout warning >}}
Third-party libraries
Bootstrap does not officially support third-party JavaScript libraries like Prototype or jQuery UI. Despite .noConflict and namespaced events, there may be compatibility problems that you need to fix on your own.
{{< /callout >}}
Sanitizer
Tooltips and Popovers use our built-in sanitizer to sanitize options which accept HTML.
The default whiteList value is the following:
{{< highlight js >}} 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: [] } {{< /highlight >}}
If you want to add new values to this default whiteList you can do the following:
{{< highlight js >}} var myDefaultWhiteList = bootstrap.Tooltip.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) {{< /highlight >}}
If you want to bypass our sanitizer because you prefer to use a dedicated library, for example DOMPurify, you should do the following:
{{< highlight js >}} var yourTooltipEl = document.getElementById('yourTooltip') var tooltip = new bootstrap.Tooltip(yourTooltipEl, { sanitizeFn: function (content) { return DOMPurify.sanitize(content) } }) {{< /highlight >}}