Skip to Content
DocumentationBreadcrumb

Breadcrumb

Displays the path to the current resource using a hierarchy of links.

Examples

Basic

With Icons

Icon Only

With Ellipsis

Custom Separator

API

ComponentDescriptionUsage
BreadcrumbRoot navigation element with aria-labelWraps the entire breadcrumb navigation
BreadcrumbListOrdered list container for breadcrumb itemsGroups all breadcrumb items together
BreadcrumbItemIndividual breadcrumb item containerWraps links, pages, or ellipsis
BreadcrumbLinkClickable link for navigable breadcrumb itemsFor items that link to other pages
BreadcrumbPageNon-interactive current page indicatorFor the current/active page
BreadcrumbSeparatorVisual separator between itemsDisplays chevron or custom separator
BreadcrumbEllipsisEllipsis indicator for collapsed itemsShows when breadcrumb path is too long
PropertyTypeDefaultDescription
classNamestring-Additional CSS classes for the nav element.
…propsReact.ComponentProps<“nav”>-All native nav props are supported.
PropertyTypeDefaultDescription
classNamestring-Additional CSS classes for the ordered list.
…propsReact.ComponentProps<“ol”>-All native ol props are supported.
PropertyTypeDefaultDescription
iconReact.ReactNode-Optional icon displayed to the left of the item content with gap-2 spacing.
classNamestring-Additional CSS classes for the list item.
…propsReact.ComponentProps<“li”>-All native li props are supported.
PropertyTypeDefaultDescription
asChildbooleanfalseUse Radix Slot to merge props onto child element (useful for Next.js Link).
hrefstring-The URL the link points to.
classNamestring-Additional CSS classes for the anchor element.
…propsReact.ComponentProps<“a”>-All native anchor props are supported.
PropertyTypeDefaultDescription
classNamestring-Additional CSS classes for the span element.
…propsReact.ComponentProps<“span”>-All native span props are supported.
PropertyTypeDefaultDescription
childrenReact.ReactNodeChevronRightMd iconCustom separator content. Defaults to a chevron icon if not provided.
classNamestring-Additional CSS classes for the list item.
…propsReact.ComponentProps<“li”>-All native li props are supported.
PropertyTypeDefaultDescription
classNamestring-Additional CSS classes for the span element.
…propsReact.ComponentProps<“span”>-All native span props are supported.
Last updated on