navbar.md 25.6 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
4
description: Documentation and examples for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, collapse plugin, and more.
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
## How it works
Mark Otto's avatar
Mark Otto committed
10
11
12

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

13
- Navbars require a wrapping `.navbar` with `.navbar-expand{-sm|-md|-lg|-xl}` for responsive collapsing and [color scheme](#color-schemes) classes.
Mark Otto's avatar
Mark Otto committed
14
- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width.
XhmikosR's avatar
XhmikosR committed
15
- Use our [spacing]({{< docsref "/utilities/spacing" >}}) and [flex]({{< docsref "/utilities/flex" >}}) utility classes for controlling spacing and alignment within navbars.
Mark Otto's avatar
Mark Otto committed
16
- Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin.
XhmikosR's avatar
XhmikosR committed
17
- Navbars are hidden by default when printing. Force them to be printed by adding `.d-print` to the `.navbar`. See the [display]({{< docsref "/utilities/display" >}}) utility class.
Mark Otto's avatar
Mark Otto committed
18
- 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
19

XhmikosR's avatar
XhmikosR committed
20
21
22
{{< callout info >}}
{{< partial "callout-info-prefersreducedmotion.md" >}}
{{< /callout >}}
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. Choose 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).
Bardi Harborow's avatar
Bardi Harborow committed
30
- `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#responsive-behaviors) behaviors.
Mark Otto's avatar
Mark Otto committed
31
- `.form-inline` for any form controls and actions.
32
- `.navbar-text` for adding vertically centered strings of text.
33
- `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint.
Mark Otto's avatar
Mark Otto committed
34

35
Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `lg` (large) breakpoint.
Mark Otto's avatar
Mark Otto committed
36

XhmikosR's avatar
XhmikosR committed
37
{{< example >}}
38
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
39
40
  <a class="navbar-brand" href="#">Navbar</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
41
42
    <span class="navbar-toggler-icon"></span>
  </button>
43

44
  <div class="collapse navbar-collapse" id="navbarSupportedContent">
45
    <ul class="navbar-nav mr-auto">
46
47
48
49
50
51
      <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="#">Link</a>
      </li>
52
      <li class="nav-item dropdown">
53
        <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-expanded="false">
54
55
56
          Dropdown
        </a>
        <div class="dropdown-menu" aria-labelledby="navbarDropdown">
57
58
          <a class="dropdown-item" href="#">Action</a>
          <a class="dropdown-item" href="#">Another action</a>
59
          <div class="dropdown-divider"></div>
60
          <a class="dropdown-item" href="#">Something else here</a>
61
62
        </div>
      </li>
63
      <li class="nav-item">
64
        <a class="nav-link disabled">Disabled</a>
65
66
      </li>
    </ul>
67
    <form class="form-inline my-2 my-lg-0">
68
      <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
69
      <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
70
71
    </form>
  </div>
Mark Otto's avatar
Mark Otto committed
72
</nav>
XhmikosR's avatar
XhmikosR committed
73
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
74

XhmikosR's avatar
XhmikosR committed
75
This example uses [color]({{< docsref "/utilities/colors" >}}) (`bg-light`) and [spacing]({{< docsref "/utilities/spacing" >}}) (`my-2`, `my-lg-0`, `mr-sm-0`, `my-sm-0`) utility classes.
76

77
78
### Brand

79
The `.navbar-brand` can be applied to most elements, but an anchor works best, as some elements might require utility classes or custom styles.
80

XhmikosR's avatar
XhmikosR committed
81
{{< example >}}
82
<!-- As a link -->
83
<nav class="navbar navbar-light bg-light">
84
85
86
  <a class="navbar-brand" href="#">Navbar</a>
</nav>

87
<!-- As a heading -->
88
<nav class="navbar navbar-light bg-light">
89
  <span class="navbar-brand mb-0 h1">Navbar</span>
90
</nav>
XhmikosR's avatar
XhmikosR committed
91
{{< /example >}}
92

93
94
Adding images to the `.navbar-brand` will likely always require custom styles or utilities to properly size. Here are some examples to demonstrate.

XhmikosR's avatar
XhmikosR committed
95
{{< example >}}
96
<!-- Just an image -->
97
<nav class="navbar navbar-light bg-light">
98
  <a class="navbar-brand" href="#">
XhmikosR's avatar
XhmikosR committed
99
    <img src="/docs/{{< param docs_version >}}/assets/brand/bootstrap-solid.svg" width="30" height="30" alt="">
100
101
  </a>
</nav>
XhmikosR's avatar
XhmikosR committed
102
{{< /example >}}
103

XhmikosR's avatar
XhmikosR committed
104
{{< example >}}
105
<!-- Image and text -->
106
<nav class="navbar navbar-light bg-light">
107
  <a class="navbar-brand" href="#">
XhmikosR's avatar
XhmikosR committed
108
    <img src="/docs/{{< param docs_version >}}/assets/brand/bootstrap-solid.svg" width="30" height="30" class="d-inline-block align-top" alt="">
109
110
111
    Bootstrap
  </a>
</nav>
XhmikosR's avatar
XhmikosR committed
112
{{< /example >}}
113

114
115
### Nav

116
Navbar navigation links build on our `.nav` options with their own modifier class and require the use of [toggler classes](#toggler) for proper responsive styling. **Navigation in navbars will also grow to occupy as much horizontal space as possible** to keep your navbar contents securely aligned.
117

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

XhmikosR's avatar
XhmikosR committed
120
{{< example >}}
121
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
122
123
  <a class="navbar-brand" href="#">Navbar</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
124
125
    <span class="navbar-toggler-icon"></span>
  </button>
126
  <div class="collapse navbar-collapse" id="navbarNav">
127
    <ul class="navbar-nav">
128
129
130
131
132
133
134
135
136
137
      <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">
138
        <a class="nav-link disabled">Disabled</a>
139
140
141
      </li>
    </ul>
  </div>
142
</nav>
XhmikosR's avatar
XhmikosR committed
143
{{< /example >}}
144

145
And because we use classes for our navs, you can avoid the list-based approach entirely if you like.
146

XhmikosR's avatar
XhmikosR committed
147
{{< example >}}
148
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
149
150
  <a class="navbar-brand" href="#">Navbar</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
151
152
    <span class="navbar-toggler-icon"></span>
  </button>
153
  <div class="collapse navbar-collapse" id="navbarNavAltMarkup">
154
    <div class="navbar-nav">
XhmikosR's avatar
XhmikosR committed
155
156
157
      <a class="nav-link active" href="#">Home <span class="sr-only">(current)</span></a>
      <a class="nav-link" href="#">Features</a>
      <a class="nav-link" href="#">Pricing</a>
158
      <a class="nav-link disabled">Disabled</a>
159
    </div>
160
161
  </div>
</nav>
XhmikosR's avatar
XhmikosR committed
162
{{< /example >}}
163

164
You can also use dropdowns in your navbar. 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.
165

XhmikosR's avatar
XhmikosR committed
166
{{< example >}}
167
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
168
169
  <a class="navbar-brand" href="#">Navbar</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
170
171
    <span class="navbar-toggler-icon"></span>
  </button>
172
  <div class="collapse navbar-collapse" id="navbarNavDropdown">
173
    <ul class="navbar-nav">
174
175
176
177
178
179
180
181
182
183
      <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">
184
        <a class="nav-link dropdown-toggle" href="#" id="navbarDropdownMenuLink" role="button" data-toggle="dropdown" aria-expanded="false">
185
186
187
188
189
190
191
192
193
194
          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>
  </div>
195
</nav>
XhmikosR's avatar
XhmikosR committed
196
{{< /example >}}
197

198
199
### Forms

200
Place various form controls and components within a navbar with `.form-inline`.
201

XhmikosR's avatar
XhmikosR committed
202
{{< example >}}
203
<nav class="navbar navbar-light bg-light">
204
  <form class="form-inline">
205
    <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
206
    <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
207
208
  </form>
</nav>
XhmikosR's avatar
XhmikosR committed
209
{{< /example >}}
210

XhmikosR's avatar
XhmikosR committed
211
Immediate child elements of `.navbar` use flex layout and will default to `justify-content: space-between`. Use additional [flex utilities]({{< docsref "/utilities/flex" >}}) as needed to adjust this behavior.
212

XhmikosR's avatar
XhmikosR committed
213
{{< example >}}
Mark Otto's avatar
Mark Otto committed
214
<nav class="navbar navbar-light bg-light">
215
  <a class="navbar-brand">Navbar</a>
216
  <form class="form-inline">
217
    <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
218
    <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
219
220
  </form>
</nav>
XhmikosR's avatar
XhmikosR committed
221
{{< /example >}}
222
223
224

Input groups work, too:

XhmikosR's avatar
XhmikosR committed
225
{{< example >}}
226
<nav class="navbar navbar-light bg-light">
227
  <form class="form-inline">
228
    <div class="input-group">
229
230
231
      <div class="input-group-prepend">
        <span class="input-group-text" id="basic-addon1">@</span>
      </div>
232
      <input type="text" class="form-control" placeholder="Username" aria-label="Username" aria-describedby="basic-addon1">
233
234
235
    </div>
  </form>
</nav>
XhmikosR's avatar
XhmikosR committed
236
{{< /example >}}
237

238
Various buttons are supported as part of these navbar forms, too. This is also a great reminder that vertical alignment utilities can be used to align different sized elements.
239

XhmikosR's avatar
XhmikosR committed
240
{{< example >}}
241
<nav class="navbar navbar-light bg-light">
242
  <form class="form-inline">
243
    <button class="btn btn-outline-success" type="button">Main button</button>
244
    <button class="btn btn-sm btn-outline-secondary" type="button">Smaller button</button>
245
246
  </form>
</nav>
XhmikosR's avatar
XhmikosR committed
247
{{< /example >}}
248

249
250
251
252
### 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.

XhmikosR's avatar
XhmikosR committed
253
{{< example >}}
254
<nav class="navbar navbar-light bg-light">
255
256
257
  <span class="navbar-text">
    Navbar text with an inline element
  </span>
258
</nav>
XhmikosR's avatar
XhmikosR committed
259
{{< /example >}}
260

261
262
Mix and match with other components and utilities as needed.

XhmikosR's avatar
XhmikosR committed
263
{{< example >}}
264
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
265
266
  <a class="navbar-brand" href="#">Navbar w/ text</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
267
268
    <span class="navbar-toggler-icon"></span>
  </button>
269
  <div class="collapse navbar-collapse" id="navbarText">
270
    <ul class="navbar-nav mr-auto">
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
      <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>
    </ul>
    <span class="navbar-text">
      Navbar text with an inline element
    </span>
  </div>
</nav>
XhmikosR's avatar
XhmikosR committed
286
{{< /example >}}
287

288
## Color schemes
Mark Otto's avatar
Mark Otto committed
289

290
Theming the navbar has never been easier thanks to the combination of theming classes and `background-color` utilities. Choose from `.navbar-light` for use with light background colors, or `.navbar-dark` for dark background colors. Then, customize with `.bg-*` utilities.
291
292

<div class="bd-example">
293
  <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
294
    <a class="navbar-brand" href="#">Navbar</a>
Mark Otto's avatar
Mark Otto committed
295
296
297
    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarColor01" aria-controls="navbarColor01" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>
Mark Otto's avatar
Mark Otto committed
298
    <div class="collapse navbar-collapse" id="navbarColor01">
299
      <ul class="navbar-nav mr-auto">
Mark Otto's avatar
Mark Otto committed
300
301
302
303
304
305
306
307
308
309
310
311
312
313
        <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>
      <form class="form-inline">
314
        <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
315
        <button class="btn btn-outline-info my-2 my-sm-0" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
316
317
      </form>
    </div>
318
  </nav>
Mark Otto's avatar
Mark Otto committed
319

320
  <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
Mark Otto's avatar
Mark Otto committed
321
322
    <a class="navbar-brand" href="#">Navbar</a>
    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarColor02" aria-controls="navbarColor02" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
323
324
      <span class="navbar-toggler-icon"></span>
    </button>
Mark Otto's avatar
Mark Otto committed
325
    <div class="collapse navbar-collapse" id="navbarColor02">
326
      <ul class="navbar-nav mr-auto">
Mark Otto's avatar
Mark Otto committed
327
328
329
330
331
332
333
334
335
336
337
338
339
340
        <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>
      <form class="form-inline">
341
        <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
342
        <button class="btn btn-outline-light my-2 my-sm-0" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
343
344
      </form>
    </div>
345
  </nav>
Mark Otto's avatar
Mark Otto committed
346

347
  <nav class="navbar navbar-expand-lg navbar-light" style="background-color: #e3f2fd;">
Mark Otto's avatar
Mark Otto committed
348
349
    <a class="navbar-brand" href="#">Navbar</a>
    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarColor03" aria-controls="navbarColor03" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
350
351
      <span class="navbar-toggler-icon"></span>
    </button>
Mark Otto's avatar
Mark Otto committed
352
    <div class="collapse navbar-collapse" id="navbarColor03">
353
      <ul class="navbar-nav mr-auto">
Mark Otto's avatar
Mark Otto committed
354
355
356
357
358
359
360
361
362
363
364
365
366
367
        <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>
      <form class="form-inline">
368
        <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
369
        <button class="btn btn-outline-primary my-2 my-sm-0" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
370
371
      </form>
    </div>
372
373
374
  </nav>
</div>

XhmikosR's avatar
XhmikosR committed
375
```html
376
<nav class="navbar navbar-dark bg-dark">
377
  <!-- Navbar content -->
Mark Otto's avatar
Mark Otto committed
378
</nav>
379

380
<nav class="navbar navbar-dark bg-primary">
381
382
383
384
385
386
  <!-- Navbar content -->
</nav>

<nav class="navbar navbar-light" style="background-color: #e3f2fd;">
  <!-- Navbar content -->
</nav>
XhmikosR's avatar
XhmikosR committed
387
```
Mark Otto's avatar
Mark Otto committed
388

Mark Otto's avatar
Mark Otto committed
389
## Containers
390

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

XhmikosR's avatar
XhmikosR committed
393
{{< example >}}
Mark Otto's avatar
Mark Otto committed
394
<div class="container">
395
  <nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
396
    <a class="navbar-brand" href="#">Navbar</a>
397
398
  </nav>
</div>
XhmikosR's avatar
XhmikosR committed
399
{{< /example >}}
400

401
When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-expand{-sm|-md|-lg|-xl}` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed.
402

XhmikosR's avatar
XhmikosR committed
403
{{< example >}}
404
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
405
406
407
  <div class="container">
    <a class="navbar-brand" href="#">Navbar</a>
  </div>
408
</nav>
XhmikosR's avatar
XhmikosR committed
409
{{< /example >}}
410

Mark Otto's avatar
Mark Otto committed
411
412
## Placement

XhmikosR's avatar
XhmikosR committed
413
Use our [position utilities]({{< docsref "/utilities/position" >}}) to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top (scrolls with the page until it reaches the top, then stays there). Fixed navbars use `position: fixed`, meaning they're pulled from the normal flow of the DOM and may require custom CSS (e.g., `padding-top` on the `<body>`) to prevent overlap with other elements.
414

415
Also note that **`.sticky-top` uses `position: sticky`, which [isn't fully supported in every browser](https://caniuse.com/css-sticky)**.
416

XhmikosR's avatar
XhmikosR committed
417
{{< example >}}
418
<nav class="navbar navbar-light bg-light">
419
  <a class="navbar-brand" href="#">Default</a>
420
</nav>
XhmikosR's avatar
XhmikosR committed
421
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
422

XhmikosR's avatar
XhmikosR committed
423
{{< example >}}
424
<nav class="navbar fixed-top navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
425
426
  <a class="navbar-brand" href="#">Fixed top</a>
</nav>
XhmikosR's avatar
XhmikosR committed
427
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
428

XhmikosR's avatar
XhmikosR committed
429
{{< example >}}
430
<nav class="navbar fixed-bottom navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
431
432
  <a class="navbar-brand" href="#">Fixed bottom</a>
</nav>
XhmikosR's avatar
XhmikosR committed
433
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
434

XhmikosR's avatar
XhmikosR committed
435
{{< example >}}
436
<nav class="navbar sticky-top navbar-light bg-light">
437
438
  <a class="navbar-brand" href="#">Sticky top</a>
</nav>
XhmikosR's avatar
XhmikosR committed
439
{{< /example >}}
440

XhmikosR's avatar
XhmikosR committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
## Scrolling

Add `.navbar-nav-scroll` to a `.navbar-collapse` (or other navbar sub-component) to enable vertical scrolling within the toggleable contents of a collapsed navbar. By default, scrolling kicks in at `75vh` (or 75% of the viewport height), but you can override that with inline or custom styles. At larger viewports when the navbar is expanded, content will appear as it does in a default navbar.

Please note that this behavior comes with a potential drawback of `overflow`—when setting `overflow-y: auto` (required to scroll the content here), `overflow-x` is the equivalent of `auto`, which will crop some horizontal content.

Here's an example navbar using `.navbar-nav-scroll` with `style="max-height: 100px;"`, with some extra margin utilities for optimum spacing.

{{< example >}}
<nav class="navbar navbar-expand-lg navbar-light bg-light">
  <a class="navbar-brand" href="#">Navbar scroll</a>
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarScroll" aria-controls="navbarScroll" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <div class="collapse navbar-collapse" id="navbarScroll">
    <ul class="navbar-nav mr-auto my-2 my-lg-0 navbar-nav-scroll" style="max-height: 100px;">
      <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="#">Link</a>
      </li>
      <li class="nav-item dropdown">
        <a class="nav-link dropdown-toggle" href="#" id="navbarScrollingDropdown" role="button" data-toggle="dropdown" aria-expanded="false">
          Link
        </a>
        <ul class="dropdown-menu" aria-labelledby="navbarScrollingDropdown">
          <li><a class="dropdown-item" href="#">Action</a></li>
          <li><a class="dropdown-item" href="#">Another action</a></li>
          <li><hr class="dropdown-divider"></li>
          <li><a class="dropdown-item" href="#">Something else here</a></li>
        </ul>
      </li>
      <li class="nav-item">
475
        <a class="nav-link disabled">Link</a>
XhmikosR's avatar
XhmikosR committed
476
477
478
479
480
481
482
483
484
485
      </li>
    </ul>
    <form class="d-flex">
      <input class="form-control mr-2" type="search" placeholder="Search" aria-label="Search">
      <button class="btn btn-outline-success" type="submit">Search</button>
    </form>
  </div>
</nav>
{{< /example >}}

Mark Otto's avatar
Mark Otto committed
486
487
## Responsive behaviors

488
Navbars can use `.navbar-toggler`, `.navbar-collapse`, and `.navbar-expand{-sm|-md|-lg|-xl}` classes to determine when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements.
Mark Otto's avatar
Mark Otto committed
489

490
For navbars that never collapse, add the `.navbar-expand` class on the navbar. For navbars that always collapse, don't add any `.navbar-expand` class.
491

Mark Otto's avatar
Mark Otto committed
492
493
### Toggler

Mark Otto's avatar
Mark Otto committed
494
Navbar togglers are left-aligned by default, but should they follow a sibling element like a `.navbar-brand`, they'll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles.
Mark Otto's avatar
Mark Otto committed
495

496
With no `.navbar-brand` shown at the smallest breakpoint:
Mark Otto's avatar
Mark Otto committed
497

XhmikosR's avatar
XhmikosR committed
498
{{< example >}}
499
<nav class="navbar navbar-expand-lg navbar-light bg-light">
500
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo01" aria-controls="navbarTogglerDemo01" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
501
502
    <span class="navbar-toggler-icon"></span>
  </button>
Mark Otto's avatar
Mark Otto committed
503
504
  <div class="collapse navbar-collapse" id="navbarTogglerDemo01">
    <a class="navbar-brand" href="#">Hidden brand</a>
505
    <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
Mark Otto's avatar
Mark Otto committed
506
507
508
509
510
511
512
      <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="#">Link</a>
      </li>
      <li class="nav-item">
513
        <a class="nav-link disabled">Disabled</a>
Mark Otto's avatar
Mark Otto committed
514
515
      </li>
    </ul>
516
    <form class="form-inline my-2 my-lg-0">
517
      <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
518
      <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
519
520
521
    </form>
  </div>
</nav>
XhmikosR's avatar
XhmikosR committed
522
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
523
524
525

With a brand name shown on the left and toggler on the right:

XhmikosR's avatar
XhmikosR committed
526
{{< example >}}
527
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
528
  <a class="navbar-brand" href="#">Navbar</a>
Mark Otto's avatar
Mark Otto committed
529
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
530
531
    <span class="navbar-toggler-icon"></span>
  </button>
Mark Otto's avatar
Mark Otto committed
532
533

  <div class="collapse navbar-collapse" id="navbarTogglerDemo02">
534
    <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
Mark Otto's avatar
Mark Otto committed
535
536
537
538
539
540
541
      <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="#">Link</a>
      </li>
      <li class="nav-item">
542
        <a class="nav-link disabled">Disabled</a>
Mark Otto's avatar
Mark Otto committed
543
544
      </li>
    </ul>
545
    <form class="form-inline my-2 my-lg-0">
546
      <input class="form-control mr-sm-2" type="search" placeholder="Search">
Mark Otto's avatar
Mark Otto committed
547
548
549
550
      <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
    </form>
  </div>
</nav>
XhmikosR's avatar
XhmikosR committed
551
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
552
553
554

With a toggler on the left and brand name on the right:

XhmikosR's avatar
XhmikosR committed
555
{{< example >}}
556
<nav class="navbar navbar-expand-lg navbar-light bg-light">
Mark Otto's avatar
Mark Otto committed
557
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo03" aria-controls="navbarTogglerDemo03" aria-expanded="false" aria-label="Toggle navigation">
Mark Otto's avatar
Mark Otto committed
558
559
    <span class="navbar-toggler-icon"></span>
  </button>
Mark Otto's avatar
Mark Otto committed
560
  <a class="navbar-brand" href="#">Navbar</a>
Mark Otto's avatar
Mark Otto committed
561
562
563
564
565
566
567
568
569
570

  <div class="collapse navbar-collapse" id="navbarTogglerDemo03">
    <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
      <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="#">Link</a>
      </li>
      <li class="nav-item">
571
        <a class="nav-link disabled">Disabled</a>
Mark Otto's avatar
Mark Otto committed
572
573
574
      </li>
    </ul>
    <form class="form-inline my-2 my-lg-0">
575
      <input class="form-control mr-sm-2" type="search" placeholder="Search" aria-label="Search">
576
      <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
577
578
579
    </form>
  </div>
</nav>
XhmikosR's avatar
XhmikosR committed
580
{{< /example >}}
Mark Otto's avatar
Mark Otto committed
581
582
583

### External content

584
Sometimes you want to use the collapse plugin to trigger a container element for content that structurally sits outside of the `.navbar` . Because our plugin works on the `id` and `data-target` matching, that's easily done!
Mark Otto's avatar
Mark Otto committed
585

XhmikosR's avatar
XhmikosR committed
586
{{< example >}}
587
<div class="fixed-top">
Mark Otto's avatar
Mark Otto committed
588
  <div class="collapse" id="navbarToggleExternalContent">
589
    <div class="bg-dark p-4">
590
      <h5 class="text-white h4">Collapsed content</h5>
Mark Otto's avatar
Mark Otto committed
591
592
593
      <span class="text-muted">Toggleable via the navbar brand.</span>
    </div>
  </div>
594
  <nav class="navbar navbar-dark bg-dark">
Mark Otto's avatar
Mark Otto committed
595
596
597
    <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>
Mark Otto's avatar
Mark Otto committed
598
599
  </nav>
</div>
XhmikosR's avatar
XhmikosR committed
600
{{< /example >}}
601
602

When you do this, we recommend including additional JavaScript to move the focus programmatically to the container when it is opened. Otherwise, keyboard users and users of assistive technologies will likely have a hard time finding the newly revealed content - particularly if the container that was opened comes *before* the toggler in the document's structure. We also recommend making sure that the toggler has the `aria-controls` attribute, pointing to the `id` of the content container. In theory, this allows assistive technology users to jump directly from the toggler to the container it controls–but support for this is currently quite patchy.