navs.md 35.7 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
Mark Otto's avatar
Mark Otto committed
3
title: Navs
Mark Otto's avatar
Mark Otto committed
4
description: Documentation and examples for how to use Bootstrap's included navigation components.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
toc: true
Mark Otto's avatar
Mark Otto committed
7
8
---

Mark Otto's avatar
Mark Otto committed
9
## Base nav
Mark Otto's avatar
Mark Otto committed
10

Mark Otto's avatar
Mark Otto committed
11
12
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.

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

15
{% capture callout %}
16
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.
17
18
{% endcapture %}
{% include callout.html content=callout type="info" %}
Mark Otto's avatar
Mark Otto committed
19

m5o's avatar
m5o committed
20
{% capture example %}
Mark Otto's avatar
Mark Otto committed
21
<ul class="nav">
Mark Otto's avatar
Mark Otto committed
22
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
23
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
24
25
26
27
28
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
29
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
30
  </li>
31
  <li class="nav-item">
32
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
33
34
  </li>
</ul>
m5o's avatar
m5o committed
35
36
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
37

38
Classes are used throughout, so your markup can be super flexible. Use `<ul>`s like above, `<ol>` if the order of your items is important, or roll your own with a `<nav>` element. Because the `.nav` uses `display: flex`, the nav links behave the same as nav items would, but without the extra markup.
Mark Otto's avatar
Mark Otto committed
39

m5o's avatar
m5o committed
40
{% capture example %}
Mark Otto's avatar
Mark Otto committed
41
<nav class="nav">
Mark Otto's avatar
Mark Otto committed
42
43
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
44
  <a class="nav-link" href="#">Link</a>
45
  <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
46
</nav>
m5o's avatar
m5o committed
47
48
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
49

Mark Otto's avatar
Mark Otto committed
50
## Available styles
51

Mark Otto's avatar
Mark Otto committed
52
Change the style of `.nav`s component with modifiers and utilities. Mix and match as needed, or build your own.
53

Mark Otto's avatar
Mark Otto committed
54
### Horizontal alignment
55

Mark Otto's avatar
Mark Otto committed
56
Change the horizontal alignment of your nav with [flexbox utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/layout/grid/#horizontal-alignment). By default, navs are left-aligned, but you can easily change them to center or right aligned.
Mark Otto's avatar
Mark Otto committed
57

Mark Otto's avatar
Mark Otto committed
58
Centered with `.justify-content-center`:
Mark Otto's avatar
Mark Otto committed
59

m5o's avatar
m5o committed
60
{% capture example %}
Mark Otto's avatar
Mark Otto committed
61
<ul class="nav justify-content-center">
62
  <li class="nav-item">
63
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
64
  </li>
Mark Otto's avatar
Mark Otto committed
65
  <li class="nav-item">
66
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
67
  </li>
Mark Otto's avatar
Mark Otto committed
68
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
69
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
70
  </li>
Mark Otto's avatar
Mark Otto committed
71
  <li class="nav-item">
72
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
73
74
  </li>
</ul>
m5o's avatar
m5o committed
75
76
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
77

Mark Otto's avatar
Mark Otto committed
78
Right-aligned with `.justify-content-end`:
Mark Otto's avatar
Mark Otto committed
79

m5o's avatar
m5o committed
80
{% capture example %}
Mark Otto's avatar
Mark Otto committed
81
<ul class="nav justify-content-end">
82
  <li class="nav-item">
83
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
84
  </li>
Mark Otto's avatar
Mark Otto committed
85
  <li class="nav-item">
86
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
87
  </li>
Mark Otto's avatar
Mark Otto committed
88
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
89
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
90
  </li>
91
  <li class="nav-item">
92
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
93
94
  </li>
</ul>
m5o's avatar
m5o committed
95
96
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
97

Mark Otto's avatar
Mark Otto committed
98
### Vertical
Mark Otto's avatar
Mark Otto committed
99

Mark Otto's avatar
Mark Otto committed
100
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`).
Mark Otto's avatar
Mark Otto committed
101

m5o's avatar
m5o committed
102
{% capture example %}
Mark Otto's avatar
Mark Otto committed
103
<ul class="nav flex-column">
104
  <li class="nav-item">
105
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
106
  </li>
Mark Otto's avatar
Mark Otto committed
107
  <li class="nav-item">
108
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
109
  </li>
Mark Otto's avatar
Mark Otto committed
110
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
111
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
112
  </li>
113
  <li class="nav-item">
114
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
115
116
  </li>
</ul>
m5o's avatar
m5o committed
117
118
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
119

Mark Otto's avatar
Mark Otto committed
120
As always, vertical navigation is possible without `<ul>`s, too.
Mark Otto's avatar
Mark Otto committed
121

m5o's avatar
m5o committed
122
{% capture example %}
Mark Otto's avatar
Mark Otto committed
123
<nav class="nav flex-column">
Mark Otto's avatar
Mark Otto committed
124
125
126
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Link</a>
  <a class="nav-link" href="#">Link</a>
127
  <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
128
</nav>
m5o's avatar
m5o committed
129
130
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
131

Mark Otto's avatar
Mark Otto committed
132
### Tabs
Mark Otto's avatar
Mark Otto committed
133

Mark Otto's avatar
Mark Otto committed
134
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](#javascript-behavior).
Mark Otto's avatar
Mark Otto committed
135

m5o's avatar
m5o committed
136
{% capture example %}
Mark Otto's avatar
Mark Otto committed
137
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
138
  <li class="nav-item">
139
    <a class="nav-link active" href="#">Active</a>
140
  </li>
Mark Otto's avatar
Mark Otto committed
141
142
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
143
  </li>
Mark Otto's avatar
Mark Otto committed
144
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
145
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
146
  </li>
147
  <li class="nav-item">
148
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
149
150
  </li>
</ul>
m5o's avatar
m5o committed
151
152
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
153

Mark Otto's avatar
Mark Otto committed
154
155
156
### Pills

Take that same HTML, but use `.nav-pills` instead:
Mark Otto's avatar
Mark Otto committed
157

m5o's avatar
m5o committed
158
{% capture example %}
Mark Otto's avatar
Mark Otto committed
159
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
160
  <li class="nav-item">
161
    <a class="nav-link active" href="#">Active</a>
162
  </li>
Mark Otto's avatar
Mark Otto committed
163
164
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
165
  </li>
Mark Otto's avatar
Mark Otto committed
166
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
167
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
168
  </li>
169
  <li class="nav-item">
170
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
171
172
  </li>
</ul>
m5o's avatar
m5o committed
173
174
{% endcapture %}
{% include example.html content=example %}
175

Mark Otto's avatar
Mark Otto committed
176
### Fill and justify
Mark Otto's avatar
Mark Otto committed
177

Mark Otto's avatar
Mark Otto committed
178
Force your `.nav`'s contents to extend the full available width one of two modifier classes. To proportionately fill all available space with your `.nav-item`s, use `.nav-fill`. Notice that all horizontal space is occupied, but not every nav item has the same width.
Mark Otto's avatar
Mark Otto committed
179

m5o's avatar
m5o committed
180
{% capture example %}
Mark Otto's avatar
Mark Otto committed
181
<ul class="nav nav-pills nav-fill">
Mark Otto's avatar
Mark Otto committed
182
183
184
185
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
186
    <a class="nav-link" href="#">Longer nav link</a>
Mark Otto's avatar
Mark Otto committed
187
188
189
190
191
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
192
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
193
194
  </li>
</ul>
m5o's avatar
m5o committed
195
196
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
197

198
199
When using a `<nav>`-based navigation, be sure to include `.nav-item` on the anchors.

m5o's avatar
m5o committed
200
{% capture example %}
201
202
203
204
<nav class="nav nav-pills nav-fill">
  <a class="nav-item nav-link active" href="#">Active</a>
  <a class="nav-item nav-link" href="#">Link</a>
  <a class="nav-item nav-link" href="#">Link</a>
205
  <a class="nav-item nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
206
</nav>
m5o's avatar
m5o committed
207
208
{% endcapture %}
{% include example.html content=example %}
209

Mark Otto's avatar
Mark Otto committed
210
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.
Mark Otto's avatar
Mark Otto committed
211

m5o's avatar
m5o committed
212
{% capture example %}
213
214
215
216
<nav class="nav nav-pills nav-justified">
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Longer nav link</a>
  <a class="nav-link" href="#">Link</a>
217
  <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
218
</nav>
m5o's avatar
m5o committed
219
220
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
221

222
223
Similar to the `.nav-fill` example using a `<nav>`-based navigation, be sure to include `.nav-item` on the anchors.

m5o's avatar
m5o committed
224
{% capture example %}
225
226
227
228
<nav class="nav nav-pills nav-justified">
  <a class="nav-item nav-link active" href="#">Active</a>
  <a class="nav-item nav-link" href="#">Link</a>
  <a class="nav-item nav-link" href="#">Link</a>
229
  <a class="nav-item nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
230
231
</nav>

m5o's avatar
m5o committed
232
233
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
234
235
## Working with flex utilities

236
If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/docs/{{ site.docs_version }}/utilities/flex/). 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.
Mark Otto's avatar
Mark Otto committed
237

m5o's avatar
m5o committed
238
{% capture example %}
Mark Otto's avatar
Mark Otto committed
239
240
241
242
<nav class="nav nav-pills flex-column flex-sm-row">
  <a class="flex-sm-fill text-sm-center nav-link active" href="#">Active</a>
  <a class="flex-sm-fill text-sm-center nav-link" href="#">Link</a>
  <a class="flex-sm-fill text-sm-center nav-link" href="#">Link</a>
243
  <a class="flex-sm-fill text-sm-center nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
244
</nav>
m5o's avatar
m5o committed
245
246
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
247
248
249
250
251

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

252
Note that navigation bars, even if visually styled as tabs with the `.nav-tabs` class, should **not** be given `role="tablist"`, `role="tab"` or `role="tabpanel"` attributes. These are only appropriate for dynamic tabbed interfaces, as described in the [<abbr title="Web Accessibility Initiative">WAI</abbr> <abbr title="Accessible Rich Internet Applications">ARIA</abbr> Authoring Practices](https://www.w3.org/TR/wai-aria-practices/#tabpanel). See [JavaScript behavior](#javascript-behavior) for dynamic tabbed interfaces in this section for an example.
253

Mark Otto's avatar
Mark Otto committed
254
255
## Using dropdowns

Mark Otto's avatar
Mark Otto committed
256
Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin]({{ site.baseurl }}/docs/{{ site.docs_version }}/components/dropdowns/#usage).
Mark Otto's avatar
Mark Otto committed
257
258
259

### Tabs with dropdowns

m5o's avatar
m5o committed
260
{% capture example %}
Mark Otto's avatar
Mark Otto committed
261
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
262
263
264
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
265
266
267
268
269
270
271
272
273
  <li class="nav-item dropdown">
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
    <div class="dropdown-menu">
      <a class="dropdown-item" href="#">Action</a>
      <a class="dropdown-item" href="#">Another action</a>
      <a class="dropdown-item" href="#">Something else here</a>
      <div class="dropdown-divider"></div>
      <a class="dropdown-item" href="#">Separated link</a>
    </div>
Mark Otto's avatar
Mark Otto committed
274
275
276
277
278
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
279
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
280
281
  </li>
</ul>
m5o's avatar
m5o committed
282
283
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
284

Mark Otto's avatar
Mark Otto committed
285
### Pills with dropdowns
Mark Otto's avatar
Mark Otto committed
286

m5o's avatar
m5o committed
287
{% capture example %}
Mark Otto's avatar
Mark Otto committed
288
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
289
290
291
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
292
293
294
295
296
297
298
299
300
  <li class="nav-item dropdown">
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
    <div class="dropdown-menu">
      <a class="dropdown-item" href="#">Action</a>
      <a class="dropdown-item" href="#">Another action</a>
      <a class="dropdown-item" href="#">Something else here</a>
      <div class="dropdown-divider"></div>
      <a class="dropdown-item" href="#">Separated link</a>
    </div>
Mark Otto's avatar
Mark Otto committed
301
302
303
304
305
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
306
    <a class="nav-link disabled" href="#" tabindex="-1" aria-disabled="true">Disabled</a>
Mark Otto's avatar
Mark Otto committed
307
308
  </li>
</ul>
m5o's avatar
m5o committed
309
310
{% endcapture %}
{% include example.html content=example %}
Mark Otto's avatar
Mark Otto committed
311

Mark Otto's avatar
Mark Otto committed
312
## JavaScript behavior
313
314
315

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.

316
If you're building our JavaScript from source, it [requires `util.js`]({{ site.baseurl }}/docs/{{ site.docs_version }}/getting-started/javascript/#util).
317

318
319
Dynamic tabbed interfaces, as described in the [<abbr title="Web Accessibility Initiative">WAI</abbr> <abbr title="Accessible Rich Internet Applications">ARIA</abbr> Authoring Practices](https://www.w3.org/TR/wai-aria-practices/#tabpanel), require `role="tablist"`, `role="tab"`, `role="tabpanel"`, and additional `aria-` attributes in order to convey their structure, functionality and current state to users of assistive technologies (such as screen readers).

320
321
Note that dynamic tabbed interfaces should <em>not</em> contain dropdown menus, as this causes both usability and accessibility issues. From a usability perspective, the fact that the currently displayed tab's trigger element is not immediately visible (as it's inside the closed dropdown menu) can cause confusion. From an accessibility point of view, there is currently no sensible way to map this sort of construct to a standard WAI ARIA pattern, meaning that it cannot be easily made understandable to users of assistive technologies.

322
<div class="bd-example bd-example-tabs">
323
  <ul class="nav nav-tabs" id="myTab" role="tablist">
324
    <li class="nav-item">
325
      <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
326
    </li>
Jacob Thornton's avatar
Jacob Thornton committed
327
    <li class="nav-item">
328
      <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
329
    </li>
330
331
    <li class="nav-item">
      <a class="nav-link" id="contact-tab" data-toggle="tab" href="#contact" role="tab" aria-controls="contact" aria-selected="false">Contact</a>
332
333
    </li>
  </ul>
334
  <div class="tab-content" id="myTabContent">
335
    <div class="tab-pane fade show active" id="home" role="tabpanel" aria-labelledby="home-tab">
336
337
      <p>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.</p>
    </div>
338
    <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledby="profile-tab">
339
340
      <p>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.</p>
    </div>
341
    <div class="tab-pane fade" id="contact" role="tabpanel" aria-labelledby="contact-tab">
342
343
344
345
346
      <p>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.</p>
    </div>
  </div>
</div>

347
348
349
{% highlight html %}
<ul class="nav nav-tabs" id="myTab" role="tablist">
  <li class="nav-item">
350
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
351
352
  </li>
  <li class="nav-item">
353
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
354
  </li>
355
356
  <li class="nav-item">
    <a class="nav-link" id="contact-tab" data-toggle="tab" href="#contact" role="tab" aria-controls="contact" aria-selected="false">Contact</a>
357
358
359
360
361
  </li>
</ul>
<div class="tab-content" id="myTabContent">
  <div class="tab-pane fade show active" id="home" role="tabpanel" aria-labelledby="home-tab">...</div>
  <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledby="profile-tab">...</div>
362
  <div class="tab-pane fade" id="contact" role="tabpanel" aria-labelledby="contact-tab">...</div>
363
364
365
</div>
{% endhighlight %}

M. Appelman's avatar
M. Appelman committed
366
To help fit your needs, this works with `<ul>`-based markup, as shown above, or with any arbitrary "roll your own" markup. Note that if you're using `<nav>`, you shouldn't add `role="tablist"` directly to it, as this would override the element's native role as a navigation landmark. Instead, switch to an alternative element (in the example below, a simple `<div>`) and wrap the `<nav>` around it.
367

368
<div class="bd-example bd-example-tabs">
369
370
371
372
373
374
  <nav>
    <div class="nav nav-tabs" id="nav-tab" role="tablist">
      <a class="nav-item nav-link active" id="nav-home-tab" data-toggle="tab" href="#nav-home" role="tab" aria-controls="nav-home" aria-selected="true">Home</a>
      <a class="nav-item nav-link" id="nav-profile-tab" data-toggle="tab" href="#nav-profile" role="tab" aria-controls="nav-profile" aria-selected="false">Profile</a>
      <a class="nav-item nav-link" id="nav-contact-tab" data-toggle="tab" href="#nav-contact" role="tab" aria-controls="nav-contact" aria-selected="false">Contact</a>
    </div>
375
  </nav>
376
377
378
379
380
381
382
  <div class="tab-content" id="nav-tabContent">
    <div class="tab-pane fade show active" id="nav-home" role="tabpanel" aria-labelledby="nav-home-tab">
      <p>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.</p>
    </div>
    <div class="tab-pane fade" id="nav-profile" role="tabpanel" aria-labelledby="nav-profile-tab">
      <p>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.</p>
    </div>
383
    <div class="tab-pane fade" id="nav-contact" role="tabpanel" aria-labelledby="nav-contact-tab">
384
385
386
387
388
389
      <p>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.</p>
    </div>
  </div>
</div>

{% highlight html %}
390
391
392
393
394
395
<nav>
  <div class="nav nav-tabs" id="nav-tab" role="tablist">
    <a class="nav-item nav-link active" id="nav-home-tab" data-toggle="tab" href="#nav-home" role="tab" aria-controls="nav-home" aria-selected="true">Home</a>
    <a class="nav-item nav-link" id="nav-profile-tab" data-toggle="tab" href="#nav-profile" role="tab" aria-controls="nav-profile" aria-selected="false">Profile</a>
    <a class="nav-item nav-link" id="nav-contact-tab" data-toggle="tab" href="#nav-contact" role="tab" aria-controls="nav-contact" aria-selected="false">Contact</a>
  </div>
396
</nav>
397
398
399
<div class="tab-content" id="nav-tabContent">
  <div class="tab-pane fade show active" id="nav-home" role="tabpanel" aria-labelledby="nav-home-tab">...</div>
  <div class="tab-pane fade" id="nav-profile" role="tabpanel" aria-labelledby="nav-profile-tab">...</div>
400
  <div class="tab-pane fade" id="nav-contact" role="tabpanel" aria-labelledby="nav-contact-tab">...</div>
401
402
403
404
405
</div>
{% endhighlight %}

The tabs plugin also works with pills.

406
<div class="bd-example bd-example-tabs">
407
408
  <ul class="nav nav-pills mb-3" id="pills-tab" role="tablist">
    <li class="nav-item">
409
      <a class="nav-link active" id="pills-home-tab" data-toggle="pill" href="#pills-home" role="tab" aria-controls="pills-home" aria-selected="true">Home</a>
410
411
    </li>
    <li class="nav-item">
412
      <a class="nav-link" id="pills-profile-tab" data-toggle="pill" href="#pills-profile" role="tab" aria-controls="pills-profile" aria-selected="false">Profile</a>
413
    </li>
414
415
    <li class="nav-item">
      <a class="nav-link" id="pills-contact-tab" data-toggle="pill" href="#pills-contact" role="tab" aria-controls="pills-contact" aria-selected="false">Contact</a>
416
417
418
419
420
421
422
423
424
    </li>
  </ul>
  <div class="tab-content" id="pills-tabContent">
    <div class="tab-pane fade show active" id="pills-home" role="tabpanel" aria-labelledby="pills-home-tab">
      <p>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.</p>
    </div>
    <div class="tab-pane fade" id="pills-profile" role="tabpanel" aria-labelledby="pills-profile-tab">
      <p>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.</p>
    </div>
425
    <div class="tab-pane fade" id="pills-contact" role="tabpanel" aria-labelledby="pills-contact-tab">
426
427
428
429
430
431
432
433
      <p>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.</p>
    </div>
  </div>
</div>

{% highlight html %}
<ul class="nav nav-pills mb-3" id="pills-tab" role="tablist">
  <li class="nav-item">
434
    <a class="nav-link active" id="pills-home-tab" data-toggle="pill" href="#pills-home" role="tab" aria-controls="pills-home" aria-selected="true">Home</a>
435
436
  </li>
  <li class="nav-item">
437
    <a class="nav-link" id="pills-profile-tab" data-toggle="pill" href="#pills-profile" role="tab" aria-controls="pills-profile" aria-selected="false">Profile</a>
438
  </li>
439
440
  <li class="nav-item">
    <a class="nav-link" id="pills-contact-tab" data-toggle="pill" href="#pills-contact" role="tab" aria-controls="pills-contact" aria-selected="false">Contact</a>
441
442
443
444
445
  </li>
</ul>
<div class="tab-content" id="pills-tabContent">
  <div class="tab-pane fade show active" id="pills-home" role="tabpanel" aria-labelledby="pills-home-tab">...</div>
  <div class="tab-pane fade" id="pills-profile" role="tabpanel" aria-labelledby="pills-profile-tab">...</div>
446
  <div class="tab-pane fade" id="pills-contact" role="tabpanel" aria-labelledby="pills-contact-tab">...</div>
447
448
449
450
451
</div>
{% endhighlight %}

And with vertical pills.

452
<div class="bd-example bd-example-tabs">
453
454
  <div class="row">
    <div class="col-3">
455
456
457
458
459
      <div class="nav flex-column nav-pills" id="v-pills-tab" role="tablist" aria-orientation="vertical">
        <a class="nav-link active" id="v-pills-home-tab" data-toggle="pill" href="#v-pills-home" role="tab" aria-controls="v-pills-home" aria-selected="true">Home</a>
        <a class="nav-link" id="v-pills-profile-tab" data-toggle="pill" href="#v-pills-profile" role="tab" aria-controls="v-pills-profile" aria-selected="false">Profile</a>
        <a class="nav-link" id="v-pills-messages-tab" data-toggle="pill" href="#v-pills-messages" role="tab" aria-controls="v-pills-messages" aria-selected="false">Messages</a>
        <a class="nav-link" id="v-pills-settings-tab" data-toggle="pill" href="#v-pills-settings" role="tab" aria-controls="v-pills-settings" aria-selected="false">Settings</a>
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
      </div>
    </div>
    <div class="col-9">
      <div class="tab-content" id="v-pills-tabContent">
        <div class="tab-pane fade show active" id="v-pills-home" role="tabpanel" aria-labelledby="v-pills-home-tab">
          <p>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.</p>
        </div>
        <div class="tab-pane fade" id="v-pills-profile" role="tabpanel" aria-labelledby="v-pills-profile-tab">
          <p>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.</p>
        </div>
        <div class="tab-pane fade" id="v-pills-messages" role="tabpanel" aria-labelledby="v-pills-messages-tab">
          <p>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.</p>
        </div>
        <div class="tab-pane fade" id="v-pills-settings" role="tabpanel" aria-labelledby="v-pills-settings-tab">
          <p>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.</p>
        </div>
      </div>
    </div>
  </div>
</div>

{% highlight html %}
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
<div class="row">
  <div class="col-3">
    <div class="nav flex-column nav-pills" id="v-pills-tab" role="tablist" aria-orientation="vertical">
      <a class="nav-link active" id="v-pills-home-tab" data-toggle="pill" href="#v-pills-home" role="tab" aria-controls="v-pills-home" aria-selected="true">Home</a>
      <a class="nav-link" id="v-pills-profile-tab" data-toggle="pill" href="#v-pills-profile" role="tab" aria-controls="v-pills-profile" aria-selected="false">Profile</a>
      <a class="nav-link" id="v-pills-messages-tab" data-toggle="pill" href="#v-pills-messages" role="tab" aria-controls="v-pills-messages" aria-selected="false">Messages</a>
      <a class="nav-link" id="v-pills-settings-tab" data-toggle="pill" href="#v-pills-settings" role="tab" aria-controls="v-pills-settings" aria-selected="false">Settings</a>
    </div>
  </div>
  <div class="col-9">
    <div class="tab-content" id="v-pills-tabContent">
      <div class="tab-pane fade show active" id="v-pills-home" role="tabpanel" aria-labelledby="v-pills-home-tab">...</div>
      <div class="tab-pane fade" id="v-pills-profile" role="tabpanel" aria-labelledby="v-pills-profile-tab">...</div>
      <div class="tab-pane fade" id="v-pills-messages" role="tabpanel" aria-labelledby="v-pills-messages-tab">...</div>
      <div class="tab-pane fade" id="v-pills-settings" role="tabpanel" aria-labelledby="v-pills-settings-tab">...</div>
    </div>
  </div>
499
500
501
</div>
{% endhighlight %}

502
503
504
505
506
507
### 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 %}
<!-- Nav tabs -->
508
<ul class="nav nav-tabs" id="myTab" role="tablist">
509
  <li class="nav-item">
510
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
Jacob Thornton's avatar
Jacob Thornton committed
511
512
  </li>
  <li class="nav-item">
513
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
Jacob Thornton's avatar
Jacob Thornton committed
514
515
  </li>
  <li class="nav-item">
516
    <a class="nav-link" id="messages-tab" data-toggle="tab" href="#messages" role="tab" aria-controls="messages" aria-selected="false">Messages</a>
Jacob Thornton's avatar
Jacob Thornton committed
517
518
  </li>
  <li class="nav-item">
519
    <a class="nav-link" id="settings-tab" data-toggle="tab" href="#settings" role="tab" aria-controls="settings" aria-selected="false">Settings</a>
Jacob Thornton's avatar
Jacob Thornton committed
520
  </li>
521
522
523
524
</ul>

<!-- Tab panes -->
<div class="tab-content">
525
526
527
528
  <div class="tab-pane active" id="home" role="tabpanel" aria-labelledby="home-tab">...</div>
  <div class="tab-pane" id="profile" role="tabpanel" aria-labelledby="profile-tab">...</div>
  <div class="tab-pane" id="messages" role="tabpanel" aria-labelledby="messages-tab">...</div>
  <div class="tab-pane" id="settings" role="tabpanel" aria-labelledby="settings-tab">...</div>
529
530
531
532
533
534
535
536
</div>
{% endhighlight %}

### Via JavaScript

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

{% highlight js %}
vsn4ik's avatar
vsn4ik committed
537
$('#myTab a').on('click', function (e) {
538
539
540
541
542
543
544
545
546
  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
547
548
549
$('#myTab li:first-child a').tab('show') // Select first tab
$('#myTab li:last-child a').tab('show') // Select last tab
$('#myTab li:nth-child(3) a').tab('show') // Select third tab
550
551
552
553
{% endhighlight %}

### Fade effect

Starsam80's avatar
Starsam80 committed
554
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.
555
556
557

{% highlight html %}
<div class="tab-content">
558
559
560
561
  <div class="tab-pane fade show active" id="home" role="tabpanel" aria-labelledby="home-tab">...</div>
  <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledby="profile-tab">...</div>
  <div class="tab-pane fade" id="messages" role="tabpanel" aria-labelledby="messages-tab">...</div>
  <div class="tab-pane fade" id="settings" role="tabpanel" aria-labelledby="settings-tab">...</div>
562
563
564
565
566
</div>
{% endhighlight %}

### Methods

567
{% include callout-danger-async-methods.md %}
568

569
570
571
572
573
#### $().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 %}
574
<ul class="nav nav-tabs" id="myTab" role="tablist">
575
  <li class="nav-item">
576
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
577
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
578
  <li class="nav-item">
579
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
580
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
581
  <li class="nav-item">
582
    <a class="nav-link" id="messages-tab" data-toggle="tab" href="#messages" role="tab" aria-controls="messages" aria-selected="false">Messages</a>
583
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
584
  <li class="nav-item">
585
    <a class="nav-link" id="settings-tab" data-toggle="tab" href="#settings" role="tab" aria-controls="settings" aria-selected="false">Settings</a>
586
587
588
589
  </li>
</ul>

<div class="tab-content">
590
591
592
593
  <div class="tab-pane active" id="home" role="tabpanel" aria-labelledby="home-tab">...</div>
  <div class="tab-pane" id="profile" role="tabpanel" aria-labelledby="profile-tab">...</div>
  <div class="tab-pane" id="messages" role="tabpanel" aria-labelledby="messages-tab">...</div>
  <div class="tab-pane" id="settings" role="tabpanel" aria-labelledby="settings-tab">...</div>
594
595
596
597
</div>

<script>
  $(function () {
598
    $('#myTab li:last-child a').tab('show')
599
600
601
602
  })
</script>
{% endhighlight %}

603
604
#### .tab('show')

605
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).
606
607
608
609
610

{% highlight js %}
$('#someTab').tab('show')
{% endhighlight %}

611
#### .tab('dispose')
612
613
614

Destroys an element's tab.

615
616
617
618
619
620
621
622
623
624
625
### 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.

Mark Otto's avatar
Mark Otto committed
626
<table class="table table-bordered table-striped">
627
  <thead>
628
629
630
631
    <tr>
      <th style="width: 150px;">Event Type</th>
      <th>Description</th>
    </tr>
632
633
634
635
636
  </thead>
  <tbody>
    <tr>
      <td>show.bs.tab</td>
      <td>This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
637
638
    </tr>
    <tr>
639
640
641
642
643
644
645
646
647
648
649
650
651
      <td>shown.bs.tab</td>
      <td>This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
    </tr>
    <tr>
      <td>hide.bs.tab</td>
      <td>This event fires when a new tab is to be shown (and thus the previous active tab is to be hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the current active tab and the new soon-to-be-active tab, respectively.</td>
    </tr>
    <tr>
      <td>hidden.bs.tab</td>
      <td>This event fires after a new tab is shown (and thus the previous active tab is hidden). Use <code>event.target</code> and <code>event.relatedTarget</code> to target the previous active tab and the new active tab, respectively.</td>
    </tr>
  </tbody>
</table>
652
653
654
655
656
657
658

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