breadcrumb.md 3.9 KB


layout: docs title: Breadcrumb description: Indicate the current page's location within a navigational hierarchy that automatically adds separators via CSS. group: components

toc: true

Example

Use an ordered or unordered list with linked list items to create a minimally styled breadcrumb. Use our utilities to add additional styles as desired.

{{< example >}}

    <li class="breadcrumb-item active" aria-current="page">Home</li>
    

    1. Home
    2. Library

      <li class="breadcrumb-item"><a href="#">Home</a></li>
      <li class="breadcrumb-item"><a href="#">Library</a></li>
      <li class="breadcrumb-item active" aria-current="page">Data</li>
      

      {{< /example >}}

      Dividers

      Dividers are automatically added in CSS through ::before and content. They can be changed by modifying a local CSS custom property --bs-breadcrumb-divider, or through the $breadcrumb-divider Sass variable — and $breadcrumb-divider-flipped for its RTL counterpart, if needed. We default to our Sass variable, which is set as a fallback to the custom property. This way, you get a global divider that you can override without recompiling CSS at any time.

      {{< example >}}

      <li class="breadcrumb-item"><a href="#">Home</a></li>
      <li class="breadcrumb-item active" aria-current="page">Library</li>
      

      {{< /example >}}

      When modifying via Sass, the quote function is required to generate the quotes around a string. For example, using > as the divider, you can use this:

      $breadcrumb-divider: quote(">");
      

      It's also possible to use an embedded SVG icon. Apply it via our CSS custom property, or use the Sass variable.

      {{< example >}}

        <li class="breadcrumb-item"><a href="#">Home</a></li>
        <li class="breadcrumb-item active" aria-current="page">Library</li>
        

        {{< /example >}}

        $breadcrumb-divider: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='8' height='8'%3E%3Cpath d='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z' fill='currentColor'/%3E%3C/svg%3E");
        

        You can also remove the divider setting --bs-breadcrumb-divider: ''; (empty strings in CSS custom properties counts as a value), or setting the Sass variable to $breadcrumb-divider: none;.

        {{< example >}}

          <li class="breadcrumb-item"><a href="#">Home</a></li>
          <li class="breadcrumb-item active" aria-current="page">Library</li>
          

          {{< /example >}}

          $breadcrumb-divider: none;
          

          Accessibility

          Since breadcrumbs provide a navigation, it's a good idea to add a meaningful label such as aria-label="breadcrumb" to describe the type of navigation provided in the <nav> element, as well as applying an aria-current="page" to the last item of the set to indicate that it represents the current page.

          For more information, see the WAI-ARIA Authoring Practices for the breadcrumb pattern.

          Sass

          Variables

          {{< scss-docs name="breadcrumb-variables" file="scss/_variables.scss" >}}