Breadcrumb
Show a resource hierarchy and mark its current page.
Anatomy#
Usage#
Use Breadcrumb to show where a resource sits in a navigation hierarchy. Keep ancestor destinations as links and render the current page as a non-link item. For in-page section switching, use Tabs instead.
Items and current page#
Use href for navigable ancestors, with target, rel, and onClick as needed. The last item is
the current page by default; set active on another item to mark it instead (the first active item
wins). The current page renders as a span with aria-current="page". Disabled ancestors render
without href or onClick and expose aria-disabled="true". disabled has no effect on the
current page.
separator accepts an icon name, an element, or a component, and defaults to icon-chevron-right.
It is hidden from assistive technology. wrap (default true) lets a long trail break onto extra
lines in a narrow column; with wrap={false}, the trail stays on one line and clips any overflow.
The <nav> is labeled breadcrumb by default. Set aria-label, or translations={{ label }}, to
change it.
Pass itemRender to replace each item’s link or page element, for example with a router link. The
component receives { item, index, active, disabled } and is responsible for aria-current and
disabled handling.
Examples#
Trail to the current page#
Link ancestors and leave the last item as the current page.
Locked ancestor with a custom separator#
Keep a disabled private workspace in the trail. Replace the chevron with a slash.
Long trail in a narrow column#
Leave wrap on so the trail can break across lines. Set wrap={false} to keep every item on one line.
Custom item rendering#
Use itemRender to render each item yourself for router links or custom chip styling. It receives
item, index, active, and disabled.
API Reference#
Attributes#
data-disableddata-currentProps#
Props for the Breadcrumb component. Renders a <nav> element by default.