Breadcrumb
Breadcrumbs provide secondary navigation to help users understand where they are in a website.
Default
Component Preview
Component Code
<nav class="usa-breadcrumb" aria-label="Breadcrumbs"> <ol class="usa-breadcrumb__list"> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Home</span></a> </li> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Parent Section</span></a> </li> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Child Section</span></a> </li> <li class="usa-breadcrumb__list-item usa-current" aria-current="page"> <span>Current Page</span> </li> </ol> </nav>
Wrapping
Component Preview
Component Code
<nav class="usa-breadcrumb usa-breadcrumb--wrap" aria-label="Breadcrumbs"> <ol class="usa-breadcrumb__list"> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Home</span></a> </li> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Federal Contracting</span></a> </li> <li class="usa-breadcrumb__list-item"> <a href="#" class="usa-breadcrumb__link"><span>Contracting assistance programs</span></a> </li> <li class="usa-breadcrumb__list-item usa-current" aria-current="page"> <span>Economically disadvantaged women-owned small business federal contracting program</span> </li> </ol> </nav>
Guidance
When to use the breadcrumb component
- When orientation matters.
- Breadcrumbs show where the current page is located in the website hierarchy. Use a breadcrumb when it's likely that a user will arrive at an interior page from search or from an outside link.
- To facilitate navigation.
- Breadcrumbs make it easier to understand complex sites. Use breadcrumbs to reinforce your site's structure.
When to consider something else
- Simple sites.
- If the website is not very deep and the context for the current page is clear from the main navigation.
- Landing pages.
- Omit breadcrumbs on the homepage of a site. Breadcrumbs could also be omitted from section landing pages.
- Step-by-step processes.
- Use breadcrumbs for hierarchical relationships, not linear relationships (like individual steps in a multi-step process).
Usability guidance
- Use complete page titles.
- Use the same wording in breadcrumb text as in the page title.
- Start with the word "Home".
- Rather than using a house icon, spell out the word "Home" as the first link in the breadcrumbs.
- Consider size of tap targets on small widths.
- Although breadcrumbs are frequently displayed using smaller text, make sure the text is not too small to select at small widths.
Accessibility guidance
- Use the
navelement. - This allows assistive technology to present the breadcrumbs in context as a navigational element on the page.
- Use ordered lists and list items.
- Use an
olfor breadcrumbs and anlifor each item. This allows assistive technology to enumerate the items. - Use ARIA markup for additional context.
- Use
aria-label="Breadcrumbs"on the main element andaria-current="page"on the current page.
USWDS Documentation
For more guidance, view the USWDS Breadcrumb Component Documentation.
Settings
| Variable | Description |
|---|---|
$theme-breadcrumb-background-color
|
The background color of the breadcrumb bar. |
$theme-breadcrumb-font-family
|
The family of the breadcrumb text. |
$theme-breadcrumb-font-size
|
The size of the breadcrumb text. |
$theme-breadcrumb-link-color
|
The color of breadcrumb links. |
$theme-breadcrumb-separator-color
|
Color of the breadcrumb separator. |
Variants
| Variant | Description |
|---|---|
|
|
Wrap the breadcrumb bar instead of truncating. |