Individual or compiled

Plugins can be included individually (using bootstrap-*.js original files, or all at once (using bootstrap.js or the minified bootstrap.min.js.

Do not attempt to include both.

Both bootstrap.js and bootstrap.min.js contain all plugins in a single file.

Plugin 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.

Data attributes

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: {% highlight js %} $(document).off('.data-api') {% endhighlight %}

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 %}

Programmatic API

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').

No conflict

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 {% endhighlight %}

Events

Bootstrap provides custom events for most plugin's 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 trigger 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.

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

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. Ask on the mailing list if you need help.

About transitions

For simple transition effects, include transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this—it's already there.

Use cases

A few examples of the transition plugin:

Sliding or fading in modals
Fading out tabs
Fading out alerts
Sliding carousel panes

Examples

Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.

Static example

A rendered modal with header, body, and set of actions in the footer.

{% highlight html %} {% endhighlight %}

Live demo

Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.

Launch demo modal

{% highlight html %} Launch demo modal {% endhighlight %}

Usage

Via data attributes

Activate a modal without writing JavaScript. Set data-toggle="modal" on a controller element, like a button, along with a data-target="#foo" or href="#foo" to target a specific modal to toggle.

{% highlight html %} {% endhighlight %}

Via JavaScript

Call a modal with id myModal with a single line of JavaScript:

{% highlight js %}$('#myModal').modal(options){% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-backdrop="".

Name	type	default	description
backdrop	boolean	true	Includes a modal-backdrop element. Alternatively, specify `static` for a backdrop which doesn't close the modal on click.
keyboard	boolean	true	Closes the modal when escape key is pressed
show	boolean	true	Shows the modal when initialized.
remote	path	false	If a remote URL is provided, content will be loaded via jQuery's `load` method and injected into the `.modal-body`. If you're using the data api, you may alternatively use the `href` tag to specify the remote source. An example of this is shown below: {% highlight html %} Click me {% endhighlight %}

Methods

.modal(options)

Activates your content as a modal. Accepts an optional options object.

{% highlight js %} $('#myModal').modal({ keyboard: false }) {% endhighlight %}

.modal('toggle')

Manually toggles a modal.

{% highlight js %}$('#myModal').modal('toggle'){% endhighlight %}

.modal('show')

Manually opens a modal.

{% highlight js %}$('#myModal').modal('show'){% endhighlight %}

.modal('hide')

Manually hides a modal.

{% highlight js %}$('#myModal').modal('hide'){% endhighlight %}

Events

Bootstrap's modal class exposes a few events for hooking into modal functionality.

Event Type	Description
show	This event fires immediately when the `show` instance method is called.
shown	This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete).
hide	This event is fired immediately when the `hide` instance method has been called.
hidden	This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).

{% highlight js %} $('#myModal').on('hidden.bs.modal', function () { // do something… }) {% endhighlight %}

Examples

Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.

Within a navbar

Within tabs

Usage

Via data attributes

Add data-toggle="dropdown" to a link or button to toggle a dropdown.

{% highlight html %} {% endhighlight %}

To keep URLs intact, use the data-target attribute instead of href="#".

{% highlight html %} {% endhighlight %}

Via JavaScript

Call the dropdowns via JavaScript:

{% highlight js %} $('.dropdown-toggle').dropdown() {% endhighlight %}

Options

None

Methods

$().dropdown('toggle')

A programmatic api for toggling menus for a given navbar or tabbed navigation.

Example in navbar

The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.

@fat

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

@mdo

Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.

one

Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.

two

In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.

three

Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.

Usage

Via data attributes

To easily add scrollspy behavior to your topbar navigation, add data-spy="scroll" to the element you want to spy on (most typically this would be the <body>. Then add the data-target attribute with the ID or class of the parent element of any Bootstrap .nav component.

{% highlight html %} ... {% endhighlight %}

Via JavaScript

Call the scrollspy via JavaScript:

{% highlight js %} $('#navbar-example').scrollspy() {% endhighlight %}

Resolvable ID targets required

Navbar links must have resolvable id targets. For example, a <a href="#home">home</a> must correspond to something in the DOM like <div id="home"></div>.

Methods

.scrollspy('refresh')

When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:

{% highlight js %} $('[data-spy="scroll"]').each(function () { var $spy = $(this).scrollspy('refresh') }); {% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset="".

Name	type	default	description
offset	number	10	Pixels to offset from top when calculating position of scroll.

Events

Event Type	Description
activate	This event fires whenever a new item becomes activated by the scrollspy.

{% highlight js %} $('#myScrollspy').on('activate.bs.scrollspy', function () { // do something… }) {% endhighlight %}

Example tabs

Add quick, dynamic tab functionality to transition through panes of local content, even via dropdown menus.

Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.

Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.

Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.

Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.

Usage

Enable tabbable tabs via JavaScript (each tab needs to be activated individually):

{% highlight js %} $('#myTab a').click(function (e) { e.preventDefault(); $(this).tab('show'); }) {% endhighlight %}

You can activate individual tabs in several ways:

{% highlight js %} $('#myTab a[href="#profile"]').tab('show'); // Select tab by name $('#myTab a:first').tab('show'); // Select first tab $('#myTab a:last').tab('show'); // Select last tab $('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed) {% endhighlight %}

Markup

You can activate a tab or pill navigation without writing any JavaScript by simply specifying data-toggle="tab" or data-toggle="pill" on an element. Adding the nav and nav-tabs classes to the tab ul will apply the Bootstrap tab styling.

{% highlight html %}

{% endhighlight %}

To make tabs fade in, add .fade to each .tab-pane.

Methods

$().tab

Activates a tab element and content container. Tab should have either a data-target or an href targeting a container node in the DOM.

{% highlight html %}

...

{% endhighlight %}

Events

Event Type	Description
show	This event fires on tab show, but before the new tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.
shown	This event fires on tab show after a tab has been shown. Use `event.target` and `event.relatedTarget` to target the active tab and the previous active tab (if available) respectively.

{% highlight js %} $('a[data-toggle="tab"]').on('shown.bs.tab', function (e) { e.target // activated tab e.relatedTarget // previous tab }) {% endhighlight %}

Examples

Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage.

Hover over the links below to see tooltips:

Four directions

Tooltips in button groups and input groups require special setting

When using tooltips on elements within a .btn-group or an .input-group, you'll have to specify the option container: 'body' (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip is triggered).

Usage

Trigger the tooltip via JavaScript:

{% highlight js %} $('#example').tooltip(options) {% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".

Name	type	default	description
animation	boolean	true	apply a CSS fade transition to the tooltip
html	boolean	false	Insert HTML into the tooltip. If false, jQuery's `text` method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placement	string \| function	'top'	how to position the tooltip - top \| bottom \| left \| right \| auto. When "auto" is specified, it will dynamically reorient the tooltip. For example, if placment is "auto left", the tooltip will display to the left when possible, otherwise it will display right.
selector	string	false	If a selector is provided, tooltip objects will be delegated to the specified targets.
title	string \| function	''	default title value if `title` tag isn't present
trigger	string	'hover focus'	how tooltip is triggered - click \| hover \| focus \| manual. You may pass multiple triggers; separate them with a space.
delay	number \| object	0	delay showing and hiding the tooltip (ms) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: `delay: { show: 500, hide: 100 }`
container	string \| false	false	Appends the tooltip to a specific element. Example: `container: 'body'`

Data attributes for individual tooltips

Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.

Markup

{% highlight html %} Hover over me {% endhighlight %}

Methods

$().tooltip(options)

Attaches a tooltip handler to an element collection.

.tooltip('show')

Reveals an element's tooltip.

{% highlight js %}$('#element').tooltip('show'){% endhighlight %}

.tooltip('hide')

Hides an element's tooltip.

{% highlight js %}$('#element').tooltip('hide'){% endhighlight %}

.tooltip('toggle')

Toggles an element's tooltip.

{% highlight js %}$('#element').tooltip('toggle'){% endhighlight %}

.tooltip('destroy')

Hides and destroys an element's tooltip.

{% highlight js %}$('#element').tooltip('destroy'){% endhighlight %}

Examples

Add small overlays of content, like those on the iPad, to any element for housing secondary information. Hover over the button to trigger the popover.

Plugin dependency

Popovers require the tooltip plugin to be included in your version of Bootstrap.

Popovers in button groups and input groups require special setting

When using popovers on elements within a .btn-group or an .input-group, you'll have to specify the option container: 'body' (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the popover is triggered).

Static popover

Four options are available: top, right, bottom, and left aligned.

Live demo

Click to toggle popover

Four directions

Usage

Enable popovers via JavaScript:

{% highlight js %}$('#example').popover(options){% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".

Name	type	default	description
animation	boolean	true	apply a CSS fade transition to the tooltip
html	boolean	false	Insert HTML into the popover. If false, jQuery's `text` method will be used to insert content into the DOM. Use text if you're worried about XSS attacks.
placement	string \| function	'right'	how to position the popover - top \| bottom \| left \| right \| auto. When "auto" is specified, it will dynamically reorient the popover. For example, if placment is "auto left", the tooltip will display to the left when possible, otherwise it will display right.
selector	string	false	if a selector is provided, tooltip objects will be delegated to the specified targets if a selector is provided, tooltip objects will be delegated to the specified targets. in practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example.
trigger	string	'click'	how popover is triggered - click \| hover \| focus \| manual
title	string \| function	''	default title value if `title` attribute isn't present
content	string \| function	''	default content value if `data-content` attribute isn't present
delay	number \| object	0	delay showing and hiding the popover (ms) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: `delay: { show: 500, hide: 100 }`
container	string \| false	false	Appends the popover to a specific element. Example: `container: 'body'`

Data attributes for individual popovers

Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.

Markup

For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.

Methods

$().popover(options)

Initializes popovers for an element collection.

.popover('show')

Reveals an elements popover.

{% highlight js %}$('#element').popover('show'){% endhighlight %}

.popover('hide')

Hides an elements popover.

{% highlight js %}$('#element').popover('hide'){% endhighlight %}

.popover('toggle')

Toggles an elements popover.

{% highlight js %}$('#element').popover('toggle'){% endhighlight %}

.popover('destroy')

Hides and destroys an element's popover.

{% highlight js %}$('#element').popover('destroy'){% endhighlight %}

Example alerts

Add dismiss functionality to all alert messages with this plugin.

Holy guacamole! Best check yo self, you're not looking too good.

Oh snap! You got an error!

Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.

Take this action Or do this

Usage

Enable dismissal of an alert via JavaScript:

{% highlight js %}$(".alert").alert(){% endhighlight %}

Markup

Just add data-dismiss="alert" to your close button to automatically give an alert close functionality.

{% highlight html %}×{% endhighlight %}

Methods

$().alert()

Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the .fade and .in class already applied to them.

.alert('close')

Closes an alert.

{% highlight js %}$(".alert").alert('close'){% endhighlight %}

Events

Bootstrap's alert class exposes a few events for hooking into alert functionality.

Event Type	Description
close	This event fires immediately when the `close` instance method is called.
closed	This event is fired when the alert has been closed (will wait for CSS transitions to complete).

{% highlight js %} $('#my-alert').bind('closed.bs.alert', function () { // do something… }) {% endhighlight %}

Example uses

Do more with buttons. Control button states or create groups of buttons for more components like toolbars.

Stateful

Add data-loading-text="Loading..." to use a loading state on a button.

{% highlight html %} {% endhighlight %}

Single toggle

Add data-toggle="button" to activate toggling on a single button.

{% highlight html %} {% endhighlight %}

Checkbox

Add data-toggle="buttons" to a group of checkboxes for checkbox style toggling on btn-group.

Option 1 Option 2 Option 3

{% highlight html %}

Option 1 Option 2 Option 3

{% endhighlight %}

Radio

Add data-toggle="buttons" to a group of radio inputs for radio style toggling on btn-group.

Option 1 Option 2 Option 3

{% highlight html %}

Option 1 Option 2 Option 3

{% endhighlight %}

Usage

Enable buttons via JavaScript:

{% highlight js %} $('.nav-tabs').button() {% endhighlight %}

Markup

Data attributes are integral to the button plugin. Check out the example code below for the various markup types.

Options

None

Methods

$().button('toggle')

Toggles push state. Gives the button the appearance that it has been activated.

Auto toggling

You can enable auto toggling of a button by using the data-toggle attribute.

{% highlight html %} {% endhighlight %}

$().button('loading')

Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute data-loading-text.

{% highlight html %} {% endhighlight %}

Cross-browser compatibility

Firefox persists the disabled state across page loads. A workaround for this is to use autocomplete="off".

$().button('reset')

Resets button state - swaps text to original text.

$().button(string)

Resets button state - swaps text to any data defined text state.

{% highlight html %} {% endhighlight %}

About

Get base styles and flexible support for collapsible components like accordions and navigation.

Plugin dependency

Collapse requires the transitions plugin to be included in your version of Bootstrap.

Example accordion

Using the collapse plugin, we built a simple accordion style widget:

Collapsible Group Item #1

Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.

Collapsible Group Item #2

Collapsible Group Item #3

{% highlight html %}

Collapsible Group Item #1

...

Collapsible Group Item #2

...

Collapsible Group Item #3

...

{% endhighlight %}

You can also use the plugin without the accordion markup. Make a button toggle the expanding and collapsing of another element.

{% highlight html %}

...

{% endhighlight %}

Usage

Via data attributes

Just add data-toggle="collapse" and a data-target to element to automatically assign control of a collapsible element. The data-target attribute accepts a CSS selector to apply the collapse to. Be sure to add the class collapse to the collapsible element. If you'd like it to default open, add the additional class in.

To add accordion-like group management to a collapsible control, add the data attribute data-parent="#selector". Refer to the demo to see this in action.

Via JavaScript

Enable manually with:

{% highlight js %} $(".collapse").collapse() {% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-parent="".

Name	type	default	description
parent	selector	false	If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior)
toggle	boolean	true	Toggles the collapsible element on invocation

Methods

.collapse(options)

Activates your content as a collapsible element. Accepts an optional options object. {% highlight js %} $('#myCollapsible').collapse({ toggle: false }) {% endhighlight %}

.collapse('toggle')

Toggles a collapsible element to shown or hidden.

.collapse('show')

Shows a collapsible element.

.collapse('hide')

Hides a collapsible element.

Events

Bootstrap's collapse class exposes a few events for hooking into collapse functionality.

Event Type	Description
show	This event fires immediately when the `show` instance method is called.
shown	This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide	This event is fired immediately when the `hide` method has been called.
hidden	This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).

{% highlight js %} $('#myCollapsible').on('hidden.bs.collapse', function () { // do something… }) {% endhighlight %}

Examples

The slideshow below shows a generic plugin and component for cycling through elements like a carousel.

{% highlight html %}

...

{% endhighlight %}

Glyphicon Alternative

With Glyphicons available, you may choose to style the left and right toggle buttons with .glyphicon .glyphicon-chevron-left and .glyphicon .glyphicon-chevron-right.

Optional captions

Add captions to your slides easily with the .carousel-caption element within any .item. Place just about any optional HTML within there and it will be automatically aligned and formatted.

First slide label

Nulla vitae elit libero, a pharetra augue mollis interdum.

Second slide label

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Third slide label

Praesent commodo cursus magna, vel scelerisque nisl consectetur.

{% highlight html %}

...

{% endhighlight %}

Usage

Via data attributes

Use data attributes to easily control the position of the carousel. data-slide accepts the keywords prev or next, which alters the slide position relative to its current position. Alternatively, use data-slide-to to pass a raw slide index to the carousel data-slide-to="2", which shifts the slide position to a particular index beginning with 0.

Via JavaScript

Call carousel manually with:

{% highlight js %} $('.carousel').carousel() {% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-interval="".

Name	type	default	description
interval	number	5000	The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
pause	string	"hover"	Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.

Methods

.carousel(options)

Initializes the carousel with an optional options object and starts cycling through items.

{% highlight html %} $('.carousel').carousel({ interval: 2000 }) {% endhighlight %}

.carousel('cycle')

Cycles through the carousel items from left to right.

.carousel('pause')

Stops the carousel from cycling through items.

.carousel(number)

Cycles the carousel to a particular frame (0 based, similar to an array).

.carousel('prev')

Cycles to the previous item.

.carousel('next')

Cycles to the next item.

Events

Bootstrap's carousel class exposes two events for hooking into carousel functionality.

Event Type	Description
slide	This event fires immediately when the `slide` instance method is invoked.
slid	This event is fired when the carousel has completed its slide transition.

{% highlight js %} $('#myCarousel').on('slide.bs.carousel', function () { // do something… }) {% endhighlight %}

Example

The subnavigation on the left is a live demo of the affix plugin.

Usage

Via data attributes

To easily add affix behavior to any element, just add data-spy="affix" to the element you want to spy on. Then use offsets to define when to toggle the pinning of an element on and off.

{% highlight html %}

...

{% endhighlight %}

Requires independent styling ;)

Affix toggles between three states/classes: affix, affix-top, and affix-bottom. You must provide the styles for these classes yourself (independent of this plugin). The affix-top class should be in the regular flow of the document. The affix class should be fixed to the page. And affix-bottom should be positioned absolute. Note, affix-bottom is special in that the plugin will place the element with js relative to the offset: { bottom: number } option you've provided.

Via JavaScript

Call the affix plugin via JavaScript:

{% highlight js %} $('#myAffix').affix({ offset: { top: 100 , bottom: function () { return (this.bottom = $('.bs-footer').outerHeight(true)) } } }) {% endhighlight %}

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset-top="200".

Name	type	default	description
offset	number \| function \| object	10	Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and left directions. To provide a unique, bottom and top offset just provide an object `offset: { top: 10 }` or `offset: { top: 10, bottom: 5 }`. Use a function when you need to dynamically calculate an offset.

Overview

Individual or compiled

Do not attempt to include both.

Plugin dependencies

Data attributes

Programmatic API

No conflict

Events

Third-party libraries

Transitions transition.js

About transitions

Use cases

Modals modal.js

Examples

Static example

Modal title

Modal title

Live demo

Modal title

Usage

Via data attributes

Via JavaScript

Options

Methods

.modal(options)

.modal('toggle')

.modal('show')

.modal('hide')

Events

Dropdowns dropdown.js

Examples

Within a navbar

Within tabs

Usage

Via data attributes

Via JavaScript

Options

Methods

$().dropdown('toggle')

ScrollSpy scrollspy.js

Example in navbar

@fat

@mdo

one

two

three

Usage

Via data attributes

Via JavaScript

Resolvable ID targets required

Methods

.scrollspy('refresh')

Options

Events

Togglable tabs tab.js

Example tabs

Usage

Markup

Methods

$().tab

Events

Tooltips tooltip.js

Examples

Four directions

Tooltips in button groups and input groups require special setting

Usage

Options

Data attributes for individual tooltips

Markup

Methods

$().tooltip(options)

.tooltip('show')

.tooltip('hide')

.tooltip('toggle')

.tooltip('destroy')

Popovers popover.js

Examples

Plugin dependency

Popovers in button groups and input groups require special setting

Static popover