Навігаційний шлях

Показує місце сторінки в ієрархії сайту — ланцюжки посилань для документів, категорій магазину та інформаційних панелей — жирним шрифтом у стилі необруталізму.

import Link from "next/link"

import {

Breadcrumb показує місце поточної сторінки в ієрархії сайту й дає посилання на кожен рівень вище. Це не примітив Base UI — лише семантичний HTML (nav + <ol>) із Base UI useRender для композиції через проп render — оформлений за рецептом необруталізму: посилання шрифтом заголовка, поточна сторінка масивним foreground-текстом.

Коли це стане в пригоді:

Документація та бази знань — Docs / Components / Breadcrumb; читач піднімається на рівень вище, не шукаючи в бічній панелі.
Дерева категорій e-commerce — 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

Приклади

Базовий

Базовий breadcrumb із посиланням на головну та посиланням на компоненти.

import {
  Breadcrumb,
  BreadcrumbItem,

Власний роздільник

Використайте власний компонент як children для <BreadcrumbSeparator />, щоб створити власний роздільник.

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

Випадне меню

Ви можете скомпонувати <BreadcrumbItem /> з <DropdownMenu />, щоб створити випадне меню в breadcrumb.

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

Згорнутий

Ми надаємо компонент <BreadcrumbEllipsis />, щоб показати згорнутий стан, коли breadcrumb занадто довгий.

import Link from "next/link"

import {

Компонент посилання

Щоб використати власний компонент посилання з вашої бібліотеки маршрутизації, застосуйте проп render на <BreadcrumbLink />.

import Link from "next/link"

import {

RTL

Щоб увімкнути підтримку RTL у Neobrutalism, перегляньте посібник з налаштування RTL.

"use client"

import Link from "next/link"

Доступність

Breadcrumb відповідає патерну WAI-ARIA Breadcrumb: Breadcrumb рендерить орієнтир <nav aria-label="breadcrumb"> з упорядкованим списком, тож програми зчитування з екрана оголошують його як навігацію-breadcrumb і користувачі можуть перейти до нього безпосередньо. BreadcrumbPage має aria-current="page" для поточної локації, а роздільники — aria-hidden, щоб їх не читали вголос. Елементи — звичайні посилання: стандартна поведінка Tab і Enter, без додаткової клавіатурної обв’язки.

Довідник API

Компонент Breadcrumb — це кореневий елемент навігації, який обгортає всі компоненти breadcrumb.

Prop	Type	Default
`className`	`string`	-

BreadcrumbList

Компонент BreadcrumbList показує впорядкований список елементів breadcrumb.

Prop	Type	Default
`className`	`string`	-

BreadcrumbItem

Компонент BreadcrumbItem обгортає окремі елементи breadcrumb.

Prop	Type	Default
`className`	`string`	-

BreadcrumbLink

Компонент BreadcrumbLink показує клікабельне посилання в breadcrumb.

Prop	Type	Default
`className`	`string`	-

BreadcrumbPage

Компонент BreadcrumbPage показує поточну сторінку в breadcrumb (без можливості кліку).

Prop	Type	Default
`className`	`string`	-

BreadcrumbSeparator

Компонент BreadcrumbSeparator показує роздільник між елементами breadcrumb. Ви можете передати власні children, щоб замінити типову іконку роздільника.

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

BreadcrumbEllipsis

Компонент BreadcrumbEllipsis показує індикатор трьох крапок для згорнутих елементів breadcrumb.

Prop	Type	Default
`className`	`string`	-