TrademarkTrademark
Docs
Ctrl k
Search docs...
Components

Breadcrumbs

Updated: October 10, 2026
View on GitHub
Soon
Not released yet. This is on main and is not in any published version yet. It will not install today.

Breadcrumbs renders the trail from the site's root to the current page as a nav landmark named "Breadcrumb", holding an ordered list. The last item is the current page and carries aria-current="page". The separators are drawn but hidden from screen readers, which announce the list and its length instead.

Each crumb with an href is a SmartLink, so an internal path goes through the app's Link adapter: with LayoutProvider from @once-ui-system/core/next it is a client-side navigation. A crumb without one is plain text, for a section that has no page of its own. The current page links only if you give it an href.

Long trails

maxItems collapses a longer trail to the first crumb, a "more" button and the last maxItems - 1 crumbs. The button expands the whole trail in place and moves focus to the first crumb it revealed. The minimum is 2: the root and the current page.

Separator

The default separator is a small chevron. Pass any node as separator; it is hidden from screen readers wherever it is drawn.

The landmark is named "Breadcrumb". Pass aria-label only to translate it. Breadcrumbs is a Row and takes every Flex prop, such as marginBottom or a different textVariant.

API reference

Type
Default
itemsrequired
The trail, from the root to the current page.
BreadcrumbItem[]—
separator
Drawn between crumbs, hidden from screen readers.
ReactNode<Icon name="chevronRight" size="xs" />
maxItems
Collapse a longer trail to the first crumb, a more button and the last maxItems - 1.
number—
aria-label
string—
…and every FlexProps propinherited—
Type
Default
labelrequired
The crumb's text.
React.ReactNode—
href
Where the crumb links. Without it the crumb is plain text.
string—
prefixIcon
A leading icon.
IconName—
Edit this page on GitHub
TrademarkTrademark
Built with curiosity by Lorant One and the Design Engineers Club