Breadcrumb
stableDisplays the path to the current resource.
Basic usage
Examples
Multi-level navigation
Three levels showing the full path to the current resource.
Long path with ellipsis
Breadcrumb supports links, separators, current page and compact overflow markers.
Features
- Navigable links + current page.
- Custom separators.
Installation
bash
pnpm dlx structyl add breadcrumbAPI Reference
Breadcrumb.Root
A nav landmark labelled "breadcrumb".
| Prop | Type | Default |
|---|
Breadcrumb.List
The ordered list of crumbs.
| Prop | Type | Default |
|---|---|---|
| className | stringAdditional Tailwind classes, merged with the component defaults. | — |
Breadcrumb.Item
A single crumb.
| Prop | Type | Default |
|---|---|---|
| className | stringAdditional Tailwind classes, merged with the component defaults. | — |
Breadcrumb.Link
A navigable crumb link.
| Prop | Type | Default |
|---|---|---|
| asChild | booleanMerge props onto the immediate child instead of rendering a default element. | false |
| className | stringAdditional Tailwind classes, merged with the component defaults. | — |
Breadcrumb.Page
The current page crumb (non-link).
| Prop | Type | Default |
|---|---|---|
| className | stringAdditional Tailwind classes, merged with the component defaults. | — |
Breadcrumb.Separator
Divider between crumbs.
| Prop | Type | Default |
|---|---|---|
| className | stringAdditional Tailwind classes, merged with the component defaults. | — |