Breadcrumb

Navigation trail with the current page in full ink and earlier levels muted. New levels rise into place, going back fades crumbs away, and a collapsed “…” opens to show hidden levels.

Preview

Installation

npx @lumioui/cli add breadcrumb

Usage

import { BreadcrumbRoot, BreadcrumbItem, BreadcrumbSeparator, BreadcrumbEllipsis, Breadcrumb } from "@/components/ui/breadcrumb/breadcrumb";
<Breadcrumb />

Also exported: BreadcrumbRoot, BreadcrumbItem, BreadcrumbSeparator, BreadcrumbEllipsis.

Examples

Collapsed

A team wiki page five levels deep.

Full trail

A file browser path.

API reference

Breadcrumb

Prop Type Default
items BreadcrumbItemData[]

Data-driven trail — last item renders as the current page.

—
maxItems number

Collapse middle items into a "…" button when the trail exceeds this. Default none.

—
onEllipsisPress (hidden: BreadcrumbItemData[]) => void

Fired when the "…" button is pressed, after the trail expands.

—
haptic "selection" | "light" | false

Haptic on crumb taps. Default "selection".

—
children React.ReactNode

Compound composition: <Breadcrumb.Item> children, separators auto-inserted.

—
className string —

BreadcrumbItem

Prop Type Default
current boolean

Current page — non-interactive, lit in ink.

—
onPress () => void —
accessibilityLabel string —
children React.ReactNode —
className string —

BreadcrumbSeparator

Prop Type Default
className string —

BreadcrumbEllipsis

Prop Type Default
onPress () => void —
className string —