Skip to main content

Starwind UI v3.0 beta is now available! Read the migration guide

Breadcrumb

Installation

Framework Availability

Astro Available React Available

Breadcrumb 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.

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.

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.

Inherits a attributes.

Contains the following additional props:

Prop Type Default Toggle details
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.ts file

v1.1.1

  • Add named slot “icon” to BreadcrumbEllipsis to enable easy icon swapping, and a default slot for the sr-only label

v1.1.0

  • Add a data-slot attribute to all components to enable global styling updates

v1.0.0

  • Initial component release with starwind v1.5.0