Breadcrumb - Shark UI

Sections

Components

Utilities

Forms

Hooks

useIsMobile

Copy Markdown

Shows user location within a hierarchy.

PreviewCode

Installation#

CLIManual

pnpmbunnpmyarn

pnpm dlx shadcn@latest add @shark/breadcrumb

Anatomy#

Breadcrumb
└── BreadcrumbList
    └── BreadcrumbItem
        ├── BreadcrumbLink
        ├── BreadcrumbPage
        ├── BreadcrumbSeparator
        └── BreadcrumbEllipsis

Usage#

import {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from "@/components/ui/breadcrumb";

<Breadcrumb>
  <BreadcrumbList>
    <BreadcrumbItem>
      <BreadcrumbLink href="/">Home</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbLink href="/components">Components</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
    </BreadcrumbItem>
  </BreadcrumbList>
</Breadcrumb>

Examples#

With custom separator#

PreviewCode

With links#

PreviewCode

Collapsed#

PreviewCode

API Reference#

Navigation landmark for the breadcrumb trail.

Prop	Type	Default
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbList#

Ordered list of breadcrumb segments.

Prop	Type	Default
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbItem#

Wraps a single breadcrumb link or page.

Prop	Type	Default
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbLink#

Link to a parent page in the hierarchy.

Prop	Type	Default
`href`	`string`	`-`
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbPage#

Current page. Not a link; marked with aria-current="page" for accessibility.

Prop	Type	Default
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbSeparator#

Visual separator between segments.

Prop	Type	Default
`children`	`React.ReactNode`	`ChevronRight`
`className`	`string`	`-`
`asChild`	`boolean`	`false`

BreadcrumbEllipsis#

Shows when middle segments are collapsed.

Prop	Type	Default
`className`	`string`	`-`
`asChild`	`boolean`	`false`

[

Bottom Navigation ](/docs/components/bottom-navigation)[

Button Group ](/docs/components/button-group)

On This Page

Installation Anatomy Usage Examples With custom separator With links Collapsed With menu API Reference Breadcrumb BreadcrumbList BreadcrumbItem BreadcrumbLink BreadcrumbPage BreadcrumbSeparator BreadcrumbEllipsis