navs.md 19.2 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
7
8
9
---

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.

Mark Otto's avatar
Mark Otto committed
10
11
12
13
14
## Contents

* Will be replaced with the ToC, excluding the "Contents" header
{:toc}

Mark Otto's avatar
Mark Otto committed
15
## Base nav
Mark Otto's avatar
Mark Otto committed
16

Mark Otto's avatar
Mark Otto committed
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. No active states are included in the base nav.
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 }}/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 %}
Mark Otto's avatar
Mark Otto committed
202
<ul class="nav nav-pills nav-justified">
Mark Otto's avatar
Mark Otto committed
203
204
205
206
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
207
    <a class="nav-link" href="#">Longer nav link</a>
Mark Otto's avatar
Mark Otto committed
208
209
210
211
212
213
214
215
216
217
  </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 %}

218
219
220
221
222
223
224
225
226
227
228
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
229
230
## Working with flex utilities

Quy's avatar
Quy committed
231
If you need responsive nav variations, consider using a series of [flexbox utilities]({{ site.baseurl }}/utilities/flexbox/). While more verbose, these utilities offer greater customization across responsive breakpoints. In the example below, our nav will be stacked on the lowest breakpoint, then adapt to a horizontal layout that fills the available width starting from the small breakpoint.
Mark Otto's avatar
Mark Otto committed
232
233

{% example html %}
Mark Otto's avatar
Mark Otto committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<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.

## 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 %}
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
254
255
256
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
257
258
259
260
261
262
263
264
265
  <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
266
267
268
269
270
271
272
273
274
275
  </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
276
### Pills with dropdowns
Mark Otto's avatar
Mark Otto committed
277
278

{% example html %}
Mark Otto's avatar
Mark Otto committed
279
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
280
281
282
  <li class="nav-item">
    <a class="nav-link active" href="#">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
283
284
285
286
287
288
289
290
291
  <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
292
293
294
295
296
297
298
299
300
301
  </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 %}

302
303
304
305
306
## 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.

<div class="bd-example bd-example-tabs" role="tabpanel">
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-expanded="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">Profile</a>
313
    </li>
Jacob Thornton's avatar
Jacob Thornton committed
314
315
    <li class="nav-item dropdown">
      <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
316
317
        Dropdown
      </a>
Mark Otto's avatar
Mark Otto committed
318
      <div class="dropdown-menu">
319
320
        <a class="dropdown-item" id="dropdown1-tab" href="#dropdown1" role="tab" data-toggle="tab" aria-controls="dropdown1">@fat</a>
        <a class="dropdown-item" id="dropdown2-tab" href="#dropdown2" role="tab" data-toggle="tab" aria-controls="dropdown2">@mdo</a>
Mark Otto's avatar
Mark Otto committed
321
      </div>
322
323
    </li>
  </ul>
324
  <div class="tab-content" id="myTabContent">
Starsam80's avatar
Starsam80 committed
325
    <div role="tabpanel" class="tab-pane fade show active" id="home" aria-labelledBy="home-tab">
326
327
      <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>
328
    <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledBy="profile-tab">
329
330
      <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>
331
    <div class="tab-pane fade" id="dropdown1" role="tabpanel" aria-labelledBy="dropdown1-tab">
332
333
      <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>
334
    <div class="tab-pane fade" id="dropdown2" role="tabpanel" aria-labelledBy="dropdown2-tab">
335
336
337
338
339
340
341
342
343
344
345
346
347
      <p>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.</p>
    </div>
  </div>
</div>

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

<div role="tabpanel">
{% highlight html %}
<!-- Nav tabs -->
<ul class="nav nav-tabs" role="tablist">
348
  <li class="nav-item">
349
    <a class="nav-link active" data-toggle="tab" href="#home" role="tab">Home</a>
Jacob Thornton's avatar
Jacob Thornton committed
350
351
  </li>
  <li class="nav-item">
352
    <a class="nav-link" data-toggle="tab" href="#profile" role="tab">Profile</a>
Jacob Thornton's avatar
Jacob Thornton committed
353
354
  </li>
  <li class="nav-item">
355
    <a class="nav-link" data-toggle="tab" href="#messages" role="tab">Messages</a>
Jacob Thornton's avatar
Jacob Thornton committed
356
357
  </li>
  <li class="nav-item">
358
    <a class="nav-link" data-toggle="tab" href="#settings" role="tab">Settings</a>
Jacob Thornton's avatar
Jacob Thornton committed
359
  </li>
360
361
362
363
</ul>

<!-- Tab panes -->
<div class="tab-content">
364
365
366
367
  <div class="tab-pane active" id="home" role="tabpanel">...</div>
  <div class="tab-pane" id="profile" role="tabpanel">...</div>
  <div class="tab-pane" id="messages" role="tabpanel">...</div>
  <div class="tab-pane" id="settings" role="tabpanel">...</div>
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
</div>
{% endhighlight %}
</div>

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

Starsam80's avatar
Starsam80 committed
394
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.
395
396
397

{% highlight html %}
<div class="tab-content">
Starsam80's avatar
Starsam80 committed
398
  <div class="tab-pane fade show active" id="home" role="tabpanel">...</div>
399
400
401
  <div class="tab-pane fade" id="profile" role="tabpanel">...</div>
  <div class="tab-pane fade" id="messages" role="tabpanel">...</div>
  <div class="tab-pane fade" id="settings" role="tabpanel">...</div>
402
403
404
405
406
407
408
409
410
411
</div>
{% endhighlight %}

### Methods

#### $().tab

Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the DOM.

{% highlight html %}
412
<ul class="nav nav-tabs" id="myTab" role="tablist">
413
  <li class="nav-item">
414
    <a class="nav-link active" data-toggle="tab" href="#home" role="tab" aria-controls="home">Home</a>
415
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
416
  <li class="nav-item">
417
    <a class="nav-link" data-toggle="tab" href="#profile" role="tab" aria-controls="profile">Profile</a>
418
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
419
  <li class="nav-item">
420
    <a class="nav-link" data-toggle="tab" href="#messages" role="tab" aria-controls="messages">Messages</a>
421
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
422
  <li class="nav-item">
423
    <a class="nav-link" data-toggle="tab" href="#settings" role="tab" aria-controls="settings">Settings</a>
424
425
426
427
  </li>
</ul>

<div class="tab-content">
428
429
430
431
  <div class="tab-pane active" id="home" role="tabpanel">...</div>
  <div class="tab-pane" id="profile" role="tabpanel">...</div>
  <div class="tab-pane" id="messages" role="tabpanel">...</div>
  <div class="tab-pane" id="settings" role="tabpanel">...</div>
432
433
434
435
436
437
438
439
440
</div>

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

441
442
#### .tab('show')

443
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).
444
445
446
447
448

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

449
450
451
452
453
454
455
456
457
458
459
### 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.

460
<table class="table table-bordered table-striped table-responsive">
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
  <thead>
   <tr>
     <th style="width: 150px;">Event Type</th>
     <th>Description</th>
   </tr>
  </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>
   </tr>
   <tr>
      <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>
486
487
488
489
490
491
492

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