Breadcrumb Item
- Stable
- WCAG 2.2 evidence
- RTL
One level of a Breadcrumb trail; use it only inside Breadcrumb. Built on React Aria
Breadcrumb (an <li>) and Link: every level is a link in the tab order, and the last level is the current page, exposed
with aria-current="page" and not a link to itself (WCAG 1.3.1, 4.1.2). type="home" shows the house icon with a
visually hidden name; type="collapsed" is an ellipsis button that opens the hidden levels in a Menu (Enter, Space or the
arrow keys open it, Escape closes it). The separator after each level is decorative and mirrors in right-to-left layouts. Keyboard focus shows the ring (2.4.7). The items are 22 px high and keep the 24 px target spacing through the separators
(2.5.8). Consumer duties: level names that match the page titles.
import { BreadcrumbItem } from "@nexera-ui/react";- 2
- examples
- 17
- props
- 0
- live controls
- 1
- platform
- 9
- WCAG criteria
- 2
- blocks use it
Try every prop. Copy the code.
Change the props and the code updates. Check light and dark, LTR and RTL, and phone width.
import { BreadcrumbItem } from "@nexera-ui/react";
<BreadcrumbItem />Examples 1
The same examples as Storybook, rendered live. Open Code to copy one.
Types
Figma Type: Home (icon with a hidden name), Collapsed (menu of hidden levels), Link, and the current page.
import { Breadcrumb, BreadcrumbItem } from "@nexera-ui/react";
export function Types() {
return (
<Breadcrumb aria-label="Breadcrumb (types)">
<BreadcrumbItem type="home" label="Home" href="#home" />
<BreadcrumbItem
type="collapsed"
items={[
{ label: "People", href: "#people" },
{ label: "Engineering", href: "#engineering" },
]}
/>
<BreadcrumbItem label="Platform" href="#platform" />
<BreadcrumbItem label="Ayesha Khan" href="#ayesha" />
</Breadcrumb>
);
}
Props 17
17 props shown
typeNexera"link" | "home" | "collapsed"Figma Type.
labelNexeraVisibleContentVisible label: the page title of the level ("People"). It names the link and wraps instead of truncating. The last item of the trail is the current page. Accessible name of the icon-only link ("Home"), rendered as visually hidden text. Translate it. Accessible name of the ellipsis button, which opens the menu of hidden levels. Translate it.
itemsNexerareadonly BreadcrumbCollapsedLevel[]The hidden levels, in order. Breadcrumb fills this itself when it collapses the trail through maxVisible.
onActionNexera(key: Key) => voidCalled with the level's id when a hidden level without href is chosen in the menu.
classNameNexerastringExtra classes for the list item (<li>), merged last so they win over the defaults.
styleNexeraCSSPropertiesInline style of the list item.
idReact AriaKeyA unique id for the breadcrumb, which will be passed to onAction when the breadcrumb is
pressed.
aria-labelReact AriastringDefines a string value that labels the current element.
aria-labelledbyReact AriastringIdentifies the element (or elements) that labels the current element.
aria-describedbyReact AriastringIdentifies the element (or elements) that describes the object.
hrefReact AriastringA URL to link to. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#href).
hrefLangReact AriastringHints at the human language of the linked URL. See[MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#hreflang).
targetReact AriaHTMLAttributeAnchorTargetThe target window for the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target).
relReact AriastringThe relationship between the linked resource and the current page. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel).
downloadReact Ariastring | booleanCauses the browser to download the linked URL. A string may be provided to suggest a file name. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#download).
pingReact AriastringA space-separated list of URLs to ping when the link is followed. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#ping).
referrerPolicyReact Aria"" | "no-referrer" | "no-referrer-when-downgrade" | "origin" | "origin-when-cross-origin" | "same-origin" | "strict-origin" | "strict-origin-when-cross-origin" | "unsafe-url"How much of the referrer to send when following the link. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#referrerpolicy).
* Required. React Aria props shown are the ones most apps use; the component accepts the rest of its React Aria props too.
Accessible by default.
Built on React Aria, and covered by the WCAG 2.2 evidence generated on every build.
WCAG 2.2 evidence
6 direct · 3 supporting- 1.1.1Non-text ContentLevel A · tested directly
- 1.3.1Info and RelationshipsLevel A · tested directly
- 1.4.1Use of ColorLevel A · supporting test
- 1.4.10ReflowLevel AA · supporting test
- 1.4.12Text SpacingLevel AA · supporting test
- 2.1.1KeyboardLevel A · tested directly
- 2.4.4Link Purpose (In Context)Level A · tested directly
- 2.4.7Focus VisibleLevel AA · tested directly
- 4.1.2Name, Role, ValueLevel A · tested directly
Fits any width.
Nexera components respond to the space they are given. Drag the corner of the frame, or pick a width.
Styling hooks
Pass className to add Tailwind classes (merged last). State is exposed as data attributes, so you can style it with variants like data-pressed:.
data-currentdata-disableddata-hovered
<BreadcrumbItem className="data-current:opacity-90 shadow-sm" />Used in blocks
Related components
- BreadcrumbShows where the current page sits in the hierarchy and links back to each level.
- CursorPagerA previous and next pair for data without stable page numbers, such as an activity log or a cursor API.
- FABThe main action of a mobile screen: a floating button with a `nav/active-bg` fill and a large shadow.
- FeedStatusThe status line at the bottom of an infinite feed or a lazy list: "Loading more", "You have reached the end" or "Could not load more" with a retry action.
- JumpToPageA small "Go to page [48] of 120" control for long paged lists.
- NavigationBarThe bottom bar of a mobile layout: a named `nav` landmark with a list of three to five `NavItem`s.
- NavItemOne destination or action of a `NavigationBar`.
- PageButtonOne page number of a `Pagination` or `TableFooter`.