From 2e4bbb1cb6d8bed29816a3d82b2cd0c7a427112c Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Sat, 12 Jul 2014 02:17:42 -0700 Subject: move over all js pages --- docs/_includes/js/affix.html | 115 ------------- docs/_includes/js/alerts.html | 71 -------- docs/_includes/js/buttons.html | 161 ------------------ docs/_includes/js/carousel.html | 242 --------------------------- docs/_includes/js/collapse.html | 222 ------------------------- docs/_includes/js/dropdowns.html | 178 -------------------- docs/_includes/js/modal.html | 323 ------------------------------------- docs/_includes/js/overview.html | 71 -------- docs/_includes/js/popovers.html | 292 --------------------------------- docs/_includes/js/scrollspy.html | 146 ----------------- docs/_includes/js/tabs.html | 144 ----------------- docs/_includes/js/tooltips.html | 223 ------------------------- docs/_includes/js/transitions.html | 8 - 13 files changed, 2196 deletions(-) delete mode 100644 docs/_includes/js/affix.html delete mode 100644 docs/_includes/js/alerts.html delete mode 100644 docs/_includes/js/buttons.html delete mode 100644 docs/_includes/js/carousel.html delete mode 100644 docs/_includes/js/collapse.html delete mode 100644 docs/_includes/js/dropdowns.html delete mode 100644 docs/_includes/js/modal.html delete mode 100644 docs/_includes/js/overview.html delete mode 100644 docs/_includes/js/popovers.html delete mode 100644 docs/_includes/js/scrollspy.html delete mode 100644 docs/_includes/js/tabs.html delete mode 100644 docs/_includes/js/tooltips.html delete mode 100644 docs/_includes/js/transitions.html (limited to 'docs/_includes/js') diff --git a/docs/_includes/js/affix.html b/docs/_includes/js/affix.html deleted file mode 100644 index 4ce51cb34..000000000 --- a/docs/_includes/js/affix.html +++ /dev/null @@ -1,115 +0,0 @@ -
-

Affix affix.js

- -

Example

-

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

- -
- -

Usage

-

Use the affix plugin via data attributes or manually with your own JavaScript. In both situations, you must provide CSS for the positioning and width of your affixed content.

- -

Positioning via CSS

-

The affix plugin toggles between three classes, each representing a particular state: .affix, .affix-top, and .affix-bottom. You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions.

-

Here's how the affix plugin works:

-
    -
  1. To start, the plugin adds .affix-top to indicate the element is in its top-most position. At this point no CSS positioning is required.
    2. -
  2. Scrolling past the element you want affixed should trigger the actual affixing. This is where .affix replaces .affix-top and sets position: fixed; (provided by Bootstrap's code CSS).
    3. -
  3. If a bottom offset is defined, scrolling past that should replace .affix with .affix-bottom. Since offsets are optional, setting one requires you to set the appropriate CSS. In this case, add position: absolute; when necessary. The plugin uses the data attribute or JavaScript option to determine where to position the element from there.
    4. -
-

Follow the above steps to set your CSS for either of the usage options below.

- -

Via data attributes

-

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

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

Via JavaScript

-

Call the affix plugin via JavaScript:

-{% highlight js %} - $('#my-affix').affix({ - offset: { - top: 100 - , bottom: function () { - return (this.bottom = $('.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".

- -
- - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
offsetnumber | function | object10Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and bottom 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.
targetselector | node | jQuery elementthe window objectSpecifies the target element of the affix.
-
- - -

Events

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
affix.bs.affixThis event fires immediately before the element has been affixed.
affixed.bs.affixThis event is fired after the element has been affixed.
affix-top.bs.affixThis event fires immediately before the element has been affixed-top.
affixed-top.bs.affixThis event is fired after the element has been affixed-top.
affix-bottom.bs.affixThis event fires immediately before the element has been affixed-bottom.
affixed-bottom.bs.affixThis event is fired after the element has been affixed-bottom.
-
-
diff --git a/docs/_includes/js/alerts.html b/docs/_includes/js/alerts.html deleted file mode 100644 index 79c7c409a..000000000 --- a/docs/_includes/js/alerts.html +++ /dev/null @@ -1,71 +0,0 @@ -
-

Alert messages alert.js

- -

Example alerts

-

Add dismiss functionality to all alert messages with this plugin.

-
- -
- -
- -
- - -

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 TypeDescription
close.bs.alertThis event fires immediately when the close instance method is called.
closed.bs.alertThis event is fired when the alert has been closed (will wait for CSS transitions to complete).
-
-{% highlight js %} -$('#my-alert').on('closed.bs.alert', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/buttons.html b/docs/_includes/js/buttons.html deleted file mode 100644 index ee5b3d71d..000000000 --- a/docs/_includes/js/buttons.html +++ /dev/null @@ -1,161 +0,0 @@ -
-

Buttons button.js

- -

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.

-
-

Pre-checked options need .active

-

For pre-checked options, you must add the .active class to the input's label yourself.

-
-
-
- - - -
-
-{% highlight html %} -
- - - -
-{% endhighlight %} - -

Radio

-

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

-
-

Preselected options need .active

-

For preselected options, you must add the .active class to the input's label yourself.

-
-
-
- - - -
-
-{% highlight html %} -
- - - -
-{% endhighlight %} - - -

Usage

-

Enable buttons via JavaScript:

-{% highlight js %} -$('.btn').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 form control states 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 %} -
diff --git a/docs/_includes/js/carousel.html b/docs/_includes/js/carousel.html deleted file mode 100644 index 728356268..000000000 --- a/docs/_includes/js/carousel.html +++ /dev/null @@ -1,242 +0,0 @@ -
-

Carousel carousel.js

- - -

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

-
- -
-{% highlight html %} - -{% endhighlight %} - - - -

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.

-
- -
-{% highlight html %} -
- ... -
-

...

-

...

-
-
-{% endhighlight %} - -
-

Accessibility issue

-

The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.

-
- - - -

Multiple carousels

-

Carousels require the use of an id on the outermost container (the .carousel) for carousel controls to function properly. When adding multiple carousels, or when changing a carousel's id, be sure to update the relevant controls.

- -

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.

-

The data-ride="carousel" attribute is used to mark a carousel as animating starting at page load. It cannot be used in combination with (redundant and unnecessary) explicit JavaScript initialization of the same carousel.

- -

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="".

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
intervalnumber5000The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.
pausestring"hover"Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.
wrapbooleantrueWhether the carousel should cycle continuously or have hard stops.
-
- -

Methods

- -

.carousel(options)

-

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

-{% highlight js %} -$('.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.

-

Both events have the following additional properties:

- -
- - - - - - - - - - - - - - - - - -
Event TypeDescription
slide.bs.carouselThis event fires immediately when the slide instance method is invoked.
slid.bs.carouselThis event is fired when the carousel has completed its slide transition.
-
-{% highlight js %} -$('#myCarousel').on('slide.bs.carousel', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/collapse.html b/docs/_includes/js/collapse.html deleted file mode 100644 index 4e7fb450a..000000000 --- a/docs/_includes/js/collapse.html +++ /dev/null @@ -1,222 +0,0 @@ -
-

Collapse collapse.js

- -

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 by extending the panel component.

- -
-
-
-
-

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

-
-
-
- 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 #3 - -

-
-
-
- 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. -
-
-
-
-
-{% highlight html %} -
-
-
-

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

-
-
-
- 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 #3 - -

-
-
-
- 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. -
-
-
-
-{% 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

-

The collapse plugin utilizes a few classes to handle the heavy lifting:

- -

These classes can be found in component-animations.less.

- -

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="".

-
- - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
parentselectorfalseIf selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this dependent on the panel class)
togglebooleantrueToggles 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 TypeDescription
show.bs.collapseThis event fires immediately when the show instance method is called.
shown.bs.collapseThis event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.collapse - This event is fired immediately when the hide method has been called. -
hidden.bs.collapseThis 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 %} -
diff --git a/docs/_includes/js/dropdowns.html b/docs/_includes/js/dropdowns.html deleted file mode 100644 index aa5b9df22..000000000 --- a/docs/_includes/js/dropdowns.html +++ /dev/null @@ -1,178 +0,0 @@ -
-

Dropdowns dropdown.js

- - -

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

- -

Within a navbar

-
- -
- -

Within pills

-
- -
- - - -

Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the .open class on the parent list item.

-

On mobile devices, opening a dropdown adds a .dropdown-backdrop as a tap area for closing dropdown menus when tapping outside the menu, a requirement for proper iOS support. This means that switching from an open dropdown menu to a different dropdown menu requires an extra tap on mobile.

-

Note: The data-toggle="dropdown" attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.

- -

Via data attributes

-

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

-{% highlight html %} -
- Dropdown trigger - -
-{% endhighlight %} -

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

-{% highlight html %} -
- - Dropdown - - - -
-{% endhighlight %} - -

Via JavaScript

-

Call the dropdowns via JavaScript:

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

data-toggle="dropdown" still required

-

Regardless of whether you call your dropdown via JavaScript or instead use the data-api, data-toggle="dropdown" is always required to be present on the dropdown's trigger element.

-
- -

Options

-

None

- -

Methods

-

$().dropdown('toggle')

-

Toggles the dropdown menu of a given navbar or tabbed navigation.

- -

Events

-

All dropdown events are fired at the .dropdown-menu's parent element.

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.dropdownThis event fires immediately when the show instance method is called. The toggling anchor element is available as the relatedTarget property of the event.
shown.bs.dropdownThis event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete). The toggling anchor element is available as the relatedTarget property of the event.
hide.bs.dropdownThis event is fired immediately when the hide instance method has been called. The toggling anchor element is available as the relatedTarget property of the event.
hidden.bs.dropdownThis event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete). The toggling anchor element is available as the relatedTarget property of the event.
-
-{% highlight js %} -$('#myDropdown').on('show.bs.dropdown', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/modal.html b/docs/_includes/js/modal.html deleted file mode 100644 index a64b6b1b6..000000000 --- a/docs/_includes/js/modal.html +++ /dev/null @@ -1,323 +0,0 @@ -
-

Modals modal.js

- -

Examples

-

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

- -
-

Overlapping modals not supported

-

Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.

-
-
-

Modal markup placement

-

Always try to place a modal's HTML code in a top-level position in your document to avoid other components affecting the modal's appearance and/or functionality.

-
-
-

Mobile device caveats

-

There are some caveats regarding using modals on mobile devices. See our browser support docs for details.

-
- -

Static example

-

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

-
-
-
-
-
- -

Modal title

-
-
-

One fine body…

-
-
- - -
-
-
-
-
-{% highlight html %} -
-
-
-
- -

Modal title

-
-
-

One fine body…

-
-
- - -
-
-
-
-{% 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.

- - - -
- -
-{% highlight html %} - - - - - -{% endhighlight %} - -
-

Make modals accessible

-

Be sure to add role="dialog" to .modal, aria-labelledby="myModalLabel" attribute to reference the modal title, and aria-hidden="true" to tell assistive technologies to skip the modal's DOM elements.

-

Additionally, you may give a description of your modal dialog with aria-describedby on .modal.

-
- -
-

Embedding YouTube videos

-

Embedding YouTube videos in modals requires additional JavaScript not in Bootstrap to automatically stop playback and more. See this helpful Stack Overflow post for more information.

-
- -

Optional sizes

-

Modals have two optional sizes, available via modifier classes to be placed on a .modal-dialog.

-
- - -
-{% highlight html %} - - - - - - - - - -{% endhighlight %} - - - - - -

Remove animation

-

For modals that simply appear rather than fade in to view, remove the .fade class from your modal markup.

-{% highlight html %} - -{% endhighlight %} - -

Usage

-

The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds .modal-open to the <body> to override default scrolling behavior and generates a .modal-backdrop to provide a click area for dismissing shown modals when clicking outside the modal.

- -

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="".

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
backdropboolean or the string 'static'trueIncludes a modal-backdrop element. Alternatively, specify static for a backdrop which doesn't close the modal on click.
keyboardbooleantrueCloses the modal when escape key is pressed
showbooleantrueShows the modal when initialized.
-
- -

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. Returns to the caller before the modal has actually been shown or hidden (i.e. before the shown.bs.modal or hidden.bs.modal event occurs).

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

.modal('show')

-

Manually opens a modal. Returns to the caller before the modal has actually been shown (i.e. before the shown.bs.modal event occurs).

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

.modal('hide')

-

Manually hides a modal. Returns to the caller before the modal has actually been hidden (i.e. before the hidden.bs.modal event occurs).

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

Events

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.modalThis event fires immediately when the show instance method is called. If caused by a click, the clicked element is available as the relatedTarget property of the event.
shown.bs.modalThis event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the relatedTarget property of the event.
hide.bs.modalThis event is fired immediately when the hide instance method has been called.
hidden.bs.modalThis event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
loaded.bs.modalThis event is fired when the modal has loaded content using the remote option.
-
-{% highlight js %} -$('#myModal').on('hidden.bs.modal', function (e) { - // do something... -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/overview.html b/docs/_includes/js/overview.html deleted file mode 100644 index 2ef8fe850..000000000 --- a/docs/_includes/js/overview.html +++ /dev/null @@ -1,71 +0,0 @@ -
-

Overview

- -

Individual or compiled

-

Plugins can be included individually (using Bootstrap's individual *.js files), or all at once (using bootstrap.js or the minified bootstrap.min.js).

- -
-

Using the compiled JavaScript

-

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

-
- -
-

Component data attributes

-

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.

-
- -
-

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

-
- -

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

-{% 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.

-
-
diff --git a/docs/_includes/js/popovers.html b/docs/_includes/js/popovers.html deleted file mode 100644 index c704f4062..000000000 --- a/docs/_includes/js/popovers.html +++ /dev/null @@ -1,292 +0,0 @@ -
-

Popovers popover.js

- -

Examples

-

Add small overlays of content, like those on the iPad, to any element for housing secondary information.

- -
-

Plugin dependency

-

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

-
-
-

Opt-in functionality

-

For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.

-
-
-

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

-
-
-

Don't try to show popovers on hidden elements

-

Invoking $(...).popover('show') when the target element is display: none; will cause the popover to be incorrectly positioned.

-
-
-

Popovers on disabled elements require wrapper elements

-

To add a popover to a disabled or .disabled element, put the element inside of a <div> and apply the popover to that <div> instead.

-
- -

Static popover

-

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

-
-
-
-

Popover top

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover right

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover bottom

- -
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
-

Popover left

-
-

Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.

-
-
- -
-
- -

Live demo

-
- -
-{% highlight html %} - -{% endhighlight %} - -

Four directions

-
-
- - - - -
-
-{% highlight html %} - - - - - - - -{% endhighlight %} - -

Dismiss on next click

-

Use the focus trigger to dismiss popovers on the next click that the user makes.

-
- -
-{% highlight html %} - -{% endhighlight %} -{% highlight js %} -$('.popover-dismiss').popover({ - trigger: 'focus' -}) -{% endhighlight %} - -
-

Multiple-line links

-

Sometimes you want to add a popover to a hyperlink that wraps multiple lines. The default behavior of the popover plugin is to center it horizontally and vertically. Add white-space: nowrap; to your anchors to avoid this.

-
- - -

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="".

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the popover
containerstring | falsefalse -

Appends the popover to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.

-
contentstring | function'' -

Default content value if data-content attribute isn't present.

-

If a function is given, it will be called with 1 argument, which is the element that the popover is attached to.

-
delaynumber | object0 -

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 }

-
htmlbooleanfalseInsert 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.
placementstring | 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 placement is "auto left", the popover will display to the left when possible, otherwise it will display right.
selectorstringfalseIf a selector is provided, popover 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.
templatestring'<div class="popover" role="tooltip"><div class="arrow"></div><h3 class="popover-title"></h3><div class="popover-content"></div></div>' -

Base HTML to use when creating the popover.

-

The popover's title will be injected into the .popover-title.

-

The popover's content will be injected into the .popover-content.

-

.arrow will become the popover's arrow.

-

The outermost wrapper element should have the .popover class.

-
titlestring | function''Default title value if title attribute isn't present
triggerstring'click'How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
viewportstring | object{ selector: 'body', padding: 0 } -

Keeps the popover within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }

-
-
-
-

Data attributes for individual popovers

-

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

-
- -

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

Events

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.popoverThis event fires immediately when the show instance method is called.
shown.bs.popoverThis event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.popoverThis event is fired immediately when the hide instance method has been called.
hidden.bs.popoverThis event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
-
-{% highlight js %} -$('#myPopover').on('hidden.bs.popover', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/scrollspy.html b/docs/_includes/js/scrollspy.html deleted file mode 100644 index e7b5ffd56..000000000 --- a/docs/_includes/js/scrollspy.html +++ /dev/null @@ -1,146 +0,0 @@ -
-

ScrollSpy scrollspy.js

- -

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

-

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.

-

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

- -

Requires relative positioning

-

No matter the implementation method, scrollspy requires the use of position: relative; on the element you're spying on. In most cases this is the <body>.

- -

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 css %} -body { - position: relative; -} -{% endhighlight %} -{% highlight html %} - - ... -
-
    - ... -
-
- ... - -{% endhighlight %} - -

Via JavaScript

-

After adding position: relative; in your CSS, call the scrollspy via JavaScript:

-{% highlight js %} -$('body').scrollspy({ target: '.navbar-example' }) -{% 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>.

-
-
-

Non-:visible target elements ignored

-

Target elements that are not :visible according to jQuery will be ignored and their corresponding nav items will never be highlighted.

-
- -

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="".

-
- - - - - - - - - - - - - - - - - -
Nametypedefaultdescription
offsetnumber10Pixels to offset from top when calculating position of scroll.
-
- -

Events

-
- - - - - - - - - - - - - -
Event TypeDescription
activate.bs.scrollspyThis event fires whenever a new item becomes activated by the scrollspy.
-
-{% highlight js %} -$('#myScrollspy').on('activate.bs.scrollspy', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/tabs.html b/docs/_includes/js/tabs.html deleted file mode 100644 index 4bb93e122..000000000 --- a/docs/_includes/js/tabs.html +++ /dev/null @@ -1,144 +0,0 @@ -
-

Togglable tabs tab.js

- -

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.

-
- - -
-
- -
-

Extends tabbed navigation

-

This plugin extends the tabbed navigation component to add tabbable areas.

-
- - -

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, while adding the nav and nav-pills classes will apply pill styling.

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

Fade effect

-

To make tabs fade in, add .fade to each .tab-pane. The first tab pane must also have .in to properly fade in initial content.

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

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 TypeDescription
show.bs.tabThis 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.bs.tabThis 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 %} -
diff --git a/docs/_includes/js/tooltips.html b/docs/_includes/js/tooltips.html deleted file mode 100644 index ca52a3e95..000000000 --- a/docs/_includes/js/tooltips.html +++ /dev/null @@ -1,223 +0,0 @@ -
-

Tooltips tooltip.js

- -

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:

-
-

Tight pants next level keffiyeh you probably haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel have a terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral. -

-
- -

Four directions

-
-
- - - - -
-
-{% highlight html %} - - - - - - - -{% endhighlight %} - -
-

Opt-in functionality

-

For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning you must initialize them yourself.

-
-
-

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

-
-
-

Don't try to show tooltips on hidden elements

-

Invoking $(...).tooltip('show') when the target element is display: none; will cause the tooltip to be incorrectly positioned.

-
-
-

Tooltips on disabled elements require wrapper elements

-

To add a tooltip to a disabled or .disabled element, put the element inside of a <div> and apply the tooltip to that <div> instead.

-
- -

Usage

-

The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.

-

Trigger the tooltip via JavaScript:

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

Markup

-

The required markup for a tooltip is only a data attribute and title on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to top by the plugin).

-
-

Multiple-line links

-

Sometimes you want to add a tooltip to a hyperlink that wraps multiple lines. The default behavior of the tooltip plugin is to center it horizontally and vertically. Add white-space: nowrap; to your anchors to avoid this.

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

Options

-

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

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
animationbooleantrueApply a CSS fade transition to the tooltip
containerstring | falsefalse -

Appends the tooltip to a specific element. Example: container: 'body'. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.

-
delaynumber | object0 -

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 }

-
htmlbooleanfalseInsert 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.
placementstring | 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 placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.
selectorstringfalseIf 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 tooltips added. See this and an informative example.
templatestring'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' -

Base HTML to use when creating the tooltip.

-

The tooltip's title will be injected into the .tooltip-inner.

-

.tooltip-arrow will become the tooltip's arrow.

-

The outermost wrapper element should have the .tooltip class.

-
titlestring | function''Default title value if title attribute isn't present
triggerstring'hover focus'How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
viewportstring | object{ selector: 'body', padding: 0 } -

Keeps the tooltip within the bounds of this element. Example: viewport: '#viewport' or { "selector": "#viewport", "padding": 0 }

-
-
-
-

Data attributes for individual tooltips

-

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

-
- -

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

Events

-
- - - - - - - - - - - - - - - - - - - - - - - - - -
Event TypeDescription
show.bs.tooltipThis event fires immediately when the show instance method is called.
shown.bs.tooltipThis event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).
hide.bs.tooltipThis event is fired immediately when the hide instance method has been called.
hidden.bs.tooltipThis event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).
-
-{% highlight js %} -$('#myTooltip').on('hidden.bs.tooltip', function () { - // do something… -}) -{% endhighlight %} -
diff --git a/docs/_includes/js/transitions.html b/docs/_includes/js/transitions.html deleted file mode 100644 index cce018805..000000000 --- a/docs/_includes/js/transitions.html +++ /dev/null @@ -1,8 +0,0 @@ -
-

Transitions transition.js

- -

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.

-

What's inside

-

Transition.js is a basic helper for transitionEnd events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions.

-
-- cgit v1.2.3