Prepared Docs

Prepared Docs

⌘K

    Loading navigation…

User

  1. Components
  2. Breadcrumb
  3. API and Development

Breadcrumb

API and Development

View Source
Submit Issue

The breadcrumb primitives compose a navigation landmark showing the path from the site root to the current location. Use Breadcrumb as the <nav> wrapper (it renders the <ol> internally), BreadcrumbItem for each list row, BreadcrumbLink or asChild for links, BreadcrumbPage for the current page (non-link), BreadcrumbLabel for non-link text when a segment is not the current page, BreadcrumbSeparator for chevrons, and BreadcrumbEllipsis for collapsed middle segments.

Props

No extracted props

This component does not declare package-specific props in the generated API. It may still accept standard HTML and React attributes for its underlying element (for example className, id, and ARIA attributes). Props whose types come only from dependencies are omitted from this table.

Storybook

Interactive examples and edge cases for this component are in Storybook.

Basic
Custom Separator
With Ellipsis
With Non Navigable Segment
Single Back Link
All Variants

Basic

Custom separator

With ellipsis

With non-navigable segment

Single back link

Previous

Breadcrumb / Usage

Next

Breadcrumb / Accessibility

On this page

Props
Storybook
Basic
Custom separator
With ellipsis
With non-navigable segment
Single back link