Breadcrumb
Use Breadcrumb to show the current page's place in a hierarchy and provide links to parent pages.
Preview
A path with omitted levels
Combine Components and Navigation links, an ellipsis, and the current Breadcrumb page.
Installation
New to this Registry? Complete the base setup before continuing.
npx shadcn@latest add @neumorphism-ui/breadcrumbInstall the shared base once, then add components and their dependencies with the CLI.
Usage
Compose BreadcrumbList with BreadcrumbItem. Use BreadcrumbLink for ancestors and BreadcrumbPage for the current location; place each separator with the following item.
import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator } from "@/components/ui/breadcrumb";
export default function Example() {
return (
<Breadcrumb>
<BreadcrumbList>
<BreadcrumbItem><BreadcrumbLink href="/">Home</BreadcrumbLink></BreadcrumbItem>
<BreadcrumbItem>
<BreadcrumbSeparator />
<BreadcrumbPage>Settings</BreadcrumbPage>
</BreadcrumbItem>
</BreadcrumbList>
</Breadcrumb>
);
}API Reference
Preserves the native semantics of nav and ol while composing links, the current page, separators, and collapsed paths. The current page is automatically marked with aria-current=page.
| Component | Prop | Type | Default | Description |
|---|---|---|---|---|
Breadcrumb | aria-label | string | "breadcrumb" | The accessible name of the path navigation region. |
BreadcrumbLink | hrefrequired | string | — | The actual URL of a parent location. |
BreadcrumbPage | childrenrequired | React.ReactNode | — | The current page name, marked with aria-current=page. |
BreadcrumbSeparator | children | React.ReactNode | "/" | A visual separator hidden from assistive technology. |
Accessibility
- 01
Breadcrumb is a nav labeled with aria-label=breadcrumb, and its path is an ordered ol.
- 02
Use BreadcrumbPage instead of a link for the final item so it exposes aria-current=page.
- 03
Separator and Ellipsis are decorative and hidden from assistive technology.