src/scss/bootstrap-4.0.0-alpha.6/docs/components/navbar.md

   1 ---
   2 layout: docs
   3 title: Navbar
   4 description: Documentation and examples for Bootstrap's powerful, responsive navigation header.
   5 group: components
   6 ---
   7
   8 The navbar is a wrapper that positions branding, navigation, and other elements in a concise header. It's easily extensible and, thanks to our Collapse plugin, can easily integrate responsive behaviors.
   9
  10 ## Contents
  11
  12 * Will be replaced with the ToC, excluding the "Contents" header
  13 {:toc}
  14
  15 ## How it works
  16
  17 Here's what you need to know before getting started with the navbar:
  18
  19 - Navbars require a wrapping `.navbar` with `.navbar-toggleable-*` for responsive collapsing and [color scheme](#color-schemes) classes.
  20 - Navbars and their contents are fluid by default. Use [optional containers](#containers) to limit their horizontal width.
  21 - Navbars and their contents are built with flexbox, providing easy alignment options via utility classes.
  22 - Navbars are responsive by default, but you can easily modify them to change that. Responsive behavior depends on our Collapse JavaScript plugin.
  23 - 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.
  24
  25 Read on for an example and list of supported sub-components.
  26
  27 ## Supported content
  28
  29 Navbars come with built-in support for a handful of sub-components. Choose from the following as needed:
  30
  31 - `.navbar-brand` for your company, product, or project name.
  32 - `.navbar-nav` for a full-height and lightweight navigation (including support for dropdowns).
  33 - `.navbar-toggler` for use with our collapse plugin and other [navigation toggling](#responsive-behaviors) behaviors.
  34 - `.form-inline` for any form controls and actions.
  35 - `.navbar-text` for adding vertically centered strings of text.
  36 - `.collapse.navbar-collapse` for grouping and hiding navbar contents by a parent breakpoint.
  37
  38 Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the `md` (medium) breakpoint.
  39
  40 {% example html %}
  41 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
  42   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
  43     <span class="navbar-toggler-icon"></span>
  44   </button>
  45   <a class="navbar-brand" href="#">Navbar</a>
  46
  47   <div class="collapse navbar-collapse" id="navbarSupportedContent">
  48     <ul class="navbar-nav mr-auto">
  49       <li class="nav-item active">
  50         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
  51       </li>
  52       <li class="nav-item">
  53         <a class="nav-link" href="#">Link</a>
  54       </li>
  55       <li class="nav-item">
  56         <a class="nav-link disabled" href="#">Disabled</a>
  57       </li>
  58     </ul>
  59     <form class="form-inline my-2 my-lg-0">
  60       <input class="form-control mr-sm-2" type="text" placeholder="Search">
  61       <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
  62     </form>
  63   </div>
  64 </nav>
  65 {% endexample %}
  66
  67 ### Brand
  68
  69 The `.navbar-brand` can be applied to most elements, but an anchor works best as some elements might require utility classes or custom styles.
  70
  71 {% example html %}
  72 <!-- As a link -->
  73 <nav class="navbar navbar-light bg-faded">
  74   <a class="navbar-brand" href="#">Navbar</a>
  75 </nav>
  76
  77 <!-- As a heading -->
  78 <nav class="navbar navbar-light bg-faded">
  79   <h1 class="navbar-brand mb-0">Navbar</h1>
  80 </nav>
  81 {% endexample %}
  82
  83 Adding images to the `.navbar-brand` will likely always require custom styles or utilities to properly size. Here are some examples to demonstrate.
  84
  85 {% example html %}
  86 <!-- Just an image -->
  87 <nav class="navbar navbar-light bg-faded">
  88   <a class="navbar-brand" href="#">
  89     <img src="{{ site.baseurl }}/assets/brand/bootstrap-solid.svg" width="30" height="30" alt="">
  90   </a>
  91 </nav>
  92 {% endexample %}
  93
  94 {% example html %}
  95 <!-- Image and text -->
  96 <nav class="navbar navbar-light bg-faded">
  97   <a class="navbar-brand" href="#">
  98     <img src="{{ site.baseurl }}/assets/brand/bootstrap-solid.svg" width="30" height="30" class="d-inline-block align-top" alt="">
  99     Bootstrap
 100   </a>
 101 </nav>
 102 {% endexample %}
 103
 104 ### Nav
 105
 106 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.
 107
 108 Active states—with `.active`—to indicate the current page can be applied directly to `.nav-link`s or their immediate parent `.nav-item`s.
 109
 110 {% example html %}
 111 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 112   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
 113     <span class="navbar-toggler-icon"></span>
 114   </button>
 115   <a class="navbar-brand" href="#">Navbar</a>
 116   <div class="collapse navbar-collapse" id="navbarNav">
 117     <ul class="navbar-nav">
 118       <li class="nav-item active">
 119         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 120       </li>
 121       <li class="nav-item">
 122         <a class="nav-link" href="#">Features</a>
 123       </li>
 124       <li class="nav-item">
 125         <a class="nav-link" href="#">Pricing</a>
 126       </li>
 127       <li class="nav-item">
 128         <a class="nav-link disabled" href="#">Disabled</a>
 129       </li>
 130     </ul>
 131   </div>
 132 </nav>
 133 {% endexample %}
 134
 135 And because we use classes for our navs, you can avoid the list-based approach entirely if you like.
 136
 137 {% example html %}
 138 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 139   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
 140     <span class="navbar-toggler-icon"></span>
 141   </button>
 142   <a class="navbar-brand" href="#">Navbar</a>
 143   <div class="collapse navbar-collapse" id="navbarNavAltMarkup">
 144     <div class="navbar-nav">
 145       <a class="nav-item nav-link active" href="#">Home <span class="sr-only">(current)</span></a>
 146       <a class="nav-item nav-link" href="#">Features</a>
 147       <a class="nav-item nav-link" href="#">Pricing</a>
 148       <a class="nav-item nav-link disabled" href="#">Disabled</a>
 149     </div>
 150   </div>
 151 </nav>
 152 {% endexample %}
 153
 154 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.
 155
 156 {% example html %}
 157 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 158   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarNavDropdown" aria-controls="navbarNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
 159     <span class="navbar-toggler-icon"></span>
 160   </button>
 161   <a class="navbar-brand" href="#">Navbar</a>
 162   <div class="collapse navbar-collapse" id="navbarNavDropdown">
 163     <ul class="navbar-nav">
 164       <li class="nav-item active">
 165         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 166       </li>
 167       <li class="nav-item">
 168         <a class="nav-link" href="#">Features</a>
 169       </li>
 170       <li class="nav-item">
 171         <a class="nav-link" href="#">Pricing</a>
 172       </li>
 173       <li class="nav-item dropdown">
 174         <a class="nav-link dropdown-toggle" href="http://example.com" id="navbarDropdownMenuLink" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
 175           Dropdown link
 176         </a>
 177         <div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
 178           <a class="dropdown-item" href="#">Action</a>
 179           <a class="dropdown-item" href="#">Another action</a>
 180           <a class="dropdown-item" href="#">Something else here</a>
 181         </div>
 182       </li>
 183     </ul>
 184   </div>
 185 </nav>
 186 {% endexample %}
 187
 188 ### Forms
 189
 190 Place various form controls and components within a navbar with `.form-inline`.
 191
 192 {% example html %}
 193 <nav class="navbar navbar-light bg-faded">
 194   <form class="form-inline">
 195     <input class="form-control mr-sm-2" type="text" placeholder="Search">
 196     <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
 197   </form>
 198 </nav>
 199 {% endexample %}
 200
 201 Align the contents of your inline forms with utilities as needed.
 202
 203 {% example html %}
 204 <nav class="navbar navbar-light bg-faded justify-content-between">
 205   <a class="navbar-brand">Navbar</a>
 206   <form class="form-inline">
 207     <input class="form-control mr-sm-2" type="text" placeholder="Search">
 208     <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
 209   </form>
 210 </nav>
 211 {% endexample %}
 212
 213 Input groups work, too:
 214
 215 {% example html %}
 216 <nav class="navbar navbar-light bg-faded">
 217   <form class="form-inline">
 218     <div class="input-group">
 219       <span class="input-group-addon" id="basic-addon1">@</span>
 220       <input type="text" class="form-control" placeholder="Username" aria-describedby="basic-addon1">
 221     </div>
 222   </form>
 223 </nav>
 224 {% endexample %}
 225
 226 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.
 227
 228 {% example html %}
 229 <nav class="navbar navbar-light bg-faded">
 230   <form class="form-inline">
 231     <button class="btn btn-outline-success" type="button">Main button</button>
 232     <button class="btn btn-sm align-middle btn-outline-secondary" type="button">Smaller button</button>
 233   </form>
 234 </nav>
 235 {% endexample %}
 236
 237 ### Text
 238
 239 Navbars may contain bits of text with the help of `.navbar-text`. This class adjusts vertical alignment and horizontal spacing for strings of text.
 240
 241 {% example html %}
 242 <nav class="navbar navbar-light bg-faded">
 243   <span class="navbar-text">
 244     Navbar text with an inline element
 245   </span>
 246 </nav>
 247 {% endexample %}
 248
 249 Mix and match with other components and utilities as needed.
 250
 251 {% example html %}
 252 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 253   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarText" aria-controls="navbarText" aria-expanded="false" aria-label="Toggle navigation">
 254     <span class="navbar-toggler-icon"></span>
 255   </button>
 256   <a class="navbar-brand" href="#">Navbar w/ text</a>
 257   <div class="collapse navbar-collapse" id="navbarText">
 258     <ul class="navbar-nav mr-auto">
 259       <li class="nav-item active">
 260         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 261       </li>
 262       <li class="nav-item">
 263         <a class="nav-link" href="#">Features</a>
 264       </li>
 265       <li class="nav-item">
 266         <a class="nav-link" href="#">Pricing</a>
 267       </li>
 268     </ul>
 269     <span class="navbar-text">
 270       Navbar text with an inline element
 271     </span>
 272   </div>
 273 </nav>
 274 {% endexample %}
 275
 276 ## Color schemes
 277
 278 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-inverse` for dark background colors. Then, customize with `.bg-*` utilities.
 279
 280 <div class="bd-example">
 281   <nav class="navbar navbar-toggleable-md navbar-inverse bg-inverse">
 282     <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarColor01" aria-controls="navbarColor01" aria-expanded="false" aria-label="Toggle navigation">
 283     <span class="navbar-toggler-icon"></span>
 284   </button>
 285     <a class="navbar-brand" href="#">Navbar</a>
 286
 287     <div class="collapse navbar-collapse" id="navbarColor01">
 288       <ul class="navbar-nav mr-auto">
 289         <li class="nav-item active">
 290           <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 291         </li>
 292         <li class="nav-item">
 293           <a class="nav-link" href="#">Features</a>
 294         </li>
 295         <li class="nav-item">
 296           <a class="nav-link" href="#">Pricing</a>
 297         </li>
 298         <li class="nav-item">
 299           <a class="nav-link" href="#">About</a>
 300         </li>
 301       </ul>
 302       <form class="form-inline">
 303         <input class="form-control mr-sm-2" type="text" placeholder="Search">
 304         <button class="btn btn-outline-info my-2 my-sm-0" type="submit">Search</button>
 305       </form>
 306     </div>
 307   </nav>
 308
 309   <nav class="navbar navbar-toggleable-md navbar-inverse bg-primary">
 310     <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarColor02" aria-controls="navbarColor02" aria-expanded="false" aria-label="Toggle navigation">
 311       <span class="navbar-toggler-icon"></span>
 312     </button>
 313     <a class="navbar-brand" href="#">Navbar</a>
 314
 315     <div class="collapse navbar-collapse" id="navbarColor02">
 316       <ul class="navbar-nav mr-auto">
 317         <li class="nav-item active">
 318           <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 319         </li>
 320         <li class="nav-item">
 321           <a class="nav-link" href="#">Features</a>
 322         </li>
 323         <li class="nav-item">
 324           <a class="nav-link" href="#">Pricing</a>
 325         </li>
 326         <li class="nav-item">
 327           <a class="nav-link" href="#">About</a>
 328         </li>
 329       </ul>
 330       <form class="form-inline">
 331         <input class="form-control mr-sm-2" type="text" placeholder="Search">
 332         <button class="btn btn-outline-secondary my-2 my-sm-0" type="submit">Search</button>
 333       </form>
 334     </div>
 335   </nav>
 336
 337   <nav class="navbar navbar-toggleable-md navbar-light" style="background-color: #e3f2fd;">
 338     <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarColor03" aria-controls="navbarColor03" aria-expanded="false" aria-label="Toggle navigation">
 339       <span class="navbar-toggler-icon"></span>
 340     </button>
 341     <a class="navbar-brand" href="#">Navbar</a>
 342
 343     <div class="collapse navbar-collapse" id="navbarColor03">
 344       <ul class="navbar-nav mr-auto">
 345         <li class="nav-item active">
 346           <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 347         </li>
 348         <li class="nav-item">
 349           <a class="nav-link" href="#">Features</a>
 350         </li>
 351         <li class="nav-item">
 352           <a class="nav-link" href="#">Pricing</a>
 353         </li>
 354         <li class="nav-item">
 355           <a class="nav-link" href="#">About</a>
 356         </li>
 357       </ul>
 358       <form class="form-inline">
 359         <input class="form-control mr-sm-2" type="text" placeholder="Search">
 360         <button class="btn btn-outline-primary my-2 my-sm-0" type="submit">Search</button>
 361       </form>
 362     </div>
 363   </nav>
 364 </div>
 365
 366 {% highlight html %}
 367 <nav class="navbar navbar-inverse bg-inverse">
 368   <!-- Navbar content -->
 369 </nav>
 370
 371 <nav class="navbar navbar-inverse bg-primary">
 372   <!-- Navbar content -->
 373 </nav>
 374
 375 <nav class="navbar navbar-light" style="background-color: #e3f2fd;">
 376   <!-- Navbar content -->
 377 </nav>
 378 {% endhighlight %}
 379
 380 ## Containers
 381
 382 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).
 383
 384 {% example html %}
 385 <div class="container">
 386   <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 387     <a class="navbar-brand" href="#">Navbar</a>
 388   </nav>
 389 </div>
 390 {% endexample %}
 391
 392 When the container is within your navbar, its horizontal padding is removed at breakpoints lower than your specified `.navbar-toggleable-*` class. This ensures we're not doubling up on padding unnecessarily on lower viewports when your navbar is collapsed.
 393
 394 {% example html %}
 395 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 396   <div class="container">
 397     <a class="navbar-brand" href="#">Navbar</a>
 398   </div>
 399 </nav>
 400 {% endexample %}
 401
 402 ## Placement
 403
 404 Use our position utilities to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top. **Note that `position: sticky`, used for `.sticky-top`, isn't fully supported in every browser.**
 405
 406 {% example html %}
 407 <nav class="navbar navbar-light bg-faded">
 408   <a class="navbar-brand" href="#">Full width</a>
 409 </nav>
 410 {% endexample %}
 411
 412 {% example html %}
 413 <nav class="navbar fixed-top navbar-light bg-faded">
 414   <a class="navbar-brand" href="#">Fixed top</a>
 415 </nav>
 416 {% endexample %}
 417
 418 {% example html %}
 419 <nav class="navbar fixed-bottom navbar-light bg-faded">
 420   <a class="navbar-brand" href="#">Fixed bottom</a>
 421 </nav>
 422 {% endexample %}
 423
 424 {% example html %}
 425 <nav class="navbar sticky-top navbar-light bg-faded">
 426   <a class="navbar-brand" href="#">Sticky top</a>
 427 </nav>
 428 {% endexample %}
 429
 430 ## Responsive behaviors
 431
 432 Navbars can utilize `.navbar-toggler`, `.navbar-collapse`, and `.navbar-toggleable-*` classes to change when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements.
 433
 434 ### Toggler
 435
 436 Navbar togglers can be left or right aligned with `.navbar-toggler-left` or `.navbar-toggler-right` modifiers. These are absolutely positioned within the navbar to avoid interference with the collapsed state. You can also use your own styles to position togglers. Below are examples of different toggle styles.
 437
 438 With no `.navbar-brand` shown in lowest breakpoint:
 439
 440 {% example html %}
 441 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 442   <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo01" aria-controls="navbarTogglerDemo01" aria-expanded="false" aria-label="Toggle navigation">
 443     <span class="navbar-toggler-icon"></span>
 444   </button>
 445   <div class="collapse navbar-collapse" id="navbarTogglerDemo01">
 446     <a class="navbar-brand" href="#">Hidden brand</a>
 447     <ul class="navbar-nav mr-auto mt-2 mt-lg-0">
 448       <li class="nav-item active">
 449         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 450       </li>
 451       <li class="nav-item">
 452         <a class="nav-link" href="#">Link</a>
 453       </li>
 454       <li class="nav-item">
 455         <a class="nav-link disabled" href="#">Disabled</a>
 456       </li>
 457     </ul>
 458     <form class="form-inline my-2 my-lg-0">
 459       <input class="form-control mr-sm-2" type="text" placeholder="Search">
 460       <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
 461     </form>
 462   </div>
 463 </nav>
 464 {% endexample %}
 465
 466 With a brand name shown on the left and toggler on the right:
 467
 468 {% example html %}
 469 <nav class="navbar navbar-toggleable-md navbar-light bg-faded">
 470   <button class="navbar-toggler navbar-toggler-right" type="button" data-toggle="collapse" data-target="#navbarTogglerDemo02" aria-controls="navbarTogglerDemo02" aria-expanded="false" aria-label="Toggle navigation">
 471     <span class="navbar-toggler-icon"></span>
 472   </button>
 473   <a class="navbar-brand" href="#">Navbar</a>
 474
 475   <div class="collapse navbar-collapse" id="navbarTogglerDemo02">
 476     <ul class="navbar-nav mr-auto mt-2 mt-md-0">
 477       <li class="nav-item active">
 478         <a class="nav-link" href="#">Home <span class="sr-only">(current)</span></a>
 479       </li>
 480       <li class="nav-item">
 481         <a class="nav-link" href="#">Link</a>
 482       </li>
 483       <li class="nav-item">
 484         <a class="nav-link disabled" href="#">Disabled</a>
 485       </li>
 486     </ul>
 487     <form class="form-inline my-2 my-lg-0">
 488       <input class="form-control mr-sm-2" type="text" placeholder="Search">
 489       <button class="btn btn-outline-success my-2 my-sm-0" type="submit">Search</button>
 490     </form>
 491   </div>
 492 </nav>
 493 {% endexample %}
 494
 495 ### External content
 496
 497 Sometimes you want to use the collapse plugin to trigger hidden content elsewhere on the page. Because our plugin works on the `id` and `data-target` matching, that's easily done!
 498
 499 {% example html %}
 500 <div class="pos-f-t">
 501   <div class="collapse" id="navbarToggleExternalContent">
 502     <div class="bg-inverse p-4">
 503       <h4 class="text-white">Collapsed content</h4>
 504       <span class="text-muted">Toggleable via the navbar brand.</span>
 505     </div>
 506   </div>
 507   <nav class="navbar navbar-inverse bg-inverse">
 508     <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarToggleExternalContent" aria-controls="navbarToggleExternalContent" aria-expanded="false" aria-label="Toggle navigation">
 509       <span class="navbar-toggler-icon"></span>
 510     </button>
 511   </nav>
 512 </div>
 513 {% endexample %}