navbar.md 5.27 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
---
layout: page
Mark Otto's avatar
Mark Otto committed
3
title: Navbar
Mark Otto's avatar
Mark Otto committed
4
5
---

Mark Otto's avatar
Mark Otto committed
6
The navbar is a simple wrapper for positioning branding, navigation, and other elements. 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
7

Mark Otto's avatar
Mark Otto committed
8
9
10
11
12
13
14
### Basics

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

- Navbars require a wrapping `.navbar` and either a color scheme class or custom styles.
- When using multiple components in a navbar, some [alignment classes](#alignment) are required.
- Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width.
Mark Otto's avatar
Mark Otto committed
15
- 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
16
17
18
19
20
21

### Branding

Name your company, product, or project with `.navbar-brand`.

{% example html %}
Mark Otto's avatar
Mark Otto committed
22
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
23
  <h3 class="navbar-brand">
Mark Otto's avatar
Mark Otto committed
24
25
    <a href="#">Navbar</a>
  </h3>
Mark Otto's avatar
Mark Otto committed
26
</nav>
Mark Otto's avatar
Mark Otto committed
27
28
29
30
31
{% endexample %}

### Navigation

Use `.nav-pills` within a navbar for basic navigation.
Mark Otto's avatar
Mark Otto committed
32

Mark Otto's avatar
Mark Otto committed
33
{% example html %}
Mark Otto's avatar
Mark Otto committed
34
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
35
  <ul class="nav nav-pills">
Mark Otto's avatar
Mark Otto committed
36
    <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
37
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
Mark Otto's avatar
Mark Otto committed
38
39
40
41
42
43
44
45
46
47
48
    </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
49
</nav>
Mark Otto's avatar
Mark Otto committed
50
51
52
53
54
55
56
{% endexample %}

### Inline forms

Add an `.inline-form` within the navbar with nearly any combination of form controls and buttons.

{% example html %}
Mark Otto's avatar
Mark Otto committed
57
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
58
59
60
61
  <form class="form-inline">
    <input class="form-control" type="text" placeholder="Search">
    <button class="btn btn-primary" type="submit">Search</button>
  </form>
Mark Otto's avatar
Mark Otto committed
62
</nav>
Mark Otto's avatar
Mark Otto committed
63
64
65
66
67
68
69
{% endexample %}

### Containers

Although it's not required, you can wrap a navbar in a `.container` or add one within for basic horizontal control.

{% example html %}
Mark Otto's avatar
Mark Otto committed
70
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
71
72
73
74
75
  <div class="container">
    <h3 class="navbar-brand">
      <a href="#">Navbar</a>
    </h3>
  </div>
Mark Otto's avatar
Mark Otto committed
76
</nav>
Mark Otto's avatar
Mark Otto committed
77
78
79
80
{% endexample %}

{% example html %}
<div class="container">
Mark Otto's avatar
Mark Otto committed
81
  <nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
82
83
84
    <h3 class="navbar-brand">
      <a href="#">Navbar</a>
    </h3>
Mark Otto's avatar
Mark Otto committed
85
  </nav>
Mark Otto's avatar
Mark Otto committed
86
87
</div>
{% endexample %}
Mark Otto's avatar
Mark Otto committed
88

Mark Otto's avatar
Mark Otto committed
89
90
91
92
93
### Alignment

Use `.pull-left` or `.pull-right` to align multiple elements within the navbar.

{% example html %}
Mark Otto's avatar
Mark Otto committed
94
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
95
96
97
98
99
  <h3 class="navbar-brand pull-left">
    <a href="#">Navbar</a>
  </h3>
  <ul class="nav nav-pills pull-left">
    <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
100
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
Mark Otto's avatar
Mark Otto committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
    </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>
  <ul class="nav nav-pills pull-right">
    <li class="nav-item">
      <a class="nav-link" href="#">Help</a>
    </li>
    <li class="nav-item">
      <a class="nav-link" href="#">Sign out</a>
    </li>
  </ul>
Mark Otto's avatar
Mark Otto committed
120
</nav>
Mark Otto's avatar
Mark Otto committed
121
{% endexample %}
Mark Otto's avatar
Mark Otto committed
122

Mark Otto's avatar
Mark Otto committed
123
124
125
### Inverse color scheme

Replace `.navbar-default` with `.navbar-inverse` for a darker background color and white text.
Mark Otto's avatar
Mark Otto committed
126

Mark Otto's avatar
Mark Otto committed
127
{% example html %}
Mark Otto's avatar
Mark Otto committed
128
<nav class="navbar navbar-inverse">
Mark Otto's avatar
Mark Otto committed
129
130
131
132
133
  <h3 class="navbar-brand pull-left">
    <a href="#">Navbar</a>
  </h3>
  <ul class="nav nav-pills pull-left">
    <li class="nav-item active">
Mark Otto's avatar
Mark Otto committed
134
      <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
Mark Otto's avatar
Mark Otto committed
135
136
137
138
139
140
141
142
143
144
145
    </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
146
  <form class="form-inline pull-right">
Mark Otto's avatar
Mark Otto committed
147
148
149
    <input class="form-control" type="text" placeholder="Search">
    <button class="btn btn-primary" type="submit">Search</button>
  </form>
Mark Otto's avatar
Mark Otto committed
150
</nav>
Mark Otto's avatar
Mark Otto committed
151
{% endexample %}
Mark Otto's avatar
Mark Otto committed
152

Mark Otto's avatar
Mark Otto committed
153
### Collapsible content
Mark Otto's avatar
Mark Otto committed
154

Mark Otto's avatar
Mark Otto committed
155
Our collapse plugin allows you to use a `<button>` or `<a>` to toggle hidden content.
Mark Otto's avatar
Mark Otto committed
156
157

{% example html %}
Mark Otto's avatar
Mark Otto committed
158
<div class="collapse" id="exCollapsingNavbar">
Mark Otto's avatar
Mark Otto committed
159
  <div class="inverse p-a">
Mark Otto's avatar
Mark Otto committed
160
    <h4>Collapsed content</h4>
Mark Otto's avatar
Mark Otto committed
161
162
    <p>Toggleable via the navbar brand.</p>
  </div>
Mark Otto's avatar
Mark Otto committed
163
</div>
Mark Otto's avatar
Mark Otto committed
164
<nav class="navbar navbar-default">
Mark Otto's avatar
Mark Otto committed
165
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#exCollapsingNavbar">
Mark Otto's avatar
Mark Otto committed
166
167
    &#9776;
  </button>
Mark Otto's avatar
Mark Otto committed
168
</nav>
Mark Otto's avatar
Mark Otto committed
169
{% endexample %}
Mark Otto's avatar
Mark Otto committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

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 %}
<nav class="navbar navbar-default">
  <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">
    <h4>Collapsed on xs devices</h4>
    <p>Toggleable via the navbar brand.</p>
  </div>
</nav>
{% endexample %}