navbar.md 7.56 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
group: components
Mark Otto's avatar
Mark Otto committed
5
6
---

7
The navbar is a simple wrapper for positioning branding, navigation, and other elements into a concise navigation header. It's easily extensible and, with the help of our collapse plugin, it can easily integrate offscreen content.
Mark Otto's avatar
Mark Otto committed
8

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

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

18
- Navbars require a wrapping `.navbar` and a [color scheme](#color-schemes).
Mark Otto's avatar
Mark Otto committed
19
- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width.
20
- Use `.pull-*-left` and `.pull-*-right` to quickly align sub-components.
Mark Otto's avatar
Mark Otto committed
21
- 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
22

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

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

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

Mark Otto's avatar
Mark Otto committed
31
Here's an example of all the sub-components included in a default, light navbar:
Mark Otto's avatar
Mark Otto committed
32

Mark Otto's avatar
Mark Otto committed
33
{% example html %}
34
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
35
36
  <a class="navbar-brand" href="#">Navbar</a>
  <ul class="nav navbar-nav">
Mark Otto's avatar
Mark Otto committed
37
    <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
38
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
Mark Otto's avatar
Mark Otto committed
39
40
41
42
43
44
45
46
47
48
49
    </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>
50
  <form class="form-inline pull-xs-right">
Mark Otto's avatar
Mark Otto committed
51
    <input class="form-control" type="text" placeholder="Search">
Mark Otto's avatar
Mark Otto committed
52
    <button class="btn btn-success-outline" type="submit">Search</button>
Mark Otto's avatar
Mark Otto committed
53
  </form>
Mark Otto's avatar
Mark Otto committed
54
</nav>
Mark Otto's avatar
Mark Otto committed
55
56
{% endexample %}

57
## Color schemes
Mark Otto's avatar
Mark Otto committed
58

59
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
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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>
80
    <form class="form-inline pull-xs-right">
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
      <input class="form-control" type="text" placeholder="Search">
      <button class="btn btn-info-outline" type="submit">Search</button>
    </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>
101
    <form class="form-inline pull-xs-right">
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
      <input class="form-control" type="text" placeholder="Search">
      <button class="btn btn-secondary-outline" type="submit">Search</button>
    </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>
122
    <form class="form-inline pull-xs-right">
123
124
125
126
127
128
129
130
131
      <input class="form-control" type="text" placeholder="Search">
      <button class="btn btn-primary-outline" type="submit">Search</button>
    </form>
  </nav>
</div>

{% highlight html %}
<nav class="navbar navbar-dark bg-inverse">
  <!-- Navbar content -->
Mark Otto's avatar
Mark Otto committed
132
</nav>
133
134
135
136
137
138
139
140
141

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

Mark Otto's avatar
Mark Otto committed
143
## Containers
144

Mark Otto's avatar
Mark Otto committed
145
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 the navbar.
146

Mark Otto's avatar
Mark Otto committed
147
148
{% example html %}
<div class="container">
149
  <nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
150
    <a class="navbar-brand" href="#">Navbar</a>
151
152
  </nav>
</div>
Mark Otto's avatar
Mark Otto committed
153
{% endexample %}
154

Mark Otto's avatar
Mark Otto committed
155
{% example html %}
156
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
157
158
159
  <div class="container">
    <a class="navbar-brand" href="#">Navbar</a>
  </div>
160
</nav>
Mark Otto's avatar
Mark Otto committed
161
{% endexample %}
162

Mark Otto's avatar
Mark Otto committed
163
164
## Placement

165
166
167
168
169
170
171
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185

{% 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
186
## Collapsible content
Mark Otto's avatar
Mark Otto committed
187

Mark Otto's avatar
Mark Otto committed
188
Our collapse plugin allows you to use a `<button>` or `<a>` to toggle hidden content.
Mark Otto's avatar
Mark Otto committed
189
190

{% example html %}
Mark Otto's avatar
Mark Otto committed
191
<div class="collapse" id="exCollapsingNavbar">
192
  <div class="bg-inverse p-a">
Mark Otto's avatar
Mark Otto committed
193
    <h4>Collapsed content</h4>
Mark Otto's avatar
Mark Otto committed
194
    <span class="text-muted">Toggleable via the navbar brand.</span>
Mark Otto's avatar
Mark Otto committed
195
  </div>
Mark Otto's avatar
Mark Otto committed
196
</div>
197
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
198
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#exCollapsingNavbar">
Mark Otto's avatar
Mark Otto committed
199
200
    &#9776;
  </button>
Mark Otto's avatar
Mark Otto committed
201
</nav>
Mark Otto's avatar
Mark Otto committed
202
{% endexample %}
Mark Otto's avatar
Mark Otto committed
203
204
205
206

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 %}
207
<nav class="navbar navbar-light bg-faded">
Mark Otto's avatar
Mark Otto committed
208
209
210
211
  <button class="navbar-toggler hidden-sm-up" type="button" data-toggle="collapse" data-target="#exCollapsingNavbar2">
    &#9776;
  </button>
  <div class="collapse navbar-toggleable-xs" id="exCollapsingNavbar2">
Mark Otto's avatar
Mark Otto committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
    <a class="navbar-brand" href="#">Responsive 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>
Mark Otto's avatar
Mark Otto committed
227
228
229
  </div>
</nav>
{% endexample %}