mirror of
https://github.com/twbs/bootstrap.git
synced 2025-10-03 16:51:54 +02:00
96 lines
4.5 KiB
Plaintext
96 lines
4.5 KiB
Plaintext
---
|
||
title: Breadcrumb
|
||
description: Indicate the current page’s location within a navigational hierarchy that automatically adds separators via CSS.
|
||
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 code={`<nav aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item active" aria-current="page">Home</li>
|
||
</ol>
|
||
</nav>
|
||
|
||
<nav aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item"><a href="#">Home</a></li>
|
||
<li class="breadcrumb-item active" aria-current="page">Library</li>
|
||
</ol>
|
||
</nav>
|
||
|
||
<nav aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<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>
|
||
</ol>
|
||
</nav>`} />
|
||
|
||
## Dividers
|
||
|
||
Dividers are automatically added in CSS through [`::before`](https://developer.mozilla.org/en-US/docs/Web/CSS/::before) and [`content`](https://developer.mozilla.org/en-US/docs/Web/CSS/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 code={`<nav style="--bs-breadcrumb-divider: '>';" aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item"><a href="#">Home</a></li>
|
||
<li class="breadcrumb-item active" aria-current="page">Library</li>
|
||
</ol>
|
||
</nav>`} />
|
||
|
||
When modifying via Sass, the [quote](https://sass-lang.com/documentation/modules/string/#quote) function is required to generate the quotes around a string. For example, using `>` as the divider, you can use this:
|
||
|
||
```scss
|
||
$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.
|
||
|
||
<Callout>
|
||
**Inlined SVG requires properly escaped characters.** Some reserved characters, such as `<`, `>` and `#`, must be URL-encoded or escaped. We do this with the `$breadcrumb-divider` variable using our [`escape-svg()` Sass function]([[docsref:/customize/sass#escape-svg]]). When customizing the CSS variable, you must handle this yourself. Read [Kevin Weber’s explanations on CodePen](https://codepen.io/kevinweber/pen/dXWoRw ) for more info.
|
||
</Callout>
|
||
|
||
<Example code={`<nav style="--bs-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='%236c757d'/%3E%3C/svg%3E");" aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item"><a href="#">Home</a></li>
|
||
<li class="breadcrumb-item active" aria-current="page">Library</li>
|
||
</ol>
|
||
</nav>`} />
|
||
|
||
```scss
|
||
$breadcrumb-divider: url("data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' width='8' height='8'><path d='M2.5 0L1 1.5 3.5 4 1 6.5 2.5 8l4-4-4-4z' fill='#{$breadcrumb-divider-color}'/></svg>");
|
||
```
|
||
|
||
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 code={`<nav style="--bs-breadcrumb-divider: '';" aria-label="breadcrumb">
|
||
<ol class="breadcrumb">
|
||
<li class="breadcrumb-item"><a href="#">Home</a></li>
|
||
<li class="breadcrumb-item active" aria-current="page">Library</li>
|
||
</ol>
|
||
</nav>`} />
|
||
|
||
```scss
|
||
$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 [ARIA Authoring Practices Guide breadcrumb pattern](https://www.w3.org/WAI/ARIA/apg/patterns/breadcrumb/).
|
||
|
||
## CSS
|
||
|
||
### Variables
|
||
|
||
<CSSVariables component="Breadcrumbs" className="breadcrumb" />
|
||
|
||
<ScssDocs name="breadcrumb-css-vars" file="scss/_breadcrumb.scss" />
|
||
|
||
### Sass variables
|
||
|
||
<ScssDocs name="breadcrumb-variables" file="scss/_variables.scss" />
|