Breadcrumb

Shows the current page location within a navigation hierarchy

Category: navigation · WCAG 2.2-AA · breadcrumb, navigation, hierarchy

Props

PropTypeDefaultDescription
items{ label: string; href?: string }[]The items to render.
maxVisiblenumberWhen items exceed this count, collapse to the first item, an ellipsis, and the trailing items
classNamestringAdditional CSS class names merged onto the root element.
ariaLabelstringBreadcrumbAccessible label for the component.

Design tokens

When to use

When not to use

How to build an accessible Breadcrumb in React →

Examples

Basic

<Breadcrumb items={[{ label: 'Home', href: '/' }, { label: 'Docs', href: '/docs' }, { label: 'Breadcrumb' }]} />

Collapsed

Long trails collapse to the first item, an ellipsis, and the trailing items.

<Breadcrumb maxVisible={3} items={[{ label: 'Home', href: '/' }, { label: 'Docs', href: '/docs' }, { label: 'Components', href: '/docs/components' }, { label: 'Breadcrumb' }]} />

Related components

← Back to docs