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.
Two levels
Section titled “Two levels”Overview → page
breadcrumb([ { name: 'Home', href: '/' }, { name: 'Contribution' },]);Three levels
Section titled “Three levels”Home → Section → Page
breadcrumb([ { name: 'Home', href: '/' }, { name: 'Contribution', href: '/contribution/overview/' }, { name: 'Components', href: '/contribution/components/' }, { name: 'Callout' },]);| Option | Type | Description |
|---|---|---|
name | string | Display name. |
href | string | Link 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
PageTitleoverride renders this breadcrumb automatically from the sidebar tree.