navs.md 15.3 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
4
group: components
Mark Otto's avatar
Mark Otto committed
5
6
7
8
---

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
9
10
11
12
13
## Contents

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

Mark Otto's avatar
Mark Otto committed
14
15
16
17
## Regarding accessibility

If you are using navs to provide a navigation bar, be sure to add a `role="navigation"` to the most logical parent container of the `<ul>`, or wrap a `<nav>` element around the whole navigation. Do not add the role to the `<ul>` itself, as this would prevent it from being announced as an actual list by assistive technologies.

Mark Otto's avatar
Mark Otto committed
18
19
## Base nav

Mark Otto's avatar
Mark Otto committed
20
Roll your own navigation style by extending the base `.nav` component. All Bootstrap's nav components are built on top of this by specifying additional styles. Includes styles for the disabled state, but **not the active state**.
Mark Otto's avatar
Mark Otto committed
21
22

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

Mark Otto's avatar
Mark Otto committed
39
Classes are used throughout, so your markup can be super flexible. Use `<ul>`s like above, or roll your own with say a `<nav>` element. The change in nav item display below **is intentional** as `<li>`s have a different default `display` than regular `<a>` elements.
Mark Otto's avatar
Mark Otto committed
40
41

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

50
51
52
53
54
55
56
57
58
59
60
61
62
## Inline

Easily space out nav links in a horizontal band with `.nav-inline`. Longer series of links will wrap to a new line.

{% example html %}
<nav class="nav nav-inline">
  <a class="nav-link active" href="#">Active</a>
  <a class="nav-link" href="#">Link</a>
  <a class="nav-link" href="#">Another link</a>
  <a class="nav-link disabled" href="#">Disabled</a>
</nav>
{% endexample %}

Chris Rebert's avatar
Chris Rebert committed
63
The same works for a navigation built with lists.
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

{% example html %}
<ul class="nav nav-inline">
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Link</a>
  </li>
  <li class="nav-item">
    <a class="nav-link" href="#">Another 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
82
83
## Tabs

Heinrich Fenkart's avatar
Heinrich Fenkart committed
84
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
85
86

{% example html %}
Mark Otto's avatar
Mark Otto committed
87
<ul class="nav nav-tabs">
88
  <li class="nav-item">
89
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
90
  </li>
Mark Otto's avatar
Mark Otto committed
91
  <li class="nav-item">
92
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
93
  </li>
Mark Otto's avatar
Mark Otto committed
94
  <li class="nav-item">
95
    <a class="nav-link" href="#">Another link</a>
Mark Otto's avatar
Mark Otto committed
96
  </li>
Mark Otto's avatar
Mark Otto committed
97
  <li class="nav-item">
98
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
99
100
101
102
103
104
105
106
107
  </li>
</ul>
{% endexample %}

## Pills

Take that same HTML, but use `.nav-pills` instead:

{% example html %}
Mark Otto's avatar
Mark Otto committed
108
<ul class="nav nav-pills">
109
  <li class="nav-item">
110
    <a class="nav-link active" href="#">Active</a>
Mark Otto's avatar
Mark Otto committed
111
  </li>
Mark Otto's avatar
Mark Otto committed
112
  <li class="nav-item">
113
    <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
114
  </li>
Mark Otto's avatar
Mark Otto committed
115
  <li class="nav-item">
116
    <a class="nav-link" href="#">Another link</a>
Mark Otto's avatar
Mark Otto committed
117
  </li>
118
  <li class="nav-item">
119
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
120
121
122
123
124
125
126
127
128
  </li>
</ul>
{% endexample %}

## Stacked pills

Just add `.nav-stacked` to the `.nav.nav-pills`.

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

## Using dropdowns

Heinrich Fenkart's avatar
Heinrich Fenkart committed
147
Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin]({{ site.baseurl }}/components/dropdowns/#usage).
Mark Otto's avatar
Mark Otto committed
148
149
150
151

### Tabs with dropdowns

{% example html %}
Mark Otto's avatar
Mark Otto committed
152
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
153
  <li class="nav-item">
154
    <a class="nav-link active" href="#">Active</a>
155
156
  </li>
  <li class="nav-item dropdown">
Mark Otto's avatar
Mark Otto committed
157
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
Mark Otto's avatar
Mark Otto committed
158
159
160
161
162
163
164
    <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
165
  </li>
Mark Otto's avatar
Mark Otto committed
166
  <li class="nav-item">
167
    <a class="nav-link" href="#">Another link</a>
Mark Otto's avatar
Mark Otto committed
168
  </li>
169
  <li class="nav-item">
170
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
171
172
173
174
175
176
177
  </li>
</ul>
{% endexample %}

### Pills with dropdowns

{% example html %}
Mark Otto's avatar
Mark Otto committed
178
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
179
  <li class="nav-item">
180
    <a class="nav-link active" href="#">Active</a>
181
182
  </li>
  <li class="nav-item dropdown">
Mark Otto's avatar
Mark Otto committed
183
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
Mark Otto's avatar
Mark Otto committed
184
185
186
187
188
189
190
    <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
191
  </li>
Mark Otto's avatar
Mark Otto committed
192
  <li class="nav-item">
193
    <a class="nav-link" href="#">Another link</a>
Mark Otto's avatar
Mark Otto committed
194
  </li>
195
  <li class="nav-item">
196
    <a class="nav-link disabled" href="#">Disabled</a>
Mark Otto's avatar
Mark Otto committed
197
198
199
  </li>
</ul>
{% endexample %}
200
201
202
203
204
205

## 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">
206
  <ul class="nav nav-tabs" id="myTab" role="tablist">
207
    <li class="nav-item">
208
      <a class="nav-link active" id="home-tab" data-toggle="tab" href="#home" role="tab" aria-controls="home" aria-expanded="true">Home</a>
209
    </li>
Jacob Thornton's avatar
Jacob Thornton committed
210
    <li class="nav-item">
211
      <a class="nav-link" id="profile-tab" data-toggle="tab" href="#profile" role="tab" aria-controls="profile">Profile</a>
212
    </li>
Jacob Thornton's avatar
Jacob Thornton committed
213
214
    <li class="nav-item dropdown">
      <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
215
216
        Dropdown
      </a>
Mark Otto's avatar
Mark Otto committed
217
      <div class="dropdown-menu">
218
219
        <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
220
      </div>
221
222
    </li>
  </ul>
223
  <div class="tab-content" id="myTabContent">
224
225
226
    <div role="tabpanel" class="tab-pane fade in active" id="home" aria-labelledBy="home-tab">
      <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>
227
    <div class="tab-pane fade" id="profile" role="tabpanel" aria-labelledBy="profile-tab">
228
229
      <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>
230
    <div class="tab-pane fade" id="dropdown1" role="tabpanel" aria-labelledBy="dropdown1-tab">
231
232
      <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>
233
    <div class="tab-pane fade" id="dropdown2" role="tabpanel" aria-labelledBy="dropdown2-tab">
234
235
236
237
238
239
240
241
242
243
244
245
246
      <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">
247
  <li class="nav-item">
248
    <a class="nav-link active" data-toggle="tab" href="#home" role="tab">Home</a>
Jacob Thornton's avatar
Jacob Thornton committed
249
250
  </li>
  <li class="nav-item">
251
    <a class="nav-link" data-toggle="tab" href="#profile" role="tab">Profile</a>
Jacob Thornton's avatar
Jacob Thornton committed
252
253
  </li>
  <li class="nav-item">
254
    <a class="nav-link" data-toggle="tab" href="#messages" role="tab">Messages</a>
Jacob Thornton's avatar
Jacob Thornton committed
255
256
  </li>
  <li class="nav-item">
257
    <a class="nav-link" data-toggle="tab" href="#settings" role="tab">Settings</a>
Jacob Thornton's avatar
Jacob Thornton committed
258
  </li>
259
260
261
262
</ul>

<!-- Tab panes -->
<div class="tab-content">
263
264
265
266
  <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>
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
</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

293
To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.in` to make the initial content visible.
294
295
296

{% highlight html %}
<div class="tab-content">
297
298
299
300
  <div class="tab-pane fade in active" id="home" role="tabpanel">...</div>
  <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>
301
302
303
304
305
306
307
308
309
310
</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 %}
311
<ul class="nav nav-tabs" id="myTab" role="tablist">
312
  <li class="nav-item">
313
    <a class="nav-link active" data-toggle="tab" href="#home" role="tab" aria-controls="home">Home</a>
314
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
315
  <li class="nav-item">
316
    <a class="nav-link" data-toggle="tab" href="#profile" role="tab" aria-controls="profile">Profile</a>
317
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
318
  <li class="nav-item">
319
    <a class="nav-link" data-toggle="tab" href="#messages" role="tab" aria-controls="messages">Messages</a>
320
  </li>
Jacob Thornton's avatar
Jacob Thornton committed
321
  <li class="nav-item">
322
    <a class="nav-link" data-toggle="tab" href="#settings" role="tab" aria-controls="settings">Settings</a>
323
324
325
326
  </li>
</ul>

<div class="tab-content">
327
328
329
330
  <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>
331
332
333
334
335
336
337
338
339
</div>

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

340
341
342
343
344
345
346
347
#### .tab('show')

Selects the given tab and shows its associated content. Any other tab that was previously selected becomes unselected and its associated content is hidden. **Returns to the caller before the tab pane has actually been shown** (i.e. before the `shown.bs.tab` event occurs).

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

348
349
350
351
352
353
354
355
356
357
358
### 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.

359
<table class="table table-bordered table-striped table-responsive">
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
  <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>
385
386
387
388
389
390
391

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