Breadcrumb

PreviousNext

Navigation component showing the current page's location within a hierarchical structure with clickable parent links.

Hierarchical navigation showing the current page location, with clickable parent links and support for collapsed paths.

Basic Usage

Custom Separators

Customize the separator between breadcrumb items with different icons or characters.

With Icons

Add icons to breadcrumb items for enhanced visual clarity and recognition.

Collapsed Navigation

For long navigation paths, use a dropdown menu with BreadcrumbEllipsis to show collapsed intermediate levels.

API Reference

The root container for the breadcrumb navigation.

PropTypeDefaultDescription
classNamestring-Additional CSS classes

An ordered list containing breadcrumb items and separators.

PropTypeDefaultDescription
classNamestring-Additional CSS classes

A list item wrapper for breadcrumb links or pages.

PropTypeDefaultDescription
classNamestring-Additional CSS classes

A clickable link to a parent page in the navigation hierarchy.

PropTypeDefaultDescription
hrefstring-Link destination URL
asChildbooleanfalseRender as a child component (e.g., Next.js Link)
classNamestring-Additional CSS classes

Represents the current page (non-clickable) in the breadcrumb trail.

PropTypeDefaultDescription
classNamestring-Additional CSS classes

A separator between breadcrumb items.

PropTypeDefaultDescription
childrenReactNode<ChevronRight />Custom separator icon or content
classNamestring-Additional CSS classes

An ellipsis indicator for collapsed breadcrumb items, typically used with a dropdown menu.

PropTypeDefaultDescription
classNamestring-Additional CSS classes