Breadcrumb
Shows the current page's location within a hierarchy.
Installation
Install Breadcrumb from Oros with shadcn CLI 4.13.0.
pnpm dlx shadcn@4.13.0 add @oros/breadcrumbUsage
import {
Breadcrumb,
BreadcrumbList,
BreadcrumbItem,
BreadcrumbLink,
BreadcrumbPage,
BreadcrumbSeparator,
} from "@/components/ui/breadcrumb"Open the Source tab in the preview for a complete working example.
Anatomy
| Export | Responsibility |
|---|---|
| Breadcrumb | The root component that owns the primary structure and state. |
| BreadcrumbList | A composable part of the component anatomy. |
| BreadcrumbItem | Represents one option or repeated child. |
| BreadcrumbLink | A composable part of the component anatomy. |
| BreadcrumbPage | A composable part of the component anatomy. |
| BreadcrumbSeparator | Visually and semantically separates related groups. |
| BreadcrumbEllipsis | A composable part of the component anatomy. |
API Reference
Breadcrumb exports 7 named entries. Component exports accept the props of their underlying HTML element or Base UI component, plus an optional className, unless the source defines a more focused type.
BreadcrumbComponentBreadcrumbListComponentBreadcrumbItemComponentBreadcrumbLinkComponentBreadcrumbPageComponentBreadcrumbSeparatorComponentBreadcrumbEllipsisComponent
Accessibility
- Preserve the native and Base UI keyboard model when composing Breadcrumb; do not replace semantic links or controls with click-only elements.
- Use concise accessible names, expose the current item when applicable, and verify focus order at both mobile and desktop widths.
Source
Breadcrumb uses the standard shadcn API and is distributed through Oros. Installing it adds the component source and required dependencies to your app. The Source tab above shows a complete usage example.