Beta

Search Documentation

Search through documentation pages

Components

Breadcrumb

Displays a navigation trail to help users understand their location within a hierarchy.

Preview

'use client';

import {
  Breadcrumb,
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from '@/registry/san-francisco/ui/breadcrumb';

export default function BreadcrumbDemo() {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href="/">Home</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink href="/docs">Docs</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  );
}

Installation

bun
bunx shadcn@latest add @sft-ui/breadcrumb

With Ellipsis

'use client';

import {
  Breadcrumb,
  BreadcrumbEllipsis,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbList,
  BreadcrumbPage,
  BreadcrumbSeparator,
} from '@/registry/san-francisco/ui/breadcrumb';

export default function BreadcrumbDemoEllipsis() {
  return (
    <Breadcrumb>
      <BreadcrumbList>
        <BreadcrumbItem>
          <BreadcrumbLink href="/">Home</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbEllipsis />
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbLink href="/docs/components">Components</BreadcrumbLink>
        </BreadcrumbItem>
        <BreadcrumbSeparator />
        <BreadcrumbItem>
          <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
        </BreadcrumbItem>
      </BreadcrumbList>
    </Breadcrumb>
  );
}

API Reference

The root <nav> element with aria-label="breadcrumb".

An <ol> that holds the breadcrumb items and separators.

A <li> wrapper for each breadcrumb entry.

A navigation link within a breadcrumb item. Renders as <a> by default.

PropTypeDefaultDescription
renderReact.ReactElementOverride the rendered element (e.g. Next.js Link).
classNamestringAdditional CSS classes to apply.

Marks the current page in the breadcrumb trail. Renders as a <span> with aria-current="page".

A visual separator between breadcrumb items. Defaults to a chevron icon — pass children to customize.

An indicator for collapsed breadcrumb items, typically used with a dropdown.