navbar.md 12.7 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
---
Mark Otto's avatar
Mark Otto committed
2
layout: docs
Mark Otto's avatar
Mark Otto committed
3
title: Navbar
Mark Otto's avatar
Mark Otto committed
4
description: Documentation and examples for Bootstrap's powerful, responsive navigation header.
5
group: components
Mark Otto's avatar
Mark Otto committed
6
7
---

8
The navbar is a wrapper that positions branding, navigation, and other elements into a concise header. It's easily extensible and thanks to our Collapse plugin, it can easily integrate responsive behaviors.
Mark Otto's avatar
Mark Otto committed
9

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
## Basics
Mark Otto's avatar
Mark Otto committed
16
17
18

Here's what you need to know before getting started with the navbar:

19
- Navbars require a wrapping `.navbar` and a [color scheme](#color-schemes).
Mark Otto's avatar
Mark Otto committed
20
- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width.
21
- Use `.float-*-left` and `.float-*-right` to quickly align sub-components.
Mark Otto's avatar
Mark Otto committed
22
- Ensure accessibility by using a `<nav>` element or, if using a more generic element such as a `<div>`, add a `role="navigation"` to every navbar to explicitly identify it as a landmark region for users of assistive technologies.
Mark Otto's avatar
Mark Otto committed
23

Mark Otto's avatar
Mark Otto committed
24
## Supported content
Mark Otto's avatar
Mark Otto committed
25

26
Navbars come with built-in support for a handful of sub-components. Mix and match from the following as needed:
Mark Otto's avatar
Mark Otto committed
27

Mark Otto's avatar
Mark Otto committed
28
29
- `.navbar-brand` for your company, product, or project name
- `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns)
30
- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#collapsible-content) behaviors.
Mark Otto's avatar
Mark Otto committed
31

Mark Otto's avatar
Mark Otto committed
32
Here's an example of all the sub-components included in a default, non-responsive light themed navbar. [See the responsive examples](#collapsible-content) for collapsing nav support.
Mark Otto's avatar
Mark Otto committed
33

Mark Otto's avatar
Mark Otto committed
34
{% example html %}
35
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
36
37
  <a class="navbar-brand" href="#">Navbar</a>
  <ul class="nav navbar-nav">
Mark Otto's avatar
Mark Otto committed
38
    <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
39
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
Mark Otto's avatar
Mark Otto committed
40
41
    </li>
    <li class="nav-item">
42
      <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
43
44
    </li>
    <li class="nav-item">
45
      <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
46
    </li>
47
48
49
50
51
52
53
    <li class="nav-item dropdown">
      <a class="nav-link dropdown-toggle" href="http://example.com" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dropdown</a>
      <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
        <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>
Mark Otto's avatar
Mark Otto committed
54
55
    </li>
  </ul>
56
  <form class="form-inline float-xs-right">
Mark Otto's avatar
Mark Otto committed
57
    <input class="form-control" type="text" placeholder="Search">
58
    <button class="btn btn-outline-success" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
59
  </form>
Mark Otto's avatar
Mark Otto committed
60
</nav>
Mark Otto's avatar
Mark Otto committed
61
62
{% endexample %}

63
64
### Brand

Mark Otto's avatar
Mark Otto committed
65
The `.navbar-brand` can be applied to most elements, but an anchor works best as some elements might require utility classes or custom styles.
66
67

{% example html %}
68
<!-- As a link -->
69
70
71
72
<nav class="navbar navbar-light bg-faded">
  <a class="navbar-brand" href="#">Navbar</a>
</nav>

73
<!-- As a heading -->
74
<nav class="navbar navbar-light bg-faded">
75
  <h1 class="navbar-brand mb-0">Navbar</h1>
76
77
78
79
80
81
82
</nav>
{% endexample %}

### Nav

Navbar navigation is similar to our regular nav options—use the `.nav` base class with a modifier to achieve a particular look. In this case you'll want `.nav.navbar-nav`.

83
84
Active states—with `.active`—to indicate the current page can be applied directly to `.nav-link`s or their immediate parent `.nav-item`s.

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
{% example html %}
<nav class="navbar navbar-light bg-faded">
  <ul class="nav navbar-nav">
    <li class="nav-item active">
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">Features</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">Pricing</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">About</a>
    </li>
  </ul>
</nav>
{% endexample %}

104
And because we use classes for our navs, you can avoid the list-based approach entirely if you like.
105
106
107
108
109
110
111
112
113
114
115
116

{% example html %}
<nav class="navbar navbar-light bg-faded">
  <div class="nav navbar-nav">
    <a class="nav-item nav-link active" href="#">Home <span class="sr-only">(current)</span></a>
    <a class="nav-item nav-link" href="#">Features</a>
    <a class="nav-item nav-link" href="#">Pricing</a>
    <a class="nav-item nav-link" href="#">About</a>
  </div>
</nav>
{% endexample %}

117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
You may also utilize dropdowns in your navbar nav. Dropdown menus require a wrapping element for positioning, so be sure to use separate and nested elements for `.nav-item` and `.nav-link` as shown below.

{% example html %}
<nav class="navbar navbar-light bg-faded">
  <ul class="nav navbar-nav">
    <li class="nav-item active">
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">Features</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">Pricing</a>
    </li>
    <li class="nav-item dropdown">
132
      <a class="nav-link dropdown-toggle" href="http://example.com" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
133
134
135
136
137
138
139
140
141
142
143
144
        Dropdown link
      </a>
      <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
        <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>
    </li>
  </ul>
</nav>
{% endexample %}

145
146
147
148
149
150
### Text

Navbars may contain bits of text with the help of `.navbar-text`. This class adjusts vertical alignment and horizontal spacing for strings of text.

{% example html %}
<nav class="navbar navbar-light bg-faded">
151
152
153
  <span class="navbar-text">
    Navbar text with an inline element
  </span>
154
155
156
</nav>
{% endexample %}

157
Using our utility classes, you can change the alignment and appearance of your navbar text.
158
159
160

{% example html %}
<nav class="navbar navbar-light bg-faded">
161
  <span class="navbar-text float-xs-right text-muted">
162
163
    Muted navbar text that's floated right
  </span>
164
165
166
</nav>
{% endexample %}

167
168
169
170
171
Similarly, you can use utility classes to align navbar text to other navbar elements like the brand and navigation (which are automatically floated already).

{% example html %}
<nav class="navbar navbar-light bg-faded">
  <a class="navbar-brand" href="#">Navbar</a>
172
  <span class="navbar-text float-xs-left">
173
174
175
176
    Navbar text that's floated left
  </span>
</nav>
{% endexample %}
177

178
## Color schemes
Mark Otto's avatar
Mark Otto committed
179

180
Theming the navbar has never been easier thanks to the combination of a simple link color modifier class and `background-color` utilities. Put another way, you specify light or dark and apply a background color.
Mark Otto's avatar
Mark Otto committed
181

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
Here are some examples to show what we mean.

<div class="bd-example">
  <nav class="navbar navbar-dark bg-inverse">
    <a class="navbar-brand" href="#">Navbar</a>
    <ul class="nav navbar-nav">
      <li class="nav-item active">
        <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Features</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Pricing</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">About</a>
      </li>
    </ul>
201
    <form class="form-inline float-xs-right">
202
      <input class="form-control" type="text" placeholder="Search">
203
      <button class="btn btn-outline-info" type="submit">Search</button>
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
    </form>
  </nav>
  <nav class="navbar navbar-dark bg-primary">
    <a class="navbar-brand" href="#">Navbar</a>
    <ul class="nav navbar-nav">
      <li class="nav-item active">
        <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Features</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Pricing</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">About</a>
      </li>
    </ul>
222
    <form class="form-inline float-xs-right">
223
      <input class="form-control" type="text" placeholder="Search">
224
      <button class="btn btn-outline-secondary" type="submit">Search</button>
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
    </form>
  </nav>
  <nav class="navbar navbar-light" style="background-color: #e3f2fd;">
    <a class="navbar-brand" href="#">Navbar</a>
    <ul class="nav navbar-nav">
      <li class="nav-item active">
        <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Features</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">Pricing</a>
      </li>
      <li class="nav-item">
        <a class="nav-link" href="#">About</a>
      </li>
    </ul>
243
    <form class="form-inline float-xs-right">
244
      <input class="form-control" type="text" placeholder="Search">
245
      <button class="btn btn-outline-primary" type="submit">Search</button>
246
247
248
249
250
251
252
    </form>
  </nav>
</div>

{% highlight html %}
<nav class="navbar navbar-dark bg-inverse">
  <!-- Navbar content -->
Mark Otto's avatar
Mark Otto committed
253
</nav>
254
255
256
257
258
259
260
261
262

<nav class="navbar navbar-dark bg-primary">
  <!-- Navbar content -->
</nav>

<nav class="navbar navbar-light" style="background-color: #e3f2fd;">
  <!-- Navbar content -->
</nav>
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
263

Mark Otto's avatar
Mark Otto committed
264
## Containers
265

266
Although it's not required, you can wrap a navbar in a `.container` to center it on a page or add one within to only center the contents of a [fixed or static top navbar](#placement).
267

Mark Otto's avatar
Mark Otto committed
268
269
{% example html %}
<div class="container">
270
  <nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
271
    <a class="navbar-brand" href="#">Navbar</a>
272
273
  </nav>
</div>
Mark Otto's avatar
Mark Otto committed
274
{% endexample %}
275

Mark Otto's avatar
Mark Otto committed
276
{% example html %}
277
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
278
279
280
  <div class="container">
    <a class="navbar-brand" href="#">Navbar</a>
  </div>
281
</nav>
Mark Otto's avatar
Mark Otto committed
282
{% endexample %}
283

Mark Otto's avatar
Mark Otto committed
284
285
## Placement

286
287
288
289
290
291
292
Navbars can be statically placed (their default behavior), static without rounded corners, or fixed to the top or bottom of the viewport.

{% example html %}
<nav class="navbar navbar-full navbar-light bg-faded">
  <a class="navbar-brand" href="#">Full width</a>
</nav>
{% endexample %}
Mark Otto's avatar
Mark Otto committed
293
294
295
296
297
298
299
300
301
302
303
304
305
306

{% example html %}
<nav class="navbar navbar-fixed-top navbar-light bg-faded">
  <a class="navbar-brand" href="#">Fixed top</a>
</nav>
{% endexample %}

{% example html %}
<nav class="navbar navbar-fixed-bottom navbar-light bg-faded">
  <a class="navbar-brand" href="#">Fixed bottom</a>
</nav>
{% endexample %}


Mark Otto's avatar
Mark Otto committed
307
## Collapsible content
Mark Otto's avatar
Mark Otto committed
308

Mark Otto's avatar
Mark Otto committed
309
Our collapse plugin allows you to use a `<button>` or `<a>` to toggle hidden content.
Mark Otto's avatar
Mark Otto committed
310
311

{% example html %}
312
<nav class="navbar navbar-light bg-faded">
313
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#exCollapsingNavbar" aria-controls="exCollapsingNavbar" aria-expanded="false" aria-label="Toggle navigation"></button>
314
  <div class="collapse" id="exCollapsingNavbar">
315
    <div class="bg-inverse text-muted p-1">
316
317
318
319
      <h4>Collapsed content</h4>
      <span class="text-muted">Toggleable via the navbar brand.</span>
    </div>
  </div>
Mark Otto's avatar
Mark Otto committed
320
</nav>
Mark Otto's avatar
Mark Otto committed
321
{% endexample %}
Mark Otto's avatar
Mark Otto committed
322
323
324
325

For more complex navbar patterns, like those used in Bootstrap v3, use the `.navbar-toggleable-*` classes in conjunction with the `.navbar-toggler`. These classes override our responsive utilities to show navigation only when content is meant to be shown.

{% example html %}
326
<nav class="navbar navbar-light bg-faded">
327
328
329
  <button class="navbar-toggler hidden-lg-up" type="button" data-toggle="collapse" data-target="#navbarResponsive" aria-controls="exCollapsingNavbar2" aria-expanded="false" aria-label="Toggle navigation"></button>
  <div class="collapse navbar-toggleable-md" id="navbarResponsive">
    <a class="navbar-brand" href="#">Navbar</a>
Mark Otto's avatar
Mark Otto committed
330
331
332
333
334
    <ul class="nav navbar-nav">
      <li class="nav-item active">
        <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
      </li>
      <li class="nav-item">
335
        <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
336
337
      </li>
      <li class="nav-item">
338
        <a class="nav-link" href="#">Link</a>
Mark Otto's avatar
Mark Otto committed
339
      </li>
340
341
342
343
344
345
346
      <li class="nav-item dropdown">
        <a class="nav-link dropdown-toggle" href="http://example.com" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dropdown</a>
        <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
          <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>
Mark Otto's avatar
Mark Otto committed
347
348
      </li>
    </ul>
349
350
351
352
    <form class="form-inline float-lg-right">
      <input class="form-control" type="text" placeholder="Search">
      <button class="btn btn-outline-success" type="submit">Search</button>
    </form>
Mark Otto's avatar
Mark Otto committed
353
354
355
  </div>
</nav>
{% endexample %}