Skip to content
Navigation

Breadcrumb

Shows where the current page sits in the hierarchy, and links back up it.

Three-Level Breadcrumb

Import

import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@mikenotthepope/substrateui"

Composition

Breadcrumb
└── BreadcrumbList
    ├── BreadcrumbItem
    │   ├── BreadcrumbLink
    │   └── BreadcrumbPage
    └── BreadcrumbSeparator

Direction

The default chevron separator flips automatically in RTL so it points in reading direction. If you pass a custom separator, make sure its glyph also respects direction — a "/" is direction-neutral, but an arrow is not.

Labels

The nav's own accessible name and the ellipsis both live here, and neither has visible text to fall back on. Override one instance with the labels prop on the component, or every instance at once through LabelsProvider's breadcrumb key — the provider is how you translate the set once instead of at each call site.

PropTypeDefaultDescription
breadcrumbstring"breadcrumb"aria-label on the nav element — how a screen reader names the trail.
morestring"More"Accessible name for the collapsed-items ellipsis.

API Reference

PropTypeDefaultDescription
classNamestringAdditional CSS classes to apply to the breadcrumb container.