パンくずリスト

サイト階層におけるそのページの位置（ドキュメント、ストアのカテゴリ、ダッシュボードへのリンク経路）を、太字のネオブルータリズム体で表示します。

import Link from "next/link"

import {

Breadcrumb は、現在ページがサイト階層のどこにあるかを示し、上位の各レベルへのリンクを提供します。Base UI プリミティブではなく、セマンティック HTML（nav + <ol>）で、render prop の合成に Base UI の useRender を使います。ネオブルータリストのレシピに沿ったスタイルで、見出しフォントのリンクと、現在ページは太字の前景色テキストです。

次のような場面で使います：

ドキュメントとナレッジベース — Docs / Components / Breadcrumb。サイドバーを探さずに一段上へ戻れます。
EC のカテゴリツリー — Home / Clothing / Jackets で、深い商品ページからワンクリックで抜けられます。
ダッシュボードとファイルブラウザ — 入れ子のプロジェクト、設定、フォルダパスなど、URL だけでは位置が分かりにくい場面。

インストール


pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.json
npx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.json
yarn dlx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.json
bunx --bun shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.json

以下のコードをコピーしてプロジェクトに貼り付けます。

components/ui/breadcrumb.tsx

import * as React from "react"
import { ChevronRightIcon, MoreHorizontalIcon } from "lucide-react"
import { Slot } from "radix-ui"

import { cn } from "@/lib/utils"

function Breadcrumb({ className, ...props }: React.ComponentProps<"nav">) {
  return (
    <nav
      aria-label="breadcrumb"
      data-slot="breadcrumb"
      className={cn(className)}
      {...props}
    />
  )
}

function BreadcrumbList({ className, ...props }: React.ComponentProps<"ol">) {
  return (
    <ol
      data-slot="breadcrumb-list"
      className={cn(
        "flex flex-wrap items-center gap-1.5 text-sm wrap-break-word text-muted-foreground",
        className
      )}
      {...props}
    />
  )
}

function BreadcrumbItem({ className, ...props }: React.ComponentProps<"li">) {
  return (
    <li
      data-slot="breadcrumb-item"
      className={cn("inline-flex items-center gap-1", className)}
      {...props}
    />
  )
}

function BreadcrumbLink({
  asChild,
  className,
  ...props
}: React.ComponentProps<"a"> & {
  asChild?: boolean
}) {
  const Comp = asChild ? Slot.Root : "a"

  return (
    <Comp
      data-slot="breadcrumb-link"
      className={cn("font-head transition-colors hover:text-foreground", className)}
      {...props}
    />
  )
}

function BreadcrumbPage({ className, ...props }: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="breadcrumb-page"
      role="link"
      aria-disabled="true"
      aria-current="page"
      className={cn("font-medium text-foreground", className)}
      {...props}
    />
  )
}

function BreadcrumbSeparator({
  children,
  className,
  ...props
}: React.ComponentProps<"li">) {
  return (
    <li
      data-slot="breadcrumb-separator"
      role="presentation"
      aria-hidden="true"
      className={cn("[&>svg]:size-3.5", className)}
      {...props}
    >
      {children ?? <ChevronRightIcon className="cn-rtl-flip" />}
    </li>
  )
}

function BreadcrumbEllipsis({
  className,
  ...props
}: React.ComponentProps<"span">) {
  return (
    <span
      data-slot="breadcrumb-ellipsis"
      role="presentation"
      aria-hidden="true"
      className={cn(
        "flex size-5 items-center justify-center [&>svg]:size-4",
        className
      )}
      {...props}
    >
      <MoreHorizontalIcon />
      <span className="sr-only">More</span>
    </span>
  )
}

export {
  Breadcrumb,
  BreadcrumbList,
  BreadcrumbItem,
  BreadcrumbLink,
  BreadcrumbPage,
  BreadcrumbSeparator,
  BreadcrumbEllipsis,
}

プロジェクトの構成に合わせてインポートパスを更新します。

使い方

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

<Breadcrumb>
  <BreadcrumbList>
    <BreadcrumbItem>
      <BreadcrumbLink render={<a href="/" />}>Home</BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbLink render={<a href="/components" />}>
        Components
      </BreadcrumbLink>
    </BreadcrumbItem>
    <BreadcrumbSeparator />
    <BreadcrumbItem>
      <BreadcrumbPage>Breadcrumb</BreadcrumbPage>
    </BreadcrumbItem>
  </BreadcrumbList>
</Breadcrumb>

コンポジション

Breadcrumb を構築するには、次のコンポジションを使用します：

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

使用例

基本

ホームへのリンクとコンポーネントへのリンクを備えた基本的なパンくずリストです。

import {
  Breadcrumb,
  BreadcrumbItem,

カスタムセパレーター

<BreadcrumbSeparator /> の children にカスタムコンポーネントを渡して、カスタムセパレーターを作成します。

import Link from "next/link"
import { DotIcon } from "lucide-react"

ドロップダウン

<BreadcrumbItem /> と <DropdownMenu /> を組み合わせて、パンくずリスト内にドロップダウンを作成できます。

import Link from "next/link"
import { ChevronDownIcon, DotIcon } from "lucide-react"

折りたたみ

パンくずリストが長すぎる場合に折りたたまれた状態を表示するための、<BreadcrumbEllipsis /> コンポーネントを用意しています。

import Link from "next/link"

import {

リンクコンポーネント

ルーティングライブラリのカスタムリンクコンポーネントを使うには、<BreadcrumbLink /> の render プロパティを使用します。

import Link from "next/link"

import {

RTL

Neobrutalism で RTL を有効にする方法は、RTL 設定ガイドをご覧ください。

"use client"

import Link from "next/link"

アクセシビリティ

Breadcrumb は WAI-ARIA Breadcrumb パターンに従います。Breadcrumb は順序付きリストを包む <nav aria-label="breadcrumb"> ランドマークを描画するため、スクリーンリーダーはパンくずナビとして認識し、直接ジャンプできます。BreadcrumbPage は aria-current="page" で現在位置を示し、区切りは aria-hidden なので読み上げられません。各項目は通常のリンクで、標準の Tab と Enter の挙動があり、追加のキーボード配線は不要です。

APIリファレンス

Breadcrumb コンポーネントは、すべてのパンくずリストコンポーネントを包むルートのナビゲーション要素です。

Prop	Type	Default
`className`	`string`	-

BreadcrumbList

BreadcrumbList コンポーネントは、パンくずリストの項目を順序付きリストとして表示します。

Prop	Type	Default
`className`	`string`	-

BreadcrumbItem

BreadcrumbItem コンポーネントは、パンくずリストの各項目を包みます。

Prop	Type	Default
`className`	`string`	-

BreadcrumbLink

BreadcrumbLink コンポーネントは、パンくずリスト内にクリック可能なリンクを表示します。

Prop	Type	Default
`className`	`string`	-

BreadcrumbPage

BreadcrumbPage コンポーネントは、パンくずリスト内に現在のページを表示します（クリック不可）。

Prop	Type	Default
`className`	`string`	-

BreadcrumbSeparator

BreadcrumbSeparator コンポーネントは、パンくずリストの項目間にセパレーターを表示します。カスタムの children を渡すことで、デフォルトのセパレーターアイコンを上書きできます。

Prop	Type	Default
`children`	`React.ReactNode`	-
`className`	`string`	-

BreadcrumbEllipsis

BreadcrumbEllipsis コンポーネントは、折りたたまれたパンくずリストの項目を示す省略記号インジケーターを表示します。

Prop	Type	Default
`className`	`string`	-