Plugins can be included individually (using Bootstrap's individual *.js
files), or all at once (using bootstrap.js
or the minified bootstrap.min.js
).
Both bootstrap.js
and bootstrap.min.js
contain all plugins in a single file. Include only one.
Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included before the plugin files). Consult our bower.json
to see which versions of jQuery are supported.
You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first-class API and should be your first consideration when using a plugin.
That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the document namespaced with data-api
. This looks like this:
Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:
{% highlight js %} $(document).off('.alert.data-api') {% endhighlight %}Don't use data attributes from multiple plugins on the same element. For example, a button cannot both have a tooltip and toggle a modal. To accomplish this, use a wrapping element.
We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.
{% highlight js %} $('.btn.danger').button('toggle').addClass('fat') {% endhighlight %}All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):
{% highlight js %} $('#myModal').modal() // initialized with defaults $('#myModal').modal({ keyboard: false }) // initialized with no keyboard $('#myModal').modal('show') // initializes and invokes show immediately {% endhighlight %}Each plugin also exposes its raw constructor on a Constructor
property: $.fn.popover.Constructor
. If you'd like to get a particular plugin instance, retrieve it directly from an element: $('[rel="popover"]').data('popover')
.
You can change the default settings for a plugin by modifying the plugin's Constructor.DEFAULTS
object:
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.
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.
As of 3.0.0, all Bootstrap events are namespaced.
All infinitive events provide preventDefault
functionality. This provides the ability to stop the execution of an action before it starts.
Tooltips and Popovers use our built-in sanitizer to sanitize options which accept HTML.
The default whiteList
value is the following:
If you want to add new values to this default whiteList
you can do the following:
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 %} $('#yourTooltip').tooltip({ sanitizeFn: function (content) { return DOMPurify.sanitize(content) } }) {% endhighlight %}document.implementation.createHTMLDocument
In case of browsers that don't support document.implementation.createHTMLDocument
, like Internet Explorer 8, the built-in sanitize function returns the HTML as is.
If you want to perform sanitization in this case, please specify sanitizeFn
and use an external library like DOMPurify.
The version of each of Bootstrap's jQuery plugins can be accessed via the VERSION
property of the plugin's constructor. For example, for the tooltip plugin:
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.
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.