Breadcrumb
---import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis } from "@/components/starwind/breadcrumb";---
<Breadcrumb> <BreadcrumbList> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbEllipsis /> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbLink href="/products/categories">Categories</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbPage>Electronics</BreadcrumbPage> </BreadcrumbItem> </BreadcrumbList></Breadcrumb>import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis } from "@/components/starwind/breadcrumb";
export function Example() { return ( <Breadcrumb> <BreadcrumbList> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbEllipsis /> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbLink href="/products/categories">Categories</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbPage>Electronics</BreadcrumbPage> </BreadcrumbItem> </BreadcrumbList> </Breadcrumb> );}Installation
pnpx starwind@latest add breadcrumbnpx starwind@latest add breadcrumbyarn dlx starwind@latest add breadcrumbFramework Availability
Astro Available React AvailableBreadcrumb is available for Astro and React.
Usage
Separator
The BreadcrumbSeparator component is used to visually separate items in the breadcrumb trail. By default, it displays a chevron-right icon, but you can provide your own custom separator.
---import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator } from "@/components/starwind/breadcrumb";---
<Breadcrumb> <BreadcrumbList> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator>/</BreadcrumbSeparator> <BreadcrumbItem> <BreadcrumbLink href="/components">Components</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator>/</BreadcrumbSeparator> <BreadcrumbItem> <BreadcrumbPage>Breadcrumb</BreadcrumbPage> </BreadcrumbItem> </BreadcrumbList></Breadcrumb>Interactive Ellipsis
Use a native disclosure around BreadcrumbEllipsis to reveal navigable hidden path segments. The summary is keyboard-focusable, while every revealed segment remains a normal link.
---import { Breadcrumb, BreadcrumbItem, BreadcrumbLink, BreadcrumbList, BreadcrumbPage, BreadcrumbSeparator, BreadcrumbEllipsis } from "@/components/starwind/breadcrumb";---
<Breadcrumb> <BreadcrumbList> <BreadcrumbItem> <BreadcrumbLink href="/">Home</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <details class="group relative"> <summary class="hover:text-foreground focus-visible:ring-outline/50 cursor-pointer list-none rounded-sm outline-none focus-visible:ring-3 [&::-webkit-details-marker]:hidden" aria-label="Show hidden breadcrumb paths" > <BreadcrumbEllipsis /> </summary> <ul class="bg-popover text-popover-foreground absolute top-full left-0 z-50 mt-1 min-w-40 rounded-md border p-1 shadow-md" > <li> <BreadcrumbLink class="hover:bg-muted block rounded-sm px-2 py-1.5" href="/docs/"> Docs </BreadcrumbLink> </li> <li> <BreadcrumbLink class="hover:bg-muted block rounded-sm px-2 py-1.5" href="/docs/components/" > Components </BreadcrumbLink> </li> <li> <BreadcrumbLink class="hover:bg-muted block rounded-sm px-2 py-1.5" href="/docs/components/breadcrumb/" > Breadcrumb </BreadcrumbLink> </li> </ul> </details> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbLink href="#usage">Usage</BreadcrumbLink> </BreadcrumbItem> <BreadcrumbSeparator /> <BreadcrumbItem> <BreadcrumbPage>Interactive Ellipsis</BreadcrumbPage> </BreadcrumbItem> </BreadcrumbList></Breadcrumb>Runtime example adjustment
The legacy polymorphic dropdown-item composition was replaced with a native disclosure. Its summary owns the accessible name and keyboard interaction, while every hidden path segment remains a real BreadcrumbLink.
API Reference
Styled Component API
These props are added or materially changed by the installed Astro styled component. Standard HTML attributes remain available through the inherited interfaces noted below. Follow the Primitive and Runtime links for lower-level behavior props.
Breadcrumb Link
Inherits a attributes.
Contains the following additional props:
asChild boolean false
- Description
- Merges the component behavior and props into its child element.
- Classification
- Wrapper prop
Changelog
v1.2.0
- Added contract-generated Astro and React implementations while preserving the component’s existing public API and styling.
v1.1.3
- Refactor tailwind variants functions into separate
variants.tsfile
v1.1.1
- Add named slot “icon” to
BreadcrumbEllipsisto enable easy icon swapping, and a default slot for thesr-onlylabel
v1.1.0
- Add a
data-slotattribute to all components to enable global styling updates
v1.0.0
- Initial component release with starwind v1.5.0