Breadcrumb API
View componentThe full prop reference for the Breadcrumb component. Displays the path to the current resource.
Import
import { Breadcrumb } from '@structyl/styled';Props
Breadcrumb (Primitive Root)
Headless breadcrumb navigation container; wraps children in a <nav> with an <ol>.
| Prop | Type | Default |
|---|---|---|
| label# | stringaria-label for the nav element | 'Breadcrumb' |
| children# | React.ReactNodeContent to render inside the <ol> | — |
| className# | stringCSS class for the nav element | — |
| ref# | React.Ref<HTMLElement>Ref forwarded to the <nav> element | — |
BreadcrumbItem (Primitive)
Headless breadcrumb list item; renders as <li>.
| Prop | Type | Default |
|---|---|---|
| children# | React.ReactNodeContent to render inside the <li> | — |
| className# | stringCSS class for the li element | — |
| ref# | React.Ref<HTMLLIElement>Ref forwarded to the <li> element | — |
BreadcrumbLink (Primitive)
Headless breadcrumb link; renders as <a>.
| Prop | Type | Default |
|---|---|---|
| children# | React.ReactNodeLink text content | — |
| href# | stringURL the link navigates to | — |
| className# | stringCSS class for the anchor element | — |
| ref# | React.Ref<HTMLAnchorElement>Ref forwarded to the <a> element | — |
Root (Styled)
Styled breadcrumb navigation container; renders <nav aria-label="breadcrumb">.
| Prop | Type | Default |
|---|---|---|
| separator# | React.ReactNodeOptional custom separator element (not actively used, provided for API completeness) | — |
| className# | stringCSS class for the nav element | — |
| ref# | React.Ref<HTMLElement>Ref forwarded to the <nav> element | — |
List (Styled)
Styled breadcrumb list container; renders <ol> with flex layout and gap styling.
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class merged with design system styles | — |
| ref# | React.Ref<HTMLOListElement>Ref forwarded to the <ol> element | — |
Item (Styled)
Styled breadcrumb list item; renders <li> with inline-flex and gap styling.
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class merged with design system styles | — |
| ref# | React.Ref<HTMLLIElement>Ref forwarded to the <li> element | — |
Link (Styled)
Styled breadcrumb link; renders <a> (or custom component via Slot when asChild=true) with hover styling.
| Prop | Type | Default |
|---|---|---|
| asChild# | booleanIf true, render child component instead of <a> tag | — |
| href# | stringURL the link navigates to | — |
| className# | stringCSS class merged with design system styles | — |
| ref# | React.Ref<HTMLAnchorElement>Ref forwarded to the <a> element | — |
Page (Styled)
Styled breadcrumb current page indicator; renders <span role="link" aria-disabled="true" aria-current="page">.
| Prop | Type | Default |
|---|---|---|
| children# | React.ReactNodePage label text | — |
| className# | stringCSS class merged with design system styles | — |
| ref# | React.Ref<HTMLSpanElement>Ref forwarded to the <span> element | — |
Separator (Styled)
Breadcrumb path separator; renders <li role="presentation" aria-hidden="true"> with default ChevronRight icon.
| Prop | Type | Default |
|---|---|---|
| children# | React.ReactNodeCustom separator icon/element; defaults to <ChevronRight /> if not provided | — |
| className# | stringCSS class merged with design system styles | — |
Ellipsis (Styled)
Breadcrumb ellipsis indicator for truncated path sections; renders <span> with MoreHorizontal icon and sr-only label.
| Prop | Type | Default |
|---|---|---|
| className# | stringCSS class merged with design system styles | — |
Source code
If you didn't find what you need here, read the component implementation .