16 KiB
| layout | title | group |
|---|---|---|
| docs | Navs | components |
[//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by gulp docs:copy:bs-docs
{% callout info %} Bootstrap Reference Documentation This is a part of the reference documentation from Bootstrap. It is included here to demonstrate rendering with Bootstrap Material Design default styling. See the Material Design section for more elements and customization options. {% endcallout %}
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.
Contents
- Will be replaced with the ToC, excluding the "Contents" header {:toc}
Regarding accessibility
If you are using navs to provide a navigation bar, be sure to add a role="navigation" to the most logical parent container of the <ul>, or wrap a <nav> element around the whole navigation. Do not add the role to the <ul> itself, as this would prevent it from being announced as an actual list by assistive technologies.
Base nav
Roll your own navigation style by extending the base .nav component. All Bootstrap's nav components are built on top of this by specifying additional styles. Includes styles for the disabled state, but not the active state.
{% example html %}
{% endexample %}Classes are used throughout, so your markup can be super flexible. Use <ul>s like above, or roll your own with say a <nav> element. The change in nav item display below is intentional as <li>s have a different default display than regular <a> elements.
{% example html %}
Active Link Link Disabled {% endexample %}Inline
Space out nav links in a horizontal band with .nav-inline. Longer series of links will wrap to a new line.
{% example html %}
Active Link Link Disabled {% endexample %}The same works for a navigation built with lists.
{% example html %}
{% endexample %}Tabs
Takes the basic nav from above and adds the .nav-tabs class to generate a tabbed interface. Use them to create tabbable regions with our tab JavaScript plugin.
{% example html %}
{% endexample %}Pills
Take that same HTML, but use .nav-pills instead:
{% example html %}
{% endexample %}Stacked pills
Add .nav-stacked to the .nav.nav-pills to stack them vertically. Each .nav-link becomes block-level, allowing for larger hit areas via mouse or tap.
{% example html %}
{% endexample %}As always, stacked pills are possible without <ul>s.
{% example html %}
Active Link Link Disabled {% endexample %}Using dropdowns
Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin]({{ site.baseurl }}/components/dropdowns/#usage).
Tabs with dropdowns
{% example html %}
{% endexample %}Pills with dropdowns
{% example html %}
{% endexample %}JavaScript behavior
Use the tab JavaScript plugin—include it individually or through the compiled bootstrap.js file—to extend our navigational tabs and pills to create tabbable panes of local content, even via dropdown menus.
Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.
Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.
Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.
Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.
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.
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 .in to make the initial content visible.
{% highlight html %}
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 %}
.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:
hide.bs.tab(on the current active tab)show.bs.tab(on the to-be-shown tab)hidden.bs.tab(on the previous active tab, the same one as for thehide.bs.tabevent)shown.bs.tab(on the newly-active just-shown tab, the same one as for theshow.bs.tabevent)
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 %}