navs.md 13.6 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
3
4
5
6
7
---
layout: page
title: Navs
---

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

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

Mark Otto's avatar
Mark Otto committed
13
14
15
16
## 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
17
18
19
20
21
## Base nav

Roll your own navigation style by extending the base `.nav` component. All Bootstrap's nav components are built on top of this. Includes styles for the disabled state, but **not the active state**.

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

Classes are used throughout, so your markup can be super flexible. Use `<ul>`s like above, or roll your own with say a `<nav>` element.

{% example html %}
Mark Otto's avatar
Mark Otto committed
41
<nav class="nav">
Mark Otto's avatar
Mark Otto committed
42
43
44
45
46
47
48
49
50
  <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 %}

## Tabs

Mark Otto's avatar
Mark Otto committed
51
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/tabs).
Mark Otto's avatar
Mark Otto committed
52
53

{% example html %}
Mark Otto's avatar
Mark Otto committed
54
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
55
  <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
56
57
    <a href="#" class="nav-link">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
58
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
59
60
    <a href="#" class="nav-link">Link</a>
  </li>
Mark Otto's avatar
Mark Otto committed
61
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
62
63
    <a href="#" class="nav-link">Another link</a>
  </li>
Mark Otto's avatar
Mark Otto committed
64
  <li class="nav-item disabled">
Mark Otto's avatar
Mark Otto committed
65
66
67
68
69
70
71
72
73
74
    <a href="#" class="nav-link">Disabled</a>
  </li>
</ul>
{% endexample %}

## Pills

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

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

## Stacked pills

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

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

## Using dropdowns

Add dropdown menus with a little extra HTML and the [dropdowns JavaScript plugin]({{ site.baseurl }}javascript/#dropdowns).

### Tabs with dropdowns

{% example html %}
Mark Otto's avatar
Mark Otto committed
119
<ul class="nav nav-tabs">
Mark Otto's avatar
Mark Otto committed
120
  <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
121
122
    <a href="#" class="nav-link">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
123
124
125
  <li class="nav-item">
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
    <ul class="dropdown-menu">
Mark Otto's avatar
Mark Otto committed
126
127
128
      <li><a href="#">Action</a></li>
      <li><a href="#">Another action</a></li>
      <li><a href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
129
      <li role="separator" class="divider"></li>
Mark Otto's avatar
Mark Otto committed
130
131
132
      <li><a href="#">Separated link</a></li>
    </ul>
  </li>
Mark Otto's avatar
Mark Otto committed
133
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
134
135
    <a href="#" class="nav-link">Another link</a>
  </li>
Mark Otto's avatar
Mark Otto committed
136
  <li class="nav-item disabled">
Mark Otto's avatar
Mark Otto committed
137
138
139
140
141
142
143
144
    <a href="#" class="nav-link">Disabled</a>
  </li>
</ul>
{% endexample %}

### Pills with dropdowns

{% example html %}
Mark Otto's avatar
Mark Otto committed
145
<ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
146
  <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
147
148
    <a href="#" class="nav-link">Active</a>
  </li>
Mark Otto's avatar
Mark Otto committed
149
150
151
  <li class="nav-item">
    <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">Dropdown</a>
    <ul class="dropdown-menu">
Mark Otto's avatar
Mark Otto committed
152
153
154
      <li><a href="#">Action</a></li>
      <li><a href="#">Another action</a></li>
      <li><a href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
155
      <li role="separator" class="divider"></li>
Mark Otto's avatar
Mark Otto committed
156
157
158
      <li><a href="#">Separated link</a></li>
    </ul>
  </li>
Mark Otto's avatar
Mark Otto committed
159
  <li class="nav-item">
Mark Otto's avatar
Mark Otto committed
160
161
    <a href="#" class="nav-link">Another link</a>
  </li>
Mark Otto's avatar
Mark Otto committed
162
  <li class="nav-item disabled">
Mark Otto's avatar
Mark Otto committed
163
164
165
166
    <a href="#" class="nav-link">Disabled</a>
  </li>
</ul>
{% endexample %}
167
168
169
170
171
172
173

## 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">
  <ul id="myTab" class="nav nav-tabs" role="tablist">
Mark Otto's avatar
Mark Otto committed
174
    <li class="active">
175
176
      <a href="#home" id="home-tab" role="tab" data-toggle="tab" aria-controls="home" aria-expanded="true">Home</a>
    </li>
Mark Otto's avatar
Mark Otto committed
177
    <li>
178
179
      <a href="#profile" role="tab" id="profile-tab" data-toggle="tab" aria-controls="profile">Profile</a>
    </li>
Mark Otto's avatar
Mark Otto committed
180
    <li class="dropdown">
181
182
183
      <a href="#" id="myTabDrop1" class="dropdown-toggle" data-toggle="dropdown" aria-controls="myTabDrop1-contents">
        Dropdown
      </a>
Mark Otto's avatar
Mark Otto committed
184
185
186
      <ul class="dropdown-menu" aria-labelledby="myTabDrop1" id="myTabDrop1-contents">
        <li><a href="#dropdown1" role="tab" id="dropdown1-tab" data-toggle="tab" aria-controls="dropdown1">@fat</a></li>
        <li><a href="#dropdown2" role="tab" id="dropdown2-tab" data-toggle="tab" aria-controls="dropdown2">@mdo</a></li>
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
      </ul>
    </li>
  </ul>
  <div id="myTabContent" class="tab-content">
    <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>
    <div role="tabpanel" class="tab-pane fade" id="profile" aria-labelledBy="profile-tab">
      <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>
    <div role="tabpanel" class="tab-pane fade" id="dropdown1" aria-labelledBy="dropdown1-tab">
      <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 role="tabpanel" class="tab-pane fade" id="dropdown2" aria-labelledBy="dropdown2-tab">
      <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">
Mark Otto's avatar
Mark Otto committed
214
215
216
217
  <li class="active"><a href="#home" role="tab" data-toggle="tab">Home</a></li>
  <li><a href="#profile" role="tab" data-toggle="tab">Profile</a></li>
  <li><a href="#messages" role="tab" data-toggle="tab">Messages</a></li>
  <li><a href="#settings" role="tab" data-toggle="tab">Settings</a></li>
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
</ul>

<!-- Tab panes -->
<div class="tab-content">
  <div role="tabpanel" class="tab-pane active" id="home">...</div>
  <div role="tabpanel" class="tab-pane" id="profile">...</div>
  <div role="tabpanel" class="tab-pane" id="messages">...</div>
  <div role="tabpanel" class="tab-pane" id="settings">...</div>
</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

To make tabs fade in, add `.fade` to each `.tab-pane`. The first tab pane must also have `.in to properly fade in initial content.

{% highlight html %}
<div class="tab-content">
  <div role="tabpanel" class="tab-pane fade in active" id="home">...</div>
  <div role="tabpanel" class="tab-pane fade" id="profile">...</div>
  <div role="tabpanel" class="tab-pane fade" id="messages">...</div>
  <div role="tabpanel" class="tab-pane fade" id="settings">...</div>
</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 %}
<ul class="nav nav-tabs" role="tablist" id="myTab">
Mark Otto's avatar
Mark Otto committed
271
  <li class="active">
272
273
    <a href="#home" role="tab" data-toggle="tab" aria-controls="home">Home</a>
  </li>
Mark Otto's avatar
Mark Otto committed
274
  <li>
275
276
    <a href="#profile" role="tab" data-toggle="tab" aria-controls="profile">Profile</a>
  </li>
Mark Otto's avatar
Mark Otto committed
277
  <li>
278
279
    <a href="#messages" role="tab" data-toggle="tab" aria-controls="messages">Messages</a>
  </li>
Mark Otto's avatar
Mark Otto committed
280
  <li>
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
    <a href="#settings" role="tab" data-toggle="tab" aria-controls="settings">Settings</a>
  </li>
</ul>

<div class="tab-content">
  <div role="tabpanel" class="tab-pane active" id="home">...</div>
  <div role="tabpanel" class="tab-pane" id="profile">...</div>
  <div role="tabpanel" class="tab-pane" id="messages">...</div>
  <div role="tabpanel" class="tab-pane" id="settings">...</div>
</div>

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

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

<div class="table-responsive">
  <table class="table table-bordered table-striped">
    <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>
</div>

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