Breadcrumb

"use client"

import {

Installation#

pnpmnpmyarnbun
pnpm dlx shadcn@latest add @dots/breadcrumb
Copy

Usage#

Copyimport {
  Breadcrumb,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
} from "@/components/ui/breadcrumb"

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

Composition#

Use the following composition to build a Breadcrumb:

CopyBreadcrumb
└── BreadcrumbList
    ├── BreadcrumbItem
    │   └── BreadcrumbLink
    ├── BreadcrumbItem
    │   └── BreadcrumbLink
    └── BreadcrumbItem
        └── BreadcrumbPage

Basic#

A basic breadcrumb with a home link and a components link.

import {
  Breadcrumb,
  BreadcrumbItem,

Custom separator#

Use a custom component as children for <BreadcrumbSeparator /> to create a custom separator.

"use client"

import Link from "next/link"

Dropdown#

You can compose <BreadcrumbItem /> with a <DropdownMenu /> to create a dropdown in the breadcrumb.

"use client"

import Link from "next/link"

Collapsed#

We provide a <BreadcrumbEllipsis /> component to show a collapsed state when the breadcrumb is too long.

"use client"

import Link from "next/link"

Link component#

To use a custom link component from your routing library, you can use the render prop on <BreadcrumbLink />.

"use client"

import Link from "next/link"

API Reference#

Breadcrumb#

The Breadcrumb component is the root navigation element that wraps all breadcrumb components.

BreadcrumbList#

The BreadcrumbList component displays the ordered list of breadcrumb items.

BreadcrumbItem#

The BreadcrumbItem component wraps individual breadcrumb items.

BreadcrumbLink#

The BreadcrumbLink component displays a clickable link in the breadcrumb.

BreadcrumbPage#

The BreadcrumbPage component displays the current page in the breadcrumb (non-clickable).

BreadcrumbEllipsis#

The BreadcrumbEllipsis component displays an ellipsis indicator for collapsed breadcrumb items.

For more information, see the React Aria documentation.