Breadcrumbs

A navigation component showing hierarchy and path in an application.

Anatomy

<Breadcrumbs.Root>
  <Breadcrumbs.List>
    <Breadcrumbs.Item>
      <Breadcrumbs.Link />
    </Breadcrumbs.Item>
    <Breadcrumbs.Separator />
  </Breadcrumbs.List>
</Breadcrumbs.Root>

Usage

import { Breadcrumbs } from '@ivaldi/ui'
<Breadcrumbs.Root>
  <Breadcrumbs.List>
    <Breadcrumbs.Item>
      <Breadcrumbs.Link href="/">Home</Breadcrumbs.Link>
    </Breadcrumbs.Item>
    <Breadcrumbs.Separator>/</Breadcrumbs.Separator>
    <Breadcrumbs.Item>
      <Breadcrumbs.Link href="/products">Products</Breadcrumbs.Link>
    </Breadcrumbs.Item>
    <Breadcrumbs.Separator>/</Breadcrumbs.Separator>
    <Breadcrumbs.Item>
      <Breadcrumbs.Page>Electronics</Breadcrumbs.Page>
    </Breadcrumbs.Item>
  </Breadcrumbs.List>
</Breadcrumbs.Root>

Composed breadcrumb component that handles complex breadcrumb trails. Features automatic truncation and overflow handling for long paths.

PropTypeDefault
breadcrumbs*Breadcrumb[]
maxnumber"5"
linkLinkProp<P>"a"
classNamestring
childrenReactNode
separatorReactNode

Root container component for breadcrumb navigation. Renders a semantic nav element with ARIA breadcrumb role.

PropTypeDefault
classNamestring
childrenReactNode
separatorReactNode

Ellipsis indicator for collapsed breadcrumb items. Used when breadcrumb trail is truncated.

PropTypeDefault
classNamestring
childrenReactNode

Individual breadcrumb item container. Handles layout and styling for each breadcrumb segment.

PropTypeDefault
classNamestring
childrenReactNode

Container for breadcrumb items rendered as an ordered list. Provides consistent spacing and text styling for breadcrumb items.

PropTypeDefault
typeenum
classNamestring
childrenReactNode

Overflow menu component for collapsed breadcrumb items. Displays hidden breadcrumbs in a popover when clicked.

PropTypeDefault
breadcrumbs*Breadcrumb[]
linkLinkProp<P>

Current page indicator in the breadcrumb trail. Renders as a non-interactive span with distinct styling.

PropTypeDefault
classNamestring
childrenReactNode

Visual separator between breadcrumb items. Defaults to a chevron icon but can be customized via children.

PropTypeDefault
classNamestring
childrenReactNode