Skip to content

Breadcrumb

Trail of page ancestors with separators.

A breadcrumb shows where the current page sits. Items are separated by chevron icons; the last item (no href) renders as the current page.

Overview → page
breadcrumb([
{ name: 'Home', href: '/' },
{ name: 'Contribution' },
]);
Home → Section → Page
breadcrumb([
{ name: 'Home', href: '/' },
{ name: 'Contribution', href: '/contribution/overview/' },
{ name: 'Components', href: '/contribution/components/' },
{ name: 'Callout' },
]);
OptionTypeDescription
namestringDisplay name.
hrefstringLink target; omit for the last (current) item.
  • The container is <nav aria-label="Breadcrumb">; the current page uses .cpd-breadcrumb-current (not a link).
  • On the real docs pages the PageTitle override renders this breadcrumb automatically from the sidebar tree.