navs.md 34 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
15
16
17
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 %}
Mark Otto's avatar
Mark Otto committed
18
19

{% example html %}
Mark Otto's avatar
Mark Otto committed
20
<ul class="nav">
Mark Otto's avatar
Mark Otto committed
21
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
22
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
23
24
25
26
27
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
28
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
29
  </li>
30
31
  <li class="nav-item">
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
32
33
34
35
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
36
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. 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
37
38

{% example html %}
Mark Otto's avatar
Mark Otto committed
39
<nav class="nav">
Mark Otto's avatar
Mark Otto committed
40
41
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
42
  <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
43
44
45
46
  <a class="nav-link disabled" href="#">Disabled</a>
</nav>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
47
## Available styles
48

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

Mark Otto's avatar
Mark Otto committed
51
### Horizontal alignment
52

Mark Otto's avatar
Mark Otto committed
53
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
54

Mark Otto's avatar
Mark Otto committed
55
Centered with `.justify-content-center`:
Mark Otto's avatar
Mark Otto committed
56
57

{% example html %}
Mark Otto's avatar
Mark Otto committed
58
<ul class="nav justify-content-center">
59
  <li class="nav-item">
60
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
61
  </li>
Mark Otto's avatar
Mark Otto committed
62
  <li class="nav-item">
63
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
64
  </li>
Mark Otto's avatar
Mark Otto committed
65
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
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">
69
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
70
71
72
73
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
74
Right-aligned with `.justify-content-end`:
Mark Otto's avatar
Mark Otto committed
75
76

{% example html %}
Mark Otto's avatar
Mark Otto committed
77
<ul class="nav justify-content-end">
78
  <li class="nav-item">
79
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
80
  </li>
Mark Otto's avatar
Mark Otto committed
81
  <li class="nav-item">
82
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
83
  </li>
Mark Otto's avatar
Mark Otto committed
84
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
85
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
86
  </li>
87
  <li class="nav-item">
88
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
89
90
91
92
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
93
### Vertical
Mark Otto's avatar
Mark Otto committed
94

Mark Otto's avatar
Mark Otto committed
95
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
96
97

{% example html %}
Mark Otto's avatar
Mark Otto committed
98
<ul class="nav flex-column">
99
  <li class="nav-item">
100
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
101
  </li>
Mark Otto's avatar
Mark Otto committed
102
  <li class="nav-item">
103
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
104
  </li>
Mark Otto's avatar
Mark Otto committed
105
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
106
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
107
  </li>
108
  <li class="nav-item">
109
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
110
111
112
113
  </li>
</ul>
{% endexample %}

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
117
<nav class="nav flex-column">
Mark Otto's avatar
Mark Otto committed
118
119
120
121
122
123
124
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Link</a>
  <a class="nav-link" href="#">Link</a>
  <a class="nav-link disabled" href="#">Disabled</a>
</nav>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
125
### Tabs
Mark Otto's avatar
Mark Otto committed
126

Mark Otto's avatar
Mark Otto committed
127
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
128
129

{% example html %}
Mark Otto's avatar
Mark Otto committed
130
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
131
  <li class="nav-item">
132
    <a class="nav-link active" href="#">Active</a>
133
  </li>
Mark Otto's avatar
Mark Otto committed
134
135
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
136
  </li>
Mark Otto's avatar
Mark Otto committed
137
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
138
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
139
  </li>
140
  <li class="nav-item">
141
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
142
143
144
145
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
146
147
148
### Pills

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

{% example html %}
Mark Otto's avatar
Mark Otto committed
151
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
152
  <li class="nav-item">
153
    <a class="nav-link active" href="#">Active</a>
154
  </li>
Mark Otto's avatar
Mark Otto committed
155
156
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
157
  </li>
Mark Otto's avatar
Mark Otto committed
158
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
159
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
160
  </li>
161
  <li class="nav-item">
162
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
163
164
165
  </li>
</ul>
{% endexample %}
166

Mark Otto's avatar
Mark Otto committed
167
### Fill and justify
Mark Otto's avatar
Mark Otto committed
168

Mark Otto's avatar
Mark Otto committed
169
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
170
171

{% example html %}
Mark Otto's avatar
Mark Otto committed
172
<ul class="nav nav-pills nav-fill">
Mark Otto's avatar
Mark Otto committed
173
174
175
176
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
177
    <a class="nav-link" href="#">Longer nav link</a>
Mark Otto's avatar
Mark Otto committed
178
179
180
181
182
183
184
185
186
187
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
    <a class="nav-link disabled" href="#">Disabled</a>
  </li>
</ul>
{% endexample %}

188
189
190
191
192
193
194
195
196
197
198
When using a `<nav>`-based navigation, be sure to include `.nav-item` on the anchors.

{% example html %}
<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>
  <a class="nav-item nav-link disabled" href="#">Disabled</a>
</nav>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
199
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
200
201

{% example html %}
202
203
204
205
206
207
<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>
  <a class="nav-link disabled" href="#">Disabled</a>
</nav>
Mark Otto's avatar
Mark Otto committed
208
209
{% endexample %}

210
211
212
213
214
215
216
217
218
219
220
Similar to the `.nav-fill` example using a `<nav>`-based navigation, be sure to include `.nav-item` on the anchors.

{% example html %}
<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>
  <a class="nav-item nav-link disabled" href="#">Disabled</a>
</nav>

{% endexample %}
Mark Otto's avatar
Mark Otto committed
221
222
## Working with flex utilities

223
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
224
225

{% example html %}
Mark Otto's avatar
Mark Otto committed
226
227
228
229
230
231
232
233
234
235
236
237
<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>
  <a class="flex-sm-fill text-sm-center nav-link disabled" href="#">Disabled</a>
</nav>
{% 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 `<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.

238
239
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 for dynamic tabbed interfaces](#javascript-behavior-for-dynamic-tabbed-interfaces) in this section for an example.

Mark Otto's avatar
Mark Otto committed
240
241
## Using dropdowns

Mark Otto's avatar
Mark Otto committed
242
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
243
244
245
246
247

### Tabs with dropdowns

{% example html %}
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
248
249
250
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
251
252
253
254
255
256
257
258
259
  <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
260
261
262
263
264
265
266
267
268
269
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
    <a class="nav-link disabled" href="#">Disabled</a>
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
270
### Pills with dropdowns
Mark Otto's avatar
Mark Otto committed
271
272

{% example html %}
Mark Otto's avatar
Mark Otto committed
273
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
274
275
276
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
277
278
279
280
281
282
283
284
285
  <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
286
287
288
289
290
291
292
293
294
295
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
    <a class="nav-link disabled" href="#">Disabled</a>
  </li>
</ul>
{% endexample %}

Mark Otto's avatar
Mark Otto committed
296
## JavaScript behavior
297
298
299

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.

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

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

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

306
<div class="bd-example bd-example-tabs">
307
  <ul class="nav nav-tabs" id="myTab" role="tablist">
308
    <li class="nav-item">
309
      <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
310
    </li>
Jacob Thornton's avatar
Jacob Thornton committed
311
    <li class="nav-item">
312
      <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
313
    </li>
314
315
    <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>
316
317
    </li>
  </ul>
318
  <div class="tab-content" id="myTabContent">
319
    <div class="tab-pane fade show active" id="home" role="tabpanel" aria-labelledby="home-tab">
320
321
      <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>
322
    <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledby="profile-tab">
323
324
      <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>
325
    <div class="tab-pane fade" id="contact" role="tabpanel" aria-labelledby="contact-tab">
326
327
328
329
330
      <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>

331
332
333
{% highlight html %}
<ul class="nav nav-tabs" id="myTab" role="tablist">
  <li class="nav-item">
334
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
335
336
  </li>
  <li class="nav-item">
337
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
338
  </li>
339
340
  <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>
341
342
343
344
345
  </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>
346
  <div class="tab-pane fade" id="contact" role="tabpanel" aria-labelledby="contact-tab">...</div>
347
348
349
350
351
</div>
{% endhighlight %}

To help fit your needs, this works with `<ul>`-based markup, as shown above, as well as `<nav>`-based markup shown below.

352
<div class="bd-example bd-example-tabs">
353
  <nav class="nav nav-tabs" id="nav-tab" role="tablist">
354
355
356
    <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>
357
  </nav>
358
359
360
361
362
363
364
  <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>
365
    <div class="tab-pane fade" id="nav-contact" role="tabpanel" aria-labelledby="nav-contact-tab">
366
367
368
369
370
371
      <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 %}
372
<nav class="nav nav-tabs" id="myTab" role="tablist">
373
374
375
  <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>
376
</nav>
377
378
379
<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>
380
  <div class="tab-pane fade" id="nav-contact" role="tabpanel" aria-labelledby="nav-contact-tab">...</div>
381
382
383
384
385
</div>
{% endhighlight %}

The tabs plugin also works with pills.

386
<div class="bd-example bd-example-tabs">
387
388
  <ul class="nav nav-pills mb-3" id="pills-tab" role="tablist">
    <li class="nav-item">
389
      <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>
390
391
    </li>
    <li class="nav-item">
392
      <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>
393
    </li>
394
395
    <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>
396
397
398
399
400
401
402
403
404
    </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>
405
    <div class="tab-pane fade" id="pills-contact" role="tabpanel" aria-labelledby="pills-contact-tab">
406
407
408
409
410
411
412
413
      <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">
414
    <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>
415
416
  </li>
  <li class="nav-item">
417
    <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>
418
  </li>
419
420
  <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>
421
422
423
424
425
  </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>
426
  <div class="tab-pane fade" id="pills-contact" role="tabpanel" aria-labelledby="pills-contact-tab">...</div>
427
428
429
430
431
</div>
{% endhighlight %}

And with vertical pills.

432
<div class="bd-example bd-example-tabs">
433
434
  <div class="row">
    <div class="col-3">
435
436
437
438
439
      <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>
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
      </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 %}
462
463
464
465
466
<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>
467
468
469
470
471
472
473
474
475
</div>
<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>
{% endhighlight %}

476
477
478
479
480
481
### 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 -->
482
<ul class="nav nav-tabs" id="myTab" role="tablist">
483
  <li class="nav-item">
484
    <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
485
486
  </li>
  <li class="nav-item">
487
    <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
488
489
  </li>
  <li class="nav-item">
490
    <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
491
492
  </li>
  <li class="nav-item">
493
    <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
494
  </li>
495
496
497
498
</ul>

<!-- Tab panes -->
<div class="tab-content">
499
500
501
502
  <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>
503
504
505
506
507
508
509
510
</div>
{% endhighlight %}

### Via JavaScript

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

{% highlight js %}
vsn4ik's avatar
vsn4ik committed
511
$('#myTab a').on('click', function (e) {
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
  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

Starsam80's avatar
Starsam80 committed
528
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.
529
530
531

{% highlight html %}
<div class="tab-content">
532
533
534
535
  <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>
536
537
538
539
540
</div>
{% endhighlight %}

### Methods

541
542
543
{% capture callout-include %}{% include callout-danger-async-methods.md %}{% endcapture %}
{{ callout-include | markdownify }}

544
545
546
547
548
#### $().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 %}
549
<ul class="nav nav-tabs" id="myTab" role="tablist">
550
  <li class="nav-item">
551
    <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-selected="true">Home</a>
552
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
553
  <li class="nav-item">
554
    <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile" aria-selected="false">Profile</a>
555
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
556
  <li class="nav-item">
557
    <a class="nav-link" id="messages-tab" data-toggle="tab" href="#messages" role="tab" aria-controls="messages" aria-selected="false">Messages</a>
558
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
559
  <li class="nav-item">
560
    <a class="nav-link" id="settings-tab" data-toggle="tab" href="#settings" role="tab" aria-controls="settings" aria-selected="false">Settings</a>
561
562
563
564
  </li>
</ul>

<div class="tab-content">
565
566
567
568
  <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>
569
570
571
572
573
574
575
576
577
</div>

<script>
  $(function () {
    $('#myTab a:last').tab('show')
  })
</script>
{% endhighlight %}

578
579
#### .tab('show')

580
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).
581
582
583
584
585

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

586
587
588
589
### .tab('dispose')

Destroys an element's tab.

590
591
592
593
594
595
596
597
598
599
600
### 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.

601
<table class="table table-bordered table-striped table-responsive">
602
  <thead>
603
604
605
606
    <tr>
      <th style="width: 150px;">Event Type</th>
      <th>Description</th>
    </tr>
607
608
609
610
611
  </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>
612
613
    </tr>
    <tr>
614
615
616
617
618
619
620
621
622
623
624
625
626
      <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>
627
628
629
630
631
632
633

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