This commit includes all the needed workarounds and most changes from the main branch for everything to work, like: * removing empty lines in raw HTML that break output * read .browserslistrc, CSS variables from disk instead of duplicating it * using Hugo mounts * using Hugo for the docs CSS/JS * move ToC Sass code to a separate file while adapting it for Hugo Thus, this patch makes our npm scripts faster since lint runs on one step and there's no separate docs assets processing.
2.2 KiB
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 >}}
- Home
- Home
- Library
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 a base64 embedded SVG icon:
$breadcrumb-divider: url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI4IiBoZWlnaHQ9IjgiPjxwYXRoIGQ9Ik0yLjUgMEwxIDEuNSAzLjUgNCAxIDYuNSAyLjUgOGw0LTQtNC00eiIgZmlsbD0iY3VycmVudENvbG9yIi8+PC9zdmc+);
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.