Documentation and examples for Bootstrap's powerful, responsive navigation header, the navbar. Includes support for branding, navigation, and more, including support for our collapse plugin.
Navbars require a wrapping .navbar with expand{-sm|-md|-lg|-xl|-xxl}
for responsive collapsing and color scheme classes.
Navbar
component with expand="{sm|md|lg|xl|xxl}"
attribute for responsive collapsing and [color scheme](#color-schemes) attribute.active
attribute for the current item in a set.Navbars come with built-in support for a handful of sub-components. Choose from the following as needed:
<NavbarBrand>
for your company, product, or project name.<Navbar>
for a full-height and lightweight navigation (including support for dropdowns).<NavbarToggler>
for use with our collapse plugin and other navigation toggling behaviors.<NavbarText>
for adding vertically centered strings of text.<NavbarCollapse>
for grouping and hiding navbar contents by a parent breakpoint.max-height
and scroll expanded navbar content.Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the lg
(large) breakpoint.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink to="/lang-en/components/navbar/">
Link
</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem to="/lang-en/components/navbar/">
Another action
</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
The <NavbarBrand>
attribute can be applied to most elements, but an anchor works best, as some elements might require utility classes or custom styles.
Add your text within an element with the <NavbarBrand>
attribute.
<template>
<!-- As a link -->
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand href="#">
Navbar
</NavbarBrand>
</Container>
</Navbar>
<!-- As a heading -->
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand
margin="b-0"
headings="1"
>
Navbar
</NavbarBrand>
</Container>
</Navbar>
</template>
You can replace the text within the <NavbarBrand>
attribute with an b-img
component.
You can also make use of some additional utilities to add an image and text at the same time. Note the addition of display="inline-block"
attribute and vertical-align="text-top"
attrubute on the b-img
component.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand href="#">
<b-img
src="https://upload.wikimedia.org/wikipedia/commons/b/b2/Bootstrap_logo.svg"
width="30"
height="24"
vertical-align="text-top"
display="inline-block"
/>
Navbar
</NavbarBrand>
</Container>
</Navbar>
</template>
Navbar navigation links build on our options with their own modifier class and require the use of toggler classes 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.
Add the active
attribute on NavLink
to indicate the current page.
Please note that you should also add the ariaCurrent
attribute on the active NavLink
.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList>
<NavItem>
<NavLink
active
aria-current="page"
>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink
disabled
aria-current="page"
>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
</NavbarCollapse>
</Container>
</Navbar>
</template>
And because we use classes for our navs, you can avoid the list-based approach entirely if you like.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNav>
<NavLink active>
Home
</NavLink>
<NavLink>Features</NavLink>
<NavLink>Pricing</NavLink>
<NavLink disabled>
Disabled
</NavLink>
</NavbarNav>
</NavbarCollapse>
</Container>
</Navbar>
</template>
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 NavItem
component and `NavLink` component as shown below.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList>
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Features</NavLink>
</NavItem>
<NavItem>
<NavLink>Pricing</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown Link</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem>Another action</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
Place various form controls and components within a navbar:
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</Container>
</Navbar>
</template>
Immediate child elements of Navbar
component use flex layout and will default to justify-content: space-between
. Use additional flex utilities as needed to adjust this behavior.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</Container>
</Navbar>
</template>
Input groups work, too. If your navbar is an entire form, or mostly a form, you can use the Container
component as the container and save some HTML.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<BInputGroup>
<BInputGroupText>@</BInputGroupText>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
</BInputGroup>
</Container>
</Navbar>
</template>
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.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container
type="fluid"
justify-content="start"
>
<BForm>
<b-button
button="outline-success"
margin="e-2"
>
Main button
</b-button>
<b-button
button="outline-secondary"
size="sm"
mergin="e-2"
>
Smaller button
</b-button>
</BForm>
</Container>
</Navbar>
</template>
Navbars may contain bits of text with the help of <NavbarText>
component. This class adjusts vertical alignment and horizontal spacing for strings of text.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarText>Navbar text with an inline element</NavbarText>
</Container>
</Navbar>
</template>
Mix and match with other components and utilities as needed.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar w/ text</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Features</NavLink>
</NavItem>
<NavItem>
<NavLink>Pricing</NavLink>
</NavItem>
</NavbarNavList>
<NavbarText>Navbar text with an inline element</NavbarText>
</NavbarCollapse>
</Container>
</Navbar>
</template>
Theming the navbar has never been easier thanks to the combination of theming classes and background-color
attribute. Choose from .navbar-light
for use with light background colors, or .navbar-dark
for dark background colors. Then, customize with .bg-*
utilities.
<template>
<Navbar
expand="lg"
theme="dark"
background-color="dark"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink to="/lang-en/components/navbar/">
Link
</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem to="/lang-en/components/navbar/">
Another action
</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-light"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
<Navbar
expand="lg"
theme="dark"
class="bg-primary"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink to="/lang-en/components/navbar/">
Link
</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem to="/lang-en/components/navbar/">
Another action
</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-light"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
<Navbar
expand="lg"
style="background-color: #e3f2fd;"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink to="/lang-en/components/navbar/">
Link
</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem to="/lang-en/components/navbar/">
Another action
</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-light"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
Although it's not required, you can wrap a navbar in a Container
component to center it on a page–though note that an inner container is still required. Or you can add a container inside the Navbar
component to only center the contents of a fixed or static top navbar .
<template>
<Container>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
</Container>
</Navbar>
</Container>
</template>
Use any of the responsive containers to change how wide the content in your navbar is presented.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="md">
<NavbarBrand>Navbar</NavbarBrand>
</Container>
</Navbar>
</template>
position utilities 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.
Also note that .sticky-top
uses position: sticky
, which isn't fully supported in every browser.
<template>
<Navbar
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Default</NavbarBrand>
</Container>
</Navbar>
</template>
<template>
<Navbar
theme="light"
fixed="top"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Fixed top</NavbarBrand>
</Container>
</Navbar>
</template>
<template>
<Navbar
theme="light"
fixed="bottom"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Fixed bottom</NavbarBrand>
</Container>
</Navbar>
</template>
<template>
<Navbar
theme="light"
sticky
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Sticky top</NavbarBrand>
</Container>
</Navbar>
</template>
Add scroll
attribute to a NavbarNavList
(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 the local CSS custom property --bs-navbar-height
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 scroll
attribute with style="--bs-scroll-height: 100px;"
, with some extra margin utilities for optimum spacing.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList
scroll
scroll-height="100px"
margin="e-auto b-2 b-lg-0"
>
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItemDropdown>
<NavItemDropdownToggle>Dropdown</NavItemDropdownToggle>
<DropdownMenu>
<DropdownItem>Action</DropdownItem>
<DropdownItem>Another action</DropdownItem>
<DropdownItemDivider />
<DropdownItem>Something else here</DropdownItem>
</DropdownMenu>
</NavItemDropdown>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
Navbars can use NavbarToggler
component, NavbarCollapse
component, and expand="{-sm|-md|-lg|-xl|-xxl}
attribute 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.
For navbars that never collapse, add the expand
attribute on the navbar. For navbars that always collapse, don't add any expand
attribute.
Navbar togglers are left-aligned by default, but should they follow a sibling element like a navbarBrand
, 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.
With no navbarBrand
component shown at the smallest breakpoint:
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarToggler />
<NavbarCollapse>
<NavbarBrand>Hidden brand</NavbarBrand>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
With a brand name shown on the left and toggler on the right:
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
With a toggler on the left and brand name on the right:
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
>
<Container type="fluid">
<NavbarToggler />
<NavbarBrand>Navbar</NavbarBrand>
<NavbarCollapse>
<NavbarNavList margin="e-auto b-2 b-lg-0">
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</NavbarCollapse>
</Container>
</Navbar>
</template>
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 target
matching, that's easily done!
<template>
<Collapse id="navbarToggleExternalContent">
<b-div
background-color="dark"
padding="4"
>
<h5 class="text-white h4">
Collapsed content
</h5>
<span class="text-muted">Toggleable via the navbar brand.</span>
</b-div>
</Collapse>
<Navbar
theme="dark"
background-color="dark"
>
<Container type="fluid">
<NavbarToggler target="#navbarToggleExternalContent" />
</Container>
</Navbar>
</template>
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.
Transform your expanding and collapsing navbar into an offcanvas drawer with the offcanvas plugin. We extend both the offcanvas default styles and use our expand
attribute to create a dynamic and flexible navigation sidebar.
In the example below, to create an offcanvas navbar that is always collapsed across all breakpoints, omit the expand
attribute entirely.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
position="fixed-top"
>
<Container type="fluid">
<NavbarBrand>Navbar</NavbarBrand>
<NavbarToggler />
<Offcanvas
id="offcanvasRight"
placement="end"
>
<OffcanvasHeader>
<OffcanvasTitle>Offcanvas</OffcanvasTitle>
<CloseButton dismiss="navbar" />
</OffcanvasHeader>
<OffcanvasBody>
<NavbarNavList>
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
<BForm
flex
role="search"
>
<BFormInput
margin="e-2"
type="search"
placeholder="Search"
/>
<b-button
button="outline-success"
type="submit"
>
Search
</b-button>
</BForm>
</OffcanvasBody>
</Offcanvas>
</Container>
</Navbar>
</template>
To create an offcanvas navbar that expands into a normal navbar at a specific breakpoint like lg
, use expand="lg
.
<template>
<Navbar
expand="lg"
theme="light"
background-color="light"
position="fixed-top"
>
<Container type="fluid">
<NavbarBrand>Offcanvas navbar</NavbarBrand>
<NavbarToggler />
<Offcanvas
id="offcanvasRight"
placement="end"
>
<OffcanvasHeader>
<OffcanvasTitle>Offcanvas</OffcanvasTitle>
<CloseButton dismiss="navbar" />
</OffcanvasHeader>
<OffcanvasBody>
<NavbarNavList>
<NavItem>
<NavLink active>
Home
</NavLink>
</NavItem>
<NavItem>
<NavLink>Link</NavLink>
</NavItem>
<NavItem>
<NavLink disabled>
Disabled
</NavLink>
</NavItem>
</NavbarNavList>
</OffcanvasBody>
</Offcanvas>
</Container>
</Navbar>
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top">
<a
class="navbar-brand"
href="#"
>Offcanvas navbar</a>
<b-button
class="navbar-toggler"
type="button"
toggle="offcanvas"
data-bs-target="#navbarOffcanvasLg"
aria-controls="navbarOffcanvasLg"
>
<span class="navbar-toggler-icon" />
</b-button>
<div
id="navbarOffcanvasLg"
class="offcanvas offcanvas-end"
tabindex="-1"
aria-labelledby="navbarOffcanvasLgLabel"
>
...
</div>
</nav>
</template>