Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.13 KB

breadcrumb.md

File metadata and controls

57 lines (43 loc) · 2.13 KB
Raw
layout title description group
docs
Breadcrumb
Indicate the current page's location within a navigational hierarchy that automatically adds separators via CSS.
components

Example

{{< example >}}

  1. Home
  1. Home
  2. Library
  1. Home
  2. Library
  3. Data
{{< /example >}}

Changing the separator

Separators are automatically added in CSS through ::before and content. They can be changed by changing $breadcrumb-divider. The quote function is needed to generate the quotes around a string, so if you want > as separator, you can use this:

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

It's also possible to use an embedded SVG icon:

$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");

The separator can be removed by setting $breadcrumb-divider to none:

$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.