Хлебные крошки

import Link from "next/link"

import {

Хлебные крошки показывают место текущей страницы в иерархии сайта и дают ссылку на каждый уровень выше. Это не примитив Base UI, а просто семантичная разметка (nav + <ol>), которая использует useRender из Base UI для композиции через проп render; оформление — по рецепту необрутализма: ссылки заголовочным шрифтом, текущая страница — жирным основным цветом.

Когда это пригодится:

• Документация и базы знаний — Документация / Компоненты / Хлебные крошки: читатель поднимается на уровень выше, не разыскивая нужный пункт в боковом меню.
• Дерево категорий в магазине — Главная / Одежда / Куртки выводит с глубоко вложенной страницы товара одним щелчком.
• Панели управления и файловые менеджеры — вложенные проекты, настройки и пути к папкам, когда по одному URL не сориентироваться.

Установка#

pnpmnpmyarnbun
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
Скопировать

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,

Пользовательский разделитель#

Используйте собственный компонент как children для <BreadcrumbSeparator />, чтобы создать пользовательский разделитель.

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 {

Компонент ссылки#

Чтобы использовать собственный компонент ссылки из вашей библиотеки маршрутизации, примените проп render на <BreadcrumbLink />.

import Link from "next/link"

import {

RTL#

Чтобы включить поддержку RTL в Neobrutalism, см. руководство по настройке RTL.

"use client"

import Link from "next/link"

Доступность#

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

Справочник API#

Breadcrumb#

Компонент Breadcrumb — корневой навигационный элемент, который оборачивает все компоненты хлебных крошек.

BreadcrumbList#

Компонент BreadcrumbList показывает упорядоченный список элементов хлебных крошек.

BreadcrumbItem#

Компонент BreadcrumbItem оборачивает отдельные элементы хлебных крошек.

BreadcrumbLink#

Компонент BreadcrumbLink показывает кликабельную ссылку в хлебных крошках.

BreadcrumbPage#

Компонент BreadcrumbPage показывает текущую страницу в хлебных крошках (без возможности клика).

BreadcrumbSeparator#

Компонент BreadcrumbSeparator показывает разделитель между элементами хлебных крошек. Вы можете передать собственные children, чтобы заменить иконку разделителя по умолчанию.

BreadcrumbEllipsis#

Компонент BreadcrumbEllipsis показывает многоточие для свёрнутых элементов хлебных крошек.