Breadcrumbs
A navigation component showing hierarchy and path in an application.
Anatomy
Usage
Breadcrumbs.Composed Props
Composed breadcrumb component that handles complex breadcrumb trails. Features automatic truncation and overflow handling for long paths.
| Prop | Type | Default |
|---|---|---|
breadcrumbs* | Breadcrumb[] | — |
max | number | "5" |
link | LinkProp<P> | "a" |
className | string | — |
children | ReactNode | — |
separator | ReactNode | — |
Breadcrumbs.Root Props
Root container component for breadcrumb navigation. Renders a semantic nav element with ARIA breadcrumb role.
| Prop | Type | Default |
|---|---|---|
className | string | — |
children | ReactNode | — |
separator | ReactNode | — |
Breadcrumbs.Ellipsis Props
Ellipsis indicator for collapsed breadcrumb items. Used when breadcrumb trail is truncated.
| Prop | Type | Default |
|---|---|---|
className | string | — |
children | ReactNode | — |
Breadcrumbs.Item Props
Individual breadcrumb item container. Handles layout and styling for each breadcrumb segment.
| Prop | Type | Default |
|---|---|---|
className | string | — |
children | ReactNode | — |
Breadcrumbs.Link Props
Interactive link component for clickable breadcrumb segments. Extends the base Link component with breadcrumb-specific styling.
| Prop | Type | Default |
|---|
Breadcrumbs.List Props
Container for breadcrumb items rendered as an ordered list. Provides consistent spacing and text styling for breadcrumb items.
| Prop | Type | Default |
|---|---|---|
type | enum | — |
className | string | — |
children | ReactNode | — |
Breadcrumbs.Overflow Props
Overflow menu component for collapsed breadcrumb items. Displays hidden breadcrumbs in a popover when clicked.
| Prop | Type | Default |
|---|---|---|
breadcrumbs* | Breadcrumb[] | — |
link | LinkProp<P> | — |
Breadcrumbs.Page Props
Current page indicator in the breadcrumb trail. Renders as a non-interactive span with distinct styling.
| Prop | Type | Default |
|---|---|---|
className | string | — |
children | ReactNode | — |
Breadcrumbs.Separator Props
Visual separator between breadcrumb items. Defaults to a chevron icon but can be customized via children.
| Prop | Type | Default |
|---|---|---|
className | string | — |
children | ReactNode | — |