structyl

Breadcrumb API

View component

The full prop reference for the Breadcrumb component. Displays the path to the current resource.

Import

tsx
import { Breadcrumb } from '@structyl/styled';

Props

Breadcrumb (Primitive Root)

Headless breadcrumb navigation container; wraps children in a <nav> with an <ol>.

PropTypeDefault
label#string

aria-label for the nav element

'Breadcrumb'
children#React.ReactNode

Content to render inside the <ol>

className#string

CSS class for the nav element

ref#React.Ref<HTMLElement>

Ref forwarded to the <nav> element

BreadcrumbItem (Primitive)

Headless breadcrumb list item; renders as <li>.

PropTypeDefault
children#React.ReactNode

Content to render inside the <li>

className#string

CSS class for the li element

ref#React.Ref<HTMLLIElement>

Ref forwarded to the <li> element

Root (Styled)

Styled breadcrumb navigation container; renders <nav aria-label="breadcrumb">.

PropTypeDefault
separator#React.ReactNode

Optional custom separator element (not actively used, provided for API completeness)

className#string

CSS 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.

PropTypeDefault
className#string

CSS 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.

PropTypeDefault
className#string

CSS class merged with design system styles

ref#React.Ref<HTMLLIElement>

Ref forwarded to the <li> element

Page (Styled)

Styled breadcrumb current page indicator; renders <span role="link" aria-disabled="true" aria-current="page">.

PropTypeDefault
children#React.ReactNode

Page label text

className#string

CSS 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.

PropTypeDefault
children#React.ReactNode

Custom separator icon/element; defaults to <ChevronRight /> if not provided

className#string

CSS class merged with design system styles

Ellipsis (Styled)

Breadcrumb ellipsis indicator for truncated path sections; renders <span> with MoreHorizontal icon and sr-only label.

PropTypeDefault
className#string

CSS class merged with design system styles

Source code

If you didn't find what you need here, read the component implementation .

structyl — Accessible React Component Library