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.
keyboard	boolean	true	Whether the carousel should react to keyboard events.
pause	string \| boolean	"hover"	If set to `"hover"`, pauses the cycling of the carousel on `mouseenter` and resumes the cycling of the carousel on `mouseleave`. If set to `false`, hovering over the carousel won't pause it. - On touch-enabled devices, when set to `"hover"`, cycling will pause on `touchend` (once the user finished interacting with the carousel) for two intervals, before automatically resuming. Note that this is in addition to the above mouse behavior.
ride	string	false	Autoplays the carousel after the user manually cycles the first item. If "carousel", autoplays the carousel on load.
wrap	boolean	true	Whether the carousel should cycle continuously or have hard stops.

`). - - - - - - - - - - - - - - - - - - -

Event Type	Description
slide.bs.carousel	This event fires immediately when the `slide` instance method is invoked.
slid.bs.carousel	This 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/components/collapse.md b/docs/components/collapse.md deleted file mode 100644 index 84262487b..000000000 --- a/docs/components/collapse.md +++ /dev/null @@ -1,235 +0,0 @@ ---- -layout: docs -title: Collapse -description: Toggle the visibility of content across your project with a few classes and our JavaScript plugins. -group: components -toc: true ---- - -## Example - -Click the buttons below to show and hide another element via class changes: - -- `.collapse` hides content -- `.collapsing` is applied during transitions -- `.collapse.show` shows content - -You can use a link with the `href` attribute, or a button with the `data-target` attribute. In both cases, the `data-toggle="collapse"` is required. - -{% example html %} -

- - Link with href - - -

- Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. -

-{% endexample %} - -## Accordion example - -Using the [card]({{ site.baseurl }}/components/card/) component, you can extend the default collapse behavior to create an accordion. - -{% example 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 - -

- - Collapsible Group Item #3 - -

-{% endexample %} - -You can also create accordions with custom markup. Add the `data-children` attribute and specify a set of sibling elements to toggle (e.g., `.item`). Then, use the same attributes and classes as shown above for connectinh toggles to their associated content. - -{% example html %} -

- - Toggle item - -

- Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed pretium lorem non vestibulum scelerisque. Proin a vestibulum sem, eget tristique massa. Aliquam lacinia rhoncus nibh quis ornare. -

- - Toggle item 2 - -

- Donec at ipsum dignissim, rutrum turpis scelerisque, tristique lectus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vivamus nec dui turpis. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. -

-{% endexample %} - -## Accessibility - -Be sure to add `aria-expanded` to the control element. This attribute explicitly conveys the current state of the collapsible element tied to the control to screen readers and similar assistive technologies. If the collapsible element is closed by default, the attribute on the control element should have a value of `aria-expanded="false"`. If you've set the collapsible element to be open by default using the `show` class, set `aria-expanded="true"` on the control instead. The plugin will automatically toggle this attribute on the control based on whether or not the collapsible element has been opened or closed (via JavaScript, or because the user triggered another control element also tied to the same collapsbile element). - -Additionally, if your control element is targeting a single collapsible element – i.e. the `data-target` attribute is pointing to an `id` selector – you may add an additional `aria-controls` attribute to the control element, containing the `id` of the collapsible element. Modern screen readers and similar assistive technologies make use of this attribute to provide users with additional shortcuts to navigate directly to the collapsible element itself. - -## Usage - -The collapse plugin utilizes a few classes to handle the heavy lifting: - -- `.collapse` hides the content -- `.collapse.show` shows the content -- `.collapsing` is added when the transition starts, and removed when it finishes - -These classes can be found in `_transitions.scss`. - -### Via data attributes - -Just add `data-toggle="collapse"` and a `data-target` to the 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 `show`. - -To add accordion-like group management to a collapsible area, 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 a selector is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this is dependent on the `card` class). The attribute has to be set on the target collapsible area.
toggle	boolean	true	Toggles the collapsible element on invocation

- -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `.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. **Returns to the caller before the collapsible element has actually been shown or hidden (i.e. before the `shown.bs.collapse` or `hidden.bs.collapse` event occurs). - -#### `.collapse('show')` - -Shows a collapsible element. **Returns to the caller before the collapsible element has actually been shown** (i.e. before the `shown.bs.collapse` event occurs). - -#### `.collapse('hide')` - -Hides a collapsible element. **Returns to the caller before the collapsible element has actually been hidden** (i.e. before the `hidden.bs.collapse` event occurs). - -### Events - -Bootstrap's collapse class exposes a few events for hooking into collapse functionality. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.collapse	This event fires immediately when the `show` instance method is called.
shown.bs.collapse	This 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.collapse	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 %} diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md deleted file mode 100644 index 306fb7f2b..000000000 --- a/docs/components/dropdowns.md +++ /dev/null @@ -1,590 +0,0 @@ ---- -layout: docs -title: Dropdowns -description: Toggle contextual overlays for displaying lists of links and more with the Bootstrap dropdown plugin. -group: components -toc: true ---- - -## Overview - -Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They're made interactive with the included Bootstrap dropdown JavaScript plugin. They're toggled by clicking, not by hovering; this is [an intentional design decision.](http://markdotto.com/2012/02/27/bootstrap-explained-dropdowns/) - -Things to know when using the dropdown plugin: - -- Dropdown rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for dropdowns to work! -- Popper.js handle natively the flip of Dropdown when it's outside the viewport, if you want to disable that's behavior use `flip` attribute - -## Examples - -Wrap the dropdown's toggle (your button or link) and the dropdown menu within `.dropdown`, or another element that declares `position: relative;`. Dropdowns can be triggered from `` or ` - -

Name	Type	Default	Description
placement	string	'bottom'	- How to position the popover - top \| bottom. -
offset	number \| string	0	Offset of the dropdown relative to its target. For more information refer to Popper.js's offset docs.
flip	boolean	true	Allow Dropdown to flip in case of an overlapping on the reference element. For more information refer to Popper.js's flip docs.

Classes	Used for	Supported variations
- {% markdown %}`.form-group`{% endmarkdown %} -	- Any group of form controls -	- {% markdown %}Use with any block-level element like ` ` or ` `{% endmarkdown %} -
- {% markdown %}`.form-control`{% endmarkdown %} -	- Textual inputs -	- {% markdown %}`text`, `password`, `datetime-local`, `date`, `month`, `time`, `week`, `number`, `email`, `url`, `search`, `tel`, `color`{% endmarkdown %} -
- Select menus -	- {% markdown %}`multiple`, `size`{% endmarkdown %} -
- Textareas -	- N/A -
- {% markdown %}`.form-control-file`{% endmarkdown %} -	- File inputs -	- {% markdown %}`file`{% endmarkdown %} -
-{% markdown %} -`.form-check` -{% endmarkdown %} -	- Checkboxes and radios -	- N/A -

Name	Type	Default	Description
backdrop	boolean or the string `'static'`	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
focus	boolean	true	Puts the focus on the modal when initialized.
show	boolean	true	Shows the modal when initialized.

`). - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.modal	This 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.modal	This 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.modal	This event is fired immediately when the `hide` instance method has been called.
hidden.bs.modal	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 (e) { - // do something... -}) -{% endhighlight %} diff --git a/docs/components/navbar.md b/docs/components/navbar.md deleted file mode 100644 index 07c86c938..000000000 --- a/docs/components/navbar.md +++ /dev/null @@ -1,538 +0,0 @@ ---- -layout: docs -title: Navbar -description: Documentation and examples for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin. -group: components -toc: true ---- - -## How it works - -Here's what you need to know before getting started with the navbar: - -- Navbars require a wrapping `.navbar` with `.navbar-expand{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes. -- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width. -- Navbars and their contents are built with flexbox, providing easy alignment options via utility classes. -- Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin. -- Ensure accessibility by using a `

` element or, if using a more generic element such as a `

`, add a `role="navigation"` to every navbar to explicitly identify it as a landmark region for users of assistive technologies. - -Read on for an example and list of supported sub-components. - -## Supported content - -Navbars come with built-in support for a handful of sub-components. Choose from the following as needed: - -- `.navbar-brand` for your company, product, or project name. -- `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns). -- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#responsive-behaviors) behaviors. -- `.form-inline` for any form controls and actions. -- `.navbar-text` for adding vertically centered strings of text. -- `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint. - -Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `lg` (large) breakpoint. - -{% example html %} - -{% endexample %} - -### Brand - -The `.navbar-brand` can be applied to most elements, but an anchor works best as some elements might require utility classes or custom styles. - -{% example html %} - - - - - -{% endexample %} - -Adding images to the `.navbar-brand` will likely always require custom styles or utilities to properly size. Here are some examples to demonstrate. - -{% example html %} - - -{% endexample %} - -{% example html %} - - -{% endexample %} - -### Nav - -Navbar navigation links build on our `.nav` options with their own modifier class and require the use of [toggler classes](#toggler) for proper responsive styling. **Navigation in navbars will also grow to occupy as much horizontal space as possible** to keep your navbar contents securely aligned. - -Active states—with `.active`—to indicate the current page can be applied directly to `.nav-link`s or their immediate parent `.nav-item`s. - -{% example html %} - -{% endexample %} - -And because we use classes for our navs, you can avoid the list-based approach entirely if you like. - -{% example html %} - -{% endexample %} - -You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrapping element for positioning, so be sure to use separate and nested elements for `.nav-item` and `.nav-link` as shown below. - -{% example html %} - -{% endexample %} - -### Forms - -Place various form controls and components within a navbar with `.form-inline`. - -{% example html %} - -{% endexample %} - -Align the contents of your inline forms with utilities as needed. - -{% example html %} - -{% endexample %} - -Input groups work, too: - -{% example html %} - -{% endexample %} - -Various buttons are supported as part of these navbar forms, too. This is also a great reminder that vertical alignment utilities can be used to align different sized elements. - -{% example html %} - -{% endexample %} - -### Text - -Navbars may contain bits of text with the help of `.navbar-text`. This class adjusts vertical alignment and horizontal spacing for strings of text. - -{% example html %} - -{% endexample %} - -Mix and match with other components and utilities as needed. - -{% example html %} - -{% endexample %} - -## Color schemes - -Theming the navbar has never been easier thanks to the combination of theming classes and `background-color` utilities. Choose from `.navbar-light` for use with light background colors, or `.navbar-inverse` for dark background colors. Then, customize with `.bg-*` utilities. - -

- - - - - -

- -{% highlight html %} - - - - - -{% endhighlight %} - -## Containers - -Although it's not required, you can wrap a navbar in a `.container` to center it on a page or add one within to only center the contents of a [fixed or static top navbar](#placement). - -{% example html %} -

- -

-{% endexample %} - -When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-expand{-sm|-md|-lg|-xl}` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed. - -{% example html %} - -{% endexample %} - -## Placement - -Use our position utilities to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top. **Note that `position: sticky`, used for `.sticky-top`, [isn't fully supported in every browser](http://caniuse.com/#feat=css-sticky).** - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -## Responsive behaviors - -Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-expand{-sm|-md|-lg|-xl}` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements. - -For navbars that never collapse, add the `.navbar-expand` class on the navbar. For navbars that always collapse, don't add any `.navbar-expand` class. - -### Toggler - -Navbar togglers are left-aligned by default, but should they follow a sibling element like a `.navbar-brand`, they'll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles. - -With no `.navbar-brand` shown in lowest breakpoint: - -{% example html %} - -{% endexample %} - -With a brand name shown on the left and toggler on the right: - -{% example html %} - -{% endexample %} - -With a toggler on the left and brand name on the right: - -{% example html %} - -{% endexample %} - -### External content - -Sometimes you want to use the collapse plugin to trigger hidden content elsewhere on the page. Because our plugin works on the `id` and `data-target` matching, that's easily done! - -{% example html %} -

Collapsed content

- Toggleable via the navbar brand. -

- -

-{% endexample %} diff --git a/docs/components/navs.md b/docs/components/navs.md deleted file mode 100644 index 2e340287d..000000000 --- a/docs/components/navs.md +++ /dev/null @@ -1,673 +0,0 @@ ---- -layout: docs -title: Navs -description: Documentation and examples for how to use Bootstrap's included navigation components. -group: components -toc: true ---- - -## Base nav - -Navigation available in Bootstrap share general markup and styles, from the base `.nav` class to the active and disabled states. Swap modifier classes to switch between each style. - -The base `.nav` component is built with flexbox and provide a strong foundation for building all types of navigation components. It includes some style overrides (for working with lists), some link padding for larger hit areas, and basic disabled styling. - -{% callout info %} -The base `.nav` component does not include any `.active` state. The following examples include the class, mainly to demonstrate that this particular class does not trigger any special styling. -{% endcallout %} - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -Classes are used throughout, so your markup can be super flexible. Use `

` element. Because the `.nav` uses `display: flex`, the nav links behave the same as nav items would, but without the extra markup. - -{% example html %} - -{% endexample %} - -## Available styles - -Change the style of `.nav`s component with modifiers and utilities. Mix and match as needed, or build your own. - -### Horizontal alignment - -Change the horizontal alignment of your nav with [flexbox utilities]({{ site.baseurl }}/layout/grid/#horizontal-alignment). By default, navs are left-aligned, but you can easily change them to center or right aligned. - -Centered with `.justify-content-center`: - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -Right-aligned with `.justify-content-end`: - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -### Vertical - -Stack your navigation by changing the flex item direction with the `.flex-column` utility. Need to stack them on some viewports but not others? Use the responsive versions (e.g., `.flex-sm-column`). - -{% example html %} -

- Active -
- Link -
- Link -
- Disabled -

-{% endexample %} - -As always, vertical navigation is possible without `

- Active -
- Link -
- Link -
- Disabled -

- Active -
- Link -
- Link -
- Disabled -

- Active -
- Longer nav link -
- Link -
- Disabled -

`-based navigation, be sure to include `.nav-item` on the anchors. - -{% example html %} - -{% endexample %} - -For equal-width elements, use `.nav-justified`. All horizontal space will be occupied by nav links, but unlike the `.nav-fill` above, every nav item will be the same width. - -{% example html %} - -{% endexample %} - -Similar to the `.nav-fill` example using a `

`-based navigation, be sure to include `.nav-item` on the anchors. - -{% example html %} - - -{% endexample %} -## Working with flex utilities - -If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint. - -{% example html %} - -{% endexample %} - -## Regarding accessibility - -If you're using navs to provide a navigation bar, be sure to add a `role="navigation"` to the most logical parent container of the `

` element around the whole navigation. Do not add the role to the `

WAI

ARIA

WAI

ARIA

- Home -
- Profile -
- - Dropdown - -
- @fat - @mdo -
-

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.

- Home -
- Profile -
- - Dropdown - -
- @fat - @mdo -
-

...

`-based markup shown below. - -

- -

Et et consectetur ipsum labore excepteur est proident excepteur ad velit occaecat qui minim occaecat veniam. Fugiat veniam incididunt anim aliqua enim pariatur veniam sunt est aute sit dolor anim. Velit non irure adipisicing aliqua ullamco irure incididunt irure non esse consectetur nostrud minim non minim occaecat. Amet duis do nisi duis veniam non est eiusmod tempor incididunt tempor dolor ipsum in qui sit. Exercitation mollit sit culpa nisi culpa non adipisicing reprehenderit do dolore. Duis reprehenderit occaecat anim ullamco ad duis occaecat ex.

Nulla est ullamco ut irure incididunt nulla Lorem Lorem minim irure officia enim reprehenderit. Magna duis labore cillum sint adipisicing exercitation ipsum. Nostrud ut anim non exercitation velit laboris fugiat cupidatat. Commodo esse dolore fugiat sint velit ullamco magna consequat voluptate minim amet aliquip ipsum aute laboris nisi. Labore labore veniam irure irure ipsum pariatur mollit magna in cupidatat dolore magna irure esse tempor ad mollit. Dolore commodo nulla minim amet ipsum officia consectetur amet ullamco voluptate nisi commodo ea sit eu.

Sint sit mollit irure quis est nostrud cillum consequat Lorem esse do quis dolor esse fugiat sunt do. Eu ex commodo veniam Lorem aliquip laborum occaecat qui Lorem esse mollit dolore anim cupidatat. Deserunt officia id Lorem nostrud aute id commodo elit eiusmod enim irure amet eiusmod qui reprehenderit nostrud tempor. Fugiat ipsum excepteur in aliqua non et quis aliquip ad irure in labore cillum elit enim. Consequat aliquip incididunt ipsum et minim laborum laborum laborum et cillum labore. Deserunt adipisicing cillum id nulla minim nostrud labore eiusmod et amet. Laboris consequat consequat commodo non ut non aliquip reprehenderit nulla anim occaecat. Sunt sit ullamco reprehenderit irure ea ullamco Lorem aute nostrud magna.

Proident incididunt esse qui ea nisi ullamco aliquip nostrud velit sint duis. Aute culpa aute cillum sit consectetur mollit minim non reprehenderit tempor. Occaecat amet consectetur aute esse ad ullamco ad commodo mollit reprehenderit esse in consequat. Mollit minim do consectetur pariatur irure non id ea dolore occaecat adipisicing consectetur est aute magna non.

- -{% highlight html %} - -

...

-{% endhighlight %} - -The tabs plugin also works with pills. - -

- Home -
- Profile -
- Dropdown -
- @fat - @mdo -
-

Consequat occaecat ullamco amet non eiusmod nostrud dolore irure incididunt est duis anim sunt officia. Fugiat velit proident aliquip nisi incididunt nostrud exercitation proident est nisi. Irure magna elit commodo anim ex veniam culpa eiusmod id nostrud sit cupidatat in veniam ad. Eiusmod consequat eu adipisicing minim anim aliquip cupidatat culpa excepteur quis. Occaecat sit eu exercitation irure Lorem incididunt nostrud.

Ad pariatur nostrud pariatur exercitation ipsum ipsum culpa mollit commodo mollit ex. Aute sunt incididunt amet commodo est sint nisi deserunt pariatur do. Aliquip ex eiusmod voluptate exercitation cillum id incididunt elit sunt. Qui minim sit magna Lorem id et dolore velit Lorem amet exercitation duis deserunt. Anim id labore elit adipisicing ut in id occaecat pariatur ut ullamco ea tempor duis.

Est quis nulla laborum officia ad nisi ex nostrud culpa Lorem excepteur aliquip dolor aliqua irure ex. Nulla ut duis ipsum nisi elit fugiat commodo sunt reprehenderit laborum veniam eu veniam. Eiusmod minim exercitation fugiat irure ex labore incididunt do fugiat commodo aliquip sit id deserunt reprehenderit aliquip nostrud. Amet ex cupidatat excepteur aute veniam incididunt mollit cupidatat esse irure officia elit do ipsum ullamco Lorem. Ullamco ut ad minim do mollit labore ipsum laboris ipsum commodo sunt tempor enim incididunt. Commodo quis sunt dolore aliquip aute tempor irure magna enim minim reprehenderit. Ullamco consectetur culpa veniam sint cillum aliqua incididunt velit ullamco sunt ullamco quis quis commodo voluptate. Mollit nulla nostrud adipisicing aliqua cupidatat aliqua pariatur mollit voluptate voluptate consequat non.

Tempor anim aliquip qui nisi sit minim ex in cupidatat ipsum adipisicing. Ad non magna anim id ullamco do dolor sit adipisicing nulla exercitation. Qui Lorem eiusmod sint in laboris pariatur est adipisicing non sunt occaecat in mollit culpa sit. Aliquip id duis do do quis mollit ut duis. Non dolor reprehenderit do esse nostrud deserunt non eiusmod minim anim sit voluptate ipsum. Nulla elit aliqua do sunt labore velit anim nisi dolor nostrud consectetur fugiat ex qui velit ex tempor. Do cillum qui anim aliquip id cillum duis ex laboris tempor incididunt sint dolor ullamco tempor. Fugiat laboris enim anim veniam aliquip cillum irure.

- -{% highlight html %} -

- Home -
- Profile -
- Dropdown -
- @fat - @mdo -
-

...

-{% endhighlight %} - -And with vertical pills. - -

- Home - Profile - Messages - Settings -

Cillum ad ut irure tempor velit nostrud occaecat ullamco aliqua anim Lorem sint. Veniam sint duis incididunt do esse magna mollit excepteur laborum qui. Id id reprehenderit sit est eu aliqua occaecat quis et velit excepteur laborum mollit dolore eiusmod. Ipsum dolor in occaecat commodo et voluptate minim reprehenderit mollit pariatur. Deserunt non laborum enim et cillum eu deserunt excepteur ea incididunt minim occaecat.

Culpa dolor voluptate do laboris laboris irure reprehenderit id incididunt duis pariatur mollit aute magna pariatur consectetur. Eu veniam duis non ut dolor deserunt commodo et minim in quis laboris ipsum velit id veniam. Quis ut consectetur adipisicing officia excepteur non sit. Ut et elit aliquip labore Lorem enim eu. Ullamco mollit occaecat dolore ipsum id officia mollit qui esse anim eiusmod do sint minim consectetur qui.

Fugiat id quis dolor culpa eiusmod anim velit excepteur proident dolor aute qui magna. Ad proident laboris ullamco esse anim Lorem Lorem veniam quis Lorem irure occaecat velit nostrud magna nulla. Velit et et proident Lorem do ea tempor officia dolor. Reprehenderit Lorem aliquip labore est magna commodo est ea veniam consectetur.

Eu dolore ea ullamco dolore Lorem id cupidatat excepteur reprehenderit consectetur elit id dolor proident in cupidatat officia. Voluptate excepteur commodo labore nisi cillum duis aliqua do. Aliqua amet qui mollit consectetur nulla mollit velit aliqua veniam nisi id do Lorem deserunt amet. Culpa ullamco sit adipisicing labore officia magna elit nisi in aute tempor commodo eiusmod.

- -{% highlight html %} -

- Home - Profile - Messages - Settings -

...

-{% endhighlight %} - -### Using data attributes - -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. Use these data attributes on `.nav-tabs` or `.nav-pills`. - -{% highlight html %} - -

- Home -
- Profile -
- Messages -
- Settings -

- - -

...

-{% endhighlight %} - -### Via JavaScript - -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 %} - -### Fade effect - -To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.show` to make the initial content visible. - -{% highlight html %} -

...

-{% endhighlight %} - -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### $().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 %} -

- Home -
- Profile -
- Messages -
- Settings -

- -

...

- - -{% endhighlight %} - -#### .tab('show') - -Selects the given tab and shows its associated pane. Any other tab that was previously selected becomes unselected and its associated pane is hidden. **Returns to the caller before the tab pane has actually been shown** (i.e. before the `shown.bs.tab` event occurs). - -{% highlight js %} -$('#someTab').tab('show') -{% endhighlight %} - -### Events - -When showing a new tab, the events fire in the following order: - -1. `hide.bs.tab` (on the current active tab) -2. `show.bs.tab` (on the to-be-shown tab) -3. `hidden.bs.tab` (on the previous active tab, the same one as for the `hide.bs.tab` event) -4. `shown.bs.tab` (on the newly-active just-shown tab, the same one as for the `show.bs.tab` event) - -If no tab was already active, then the `hide.bs.tab` and `hidden.bs.tab` events will not be fired. - - - - - - - - - - - - - - - - - - - - - - - - - - -

Event Type	Description
show.bs.tab	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.bs.tab	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.
hide.bs.tab	This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use `event.target` and `event.relatedTarget` to target the current active tab and the new soon-to-be-active tab, respectively.
hidden.bs.tab	This event fires after a new tab is shown (and thus the previous active tab is hidden). Use `event.target` and `event.relatedTarget` to target the previous active tab and the new active tab, respectively.

- -{% highlight js %} -$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) { - e.target // newly activated tab - e.relatedTarget // previous active tab -}) -{% endhighlight %} diff --git a/docs/components/pagination.md b/docs/components/pagination.md deleted file mode 100644 index 0ea749e30..000000000 --- a/docs/components/pagination.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -layout: docs -title: Pagination -description: Documentation and examples for showing pagination to indicate a series of related content exists across multiple pages. -group: components -toc: true ---- - -## Overview - -We use a large block of connected links for our pagination, making links hard to miss and easily scalable—all while providing large hit areas. Pagination is built with list HTML elements so screen readers can announce the number of available links. Use a wrapping `

` element to identify it as a navigation section to screen readers and other assistive technologies. - -In addition, as pages likely have more than one such navigation section, it's advisable to provide a descriptive `aria-label` for the `

` to reflect its purpose. For example, if the pagination component is used to navigate between a set of search results, an appropriate label could be `aria-label="Search results pages"`. - -{% example html %} - -{% endexample %} - -## Working with icons - -Looking to use an icon or symbol in place of text for some pagination links? Be sure to provide proper screen reader support with `aria` attributes and the `.sr-only` utility. - -{% example html %} - -{% endexample %} - -## Disabled and active states - -Pagination links are customizable for different circumstances. Use `.disabled` for links that appear un-clickable and `.active` to indicate the current page. - -While the `.disabled` class uses `pointer-events: none` to _try_ to disable the link functionality of ``s, that CSS property is not yet standardized and doesn't account for keyboard navigation. As such, you should always add `tabindex="-1"` on disabled links and use custom JavaScript to fully disable their functionality. - -{% example html %} - -{% endexample %} - -You can optionally swap out active or disabled anchors for ``, or omit the anchor in the case of the prev/next arrows, to remove click functionality and prevent keyboard focus while retaining intended styles. - -{% example html %} - -{% endexample %} - -## Sizing - -Fancy larger or smaller pagination? Add `.pagination-lg` or `.pagination-sm` for additional sizes. - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} - -## Alignment - -Change the alignment of pagination components with [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). - -{% example html %} - -{% endexample %} - -{% example html %} - -{% endexample %} diff --git a/docs/components/popovers.md b/docs/components/popovers.md deleted file mode 100644 index a7750d635..000000000 --- a/docs/components/popovers.md +++ /dev/null @@ -1,372 +0,0 @@ ---- -layout: docs -title: Popovers -description: Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site. -group: components -toc: true ---- - -## Overview - -Things to know when using the popover plugin: - - -- Popovers rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for popovers to work! -- Popovers require the [tooltip plugin]({{ site.baseurl }}/components/tooltips/) as a dependency. -- Popovers are opt-in for performance reasons, so **you must initialize them yourself**. -- Zero-length `title` and `content` values will never show a popover. -- Specify `container: 'body'` to avoid rendering problems in more complex components (like our input groups, button groups, etc). -- Triggering popovers on hidden elements will not work. -- Popovers for `.disabled` or `disabled` elements must be triggered on a wrapper element. -- When triggered from hyperlinks that span multiple lines, popovers will be centered. Use `white-space: nowrap;` on your ``s to avoid this behavior. -- Popovers must be hidden before their corresponding elements have been removed from the DOM. - -Got all that? Great, let's see how they work with some examples. - -## Example: Enable popovers everywhere - -One way to initialize all popovers on a page would be to select them by their `data-toggle` attribute: - -{% highlight js %} -$(function () { - $('[data-toggle="popover"]').popover() -}) -{% endhighlight %} - -## Example: Using the `container` option - -When you have some styles on a parent element that interfere with a popover, you'll want to specify a custom `container` so that the popover's HTML appears within that element instead. - -{% highlight js %} -$(function () { - $('.example-popover').popover({ - container: 'body' - }) -}) -{% endhighlight %} - -## Static popover - -Four options are available: top, right, bottom, and left aligned. - - - -## Live demo - -{% example html %} - -{% endexample %} - -### Four directions - - - -{% highlight html %} - - - - - - - -{% endhighlight %} - -### Dismiss on next click - -Use the `focus` trigger to dismiss popovers on the next click that the user makes. - -{% callout danger %} -#### Specific markup required for dismiss-on-next-click - -For proper cross-browser and cross-platform behavior, you must use the `` tag, _not_ the ` -

- -{% highlight html %} -

-{% endhighlight %} diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md deleted file mode 100644 index a2829d3e5..000000000 --- a/docs/components/scrollspy.md +++ /dev/null @@ -1,327 +0,0 @@ ---- -layout: docs -title: Scrollspy -description: Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport. -group: components -toc: true ---- - -## How it works - -Scrollspy has a few requirements to function properly: - -- It must to be used on a Bootstrap [nav component]({{ site.baseurl }}/components/navs/) or [list group]({{ site.baseurl }}/components/list-group/). -- Scrollspy requires `position: relative;` on the element you're spying on, usually the ``. -- When spying on elements other than the ``, be sure to have a `height` set and `overflow-y: scroll;` applied. -- Anchors (``) are required and must point to an element with that `id`. - -When successfully implemented, your nav or list group will update accordingly, moving the `.active` class from one item to the next based on their associated targets. - -## Example in navbar - -Scroll the area below the navbar and watch the active class change. The dropdown 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. -

- -{% highlight html %} - -

@fat

...

@mdo

...

one

...

two

...

three

...

-{% endhighlight %} - -## Example with nested nav - -Scrollspy also works with nested `.nav`s. If a nested `.nav` is `.active`, its parents will also be `.active`. Scroll the area next to the navbar and watch the active class change. - -

- -

Item 1

Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

Item 1-1

Amet tempor mollit aliquip pariatur excepteur commodo do ea cillum commodo Lorem et occaecat elit qui et. Aliquip labore ex ex esse voluptate occaecat Lorem ullamco deserunt. Aliqua cillum excepteur irure consequat id quis ea. Sit proident ullamco aute magna pariatur nostrud labore. Reprehenderit aliqua commodo eiusmod aliquip est do duis amet proident magna consectetur consequat eu commodo fugiat non quis. Enim aliquip exercitation ullamco adipisicing voluptate excepteur minim exercitation minim minim commodo adipisicing exercitation officia nisi adipisicing. Anim id duis qui consequat labore adipisicing sint dolor elit cillum anim et fugiat.

Item 2-2

Cillum nisi deserunt magna eiusmod qui eiusmod velit voluptate pariatur laborum sunt enim. Irure laboris mollit consequat incididunt sint et culpa culpa incididunt adipisicing magna magna occaecat. Nulla ipsum cillum eiusmod sint elit excepteur ea labore enim consectetur in labore anim. Proident ullamco ipsum esse elit ut Lorem eiusmod dolor et eiusmod. Anim occaecat nulla in non consequat eiusmod velit incididunt.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 3-1

Deserunt quis elit Lorem eiusmod amet enim enim amet minim Lorem proident nostrud. Ea id dolore anim exercitation aute fugiat labore voluptate cillum do laboris labore. Ex velit exercitation nisi enim labore reprehenderit labore nostrud ut ut. Esse officia sunt duis aliquip ullamco tempor eiusmod deserunt irure nostrud irure. Ullamco proident veniam laboris ea consectetur magna sunt ex exercitation aliquip minim enim culpa occaecat exercitation. Est tempor excepteur aliquip laborum consequat do deserunt laborum esse eiusmod irure proident ipsum esse qui.

Item 3-2

Labore sit culpa commodo elit adipisicing sit aliquip elit proident voluptate minim mollit nostrud aute reprehenderit do. Mollit excepteur eu Lorem ipsum anim commodo sint labore Lorem in exercitation velit incididunt. Occaecat consectetur nisi in occaecat proident minim enim sunt reprehenderit exercitation cupidatat et do officia. Aliquip consequat ad labore labore mollit ut amet. Sit pariatur tempor proident in veniam culpa aliqua excepteur elit magna fugiat eiusmod amet officia.

- -{% highlight html %} - - -

Item 1

...

Item 1-1

...

Item 2-2

...

Item 2

...

Item 3

...

Item 3-1

...

Item 3-2

...

-{% endhighlight %} - -## Example with list-group - -Scrollspy also works with `.list-group`s. Scroll the area next to the list group and watch the active class change. - -

- Item 1 - Item2 - Item 3 - Item 4 -

Item 1

Item 2

Item 3

Item 4

- -{% highlight html %} -

- Item 1 - Item2 - Item 3 - Item 4 -

Item 1

...

Item 2

...

Item 3

...

Item 4

...

-{% endhighlight %} - - -## 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 ``). 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 %} - -{% callout danger %} -#### Resolvable ID targets required - -Navbar links must have resolvable id targets. For example, a `home` must correspond to something in the DOM like `

`. -{% endcallout %} - -{% callout info %} -#### Non-`:visible` target elements ignored - -Target elements that are not [`:visible` according to jQuery](https://api.jquery.com/visible-selector/) will be ignored and their corresponding nav items will never be highlighted. -{% endcallout %} - -### 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.bs.scrollspy	This 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/components/tooltips.md b/docs/components/tooltips.md deleted file mode 100644 index baee52451..000000000 --- a/docs/components/tooltips.md +++ /dev/null @@ -1,349 +0,0 @@ ---- -layout: docs -title: Tooltips -description: Documentation and examples for adding custom Bootstrap tooltips with CSS and JavaScript using CSS3 for animations and data-attributes for local title storage. -group: components -toc: true ---- - -## Overview - -Things to know when using the tooltip plugin: - -- Tooltips rely on the 3rd party library [Popper.js](https://popper.js.org) for positioning. You must include [popper.min.js](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.9.9/umd/popper.min.js) before bootstrap.js in order for tooltips to work! -- Tooltips are opt-in for performance reasons, so **you must initialize them yourself**. -- Tooltips with zero-length titles are never displayed. -- Specify `container: 'body'` to avoid rendering problems in more complex components (like our input groups, button groups, etc). -- Triggering tooltips on hidden elements will not work. -- Tooltips for `.disabled` or `disabled` elements must be triggered on a wrapper element. -- When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use `white-space: nowrap;` on your ``s to avoid this behavior. -- Tooltips must be hidden before their corresponding elements have been removed from the DOM. - -Got all that? Great, let's see how they work with some examples. - -## Example: Enable tooltips everywhere - -One way to initialize all tooltips on a page would be to select them by their `data-toggle` attribute: - -{% highlight js %} -$(function () { - $('[data-toggle="tooltip"]').tooltip() -}) -{% endhighlight %} - -## Examples - -Hover over the links below to see tooltips: - - - -### Static demo - -Four options are available: top, right, bottom, and left aligned. - - - -### Interactive demo - -Hover over the buttons below to see their tooltips. - - - -{% highlight html %} - - - - -{% endhighlight %} - -And with custom HTML added: - -{% highlight html %} - -{% endhighlight %} - -## 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). - -{% callout warning %} -#### Making tooltips work for keyboard and assistive technology users - -You should only add tooltips to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as ``s) can be made focusable by adding the `tabindex="0"` attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users. In addition, most assistive technologies currently do not announce the tooltip in this situation. -{% endcallout %} - -{% 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=""`. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Default	Description
animation	boolean	true	Apply a CSS fade transition to the tooltip
container	string \| element \| false	false	- 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. -
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 }` -
html	boolean	false	- Allow HTML in the tooltip. - If true, HTML tags in the tooltip's `title` will be rendered in 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 - auto \| top \| bottom \| left \| right. When `auto` is specified, it will dynamically reorient the tooltip. - When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The `this` context is set to the tooltip instance. -
selector	string	false	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.
template	string	`'<div class="tooltip" role="tooltip"><div class="arrow" x-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`. - `.arrow` will become the tooltip's arrow. - The outermost wrapper element should have the `.tooltip` class. -
title	string \| element \| function	''	- Default title value if `title` attribute isn't present. - If a function is given, it will be called with its `this` reference set to the element that the tooltip is attached to. -
trigger	string	'hover focus'	How tooltip is triggered - click \| hover \| focus \| manual. You may pass multiple triggers; separate them with a space. `manual` cannot be combined with any other trigger.
offset	number \| string	0	Offset of the tooltip relative to its target. For more information refer to Popper.js's offset docs.
fallbackPlacement	string \| array	'flip'	Allow to specify which position Popper will use on fallback. For more information refer to - Popper.js's behavior docs

- -{% callout info %} -#### Data attributes for individual tooltips - -Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above. -{% endcallout %} - -### Methods - -{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %} -{{ callout-include | markdownify }} - -#### `$().tooltip(options)` - -Attaches a tooltip handler to an element collection. - -#### `.tooltip('show')` - -Reveals an element's tooltip. **Returns to the caller before the tooltip has actually been shown** (i.e. before the `shown.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. Tooltips with zero-length titles are never displayed. - -{% highlight js %}$('#element').tooltip('show'){% endhighlight %} - -#### `.tooltip('hide')` - -Hides an element's tooltip. **Returns to the caller before the tooltip has actually been hidden** (i.e. before the `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. - -{% highlight js %}$('#element').tooltip('hide'){% endhighlight %} - -#### `.tooltip('toggle')` - -Toggles an element's tooltip. **Returns to the caller before the tooltip has actually been shown or hidden** (i.e. before the `shown.bs.tooltip` or `hidden.bs.tooltip` event occurs). This is considered a "manual" triggering of the tooltip. - -{% highlight js %}$('#element').tooltip('toggle'){% endhighlight %} - -#### `.tooltip('dispose')` - -Hides and destroys an element's tooltip. Tooltips that use delegation (which are created using [the `selector` option](#options)) cannot be individually destroyed on descendant trigger elements. - -{% highlight js %}$('#element').tooltip('dispose'){% endhighlight %} - -#### `.tooltip('enable')` - -Gives an element's tooltip the ability to be shown. **Tooltips are enabled by default.** - -{% highlight js %}$('#element').tooltip('enable'){% endhighlight %} - -#### `.tooltip('disable')` - -Removes the ability for an element's tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled. - -{% highlight js %}$('#element').tooltip('disable'){% endhighlight %} - -#### `.tooltip('toggleEnabled')` - -Toggles the ability for an element's tooltip to be shown or hidden. - -{% highlight js %}$('#element').tooltip('toggleEnabled'){% endhighlight %} - -#### `.tooltip('update')` - -Updates the position of an element's tooltip. - -{% highlight js %}$('#element').tooltip('update'){% endhighlight %} - -### Events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

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

- -{% highlight js %} -$('#myTooltip').on('hidden.bs.tooltip', function () { - // do something… -}) -{% endhighlight %} -- cgit v1.2.3

Well done!

Example heading New