پرش به محتوا

مسیر راهنما

نشان می‌دهد که صفحه در سلسله‌مراتب سایت کجا قرار دارد — مسیرهای پیوند برای اسناد، دسته‌بندی‌های فروشگاه و داشبوردها — با قلم نیوبروتالیست پررنگ.

import Link from "next/link"

import {

breadcrumb موقعیت صفحهٔ فعلی را در سلسله‌مراتب سایت نشان می‌دهد و هر سطح بالاتر را لینک می‌کند. primitiveِ Base UI نیست — فقط HTML معنایی (nav + <ol>) با useRender در Base UI برای ترکیب propِ render — با دستور پخت نئوبروتالیستی: لینک‌ها با فونت heading و صفحهٔ فعلی با تایپ پررنگ foreground.

برای این موارد از آن استفاده کنید:

  • اسناد و پایگاه دانش — Docs / Components / Breadcrumb؛ خواننده یک سطح عقب می‌رود بدون گشتن در sidebar.
  • درخت دستهٔ فروشگاه — 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 را متناسب با ساختار پروژهٔ خود به‌روزرسانی کنید.

استفاده

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 پایه با یک پیوند home و یک پیوند components.

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 یک landmark به‌صورت <nav aria-label="breadcrumb"> رندر می‌کند که ordered list را می‌پیچد تا صفحه‌خوان آن را به‌عنوان ناوبری breadcrumb اعلام کند و کاربر مستقیم به آن بپرد. BreadcrumbPage با aria-current="page" مکان فعلی را علامت می‌زند و جداکننده‌ها aria-hidden هستند تا بلند خوانده نشوند. آیتم‌ها لینک ساده‌اند — رفتار استاندارد Tab و Enter، بدون سیم‌کشی صفحه‌کلید اضافه.

مرجع API

کامپوننت Breadcrumb عنصر ناوبری ریشه‌ای است که همهٔ کامپوننت‌های breadcrumb را در بر می‌گیرد.

PropTypeDefault
classNamestring-

کامپوننت BreadcrumbList فهرست مرتب‌شدهٔ آیتم‌های breadcrumb را نمایش می‌دهد.

PropTypeDefault
classNamestring-

کامپوننت BreadcrumbItem آیتم‌های جداگانهٔ breadcrumb را در بر می‌گیرد.

PropTypeDefault
classNamestring-

کامپوننت BreadcrumbLink یک پیوند قابل کلیک در breadcrumb نمایش می‌دهد.

PropTypeDefault
classNamestring-

کامپوننت BreadcrumbPage صفحهٔ فعلی را در breadcrumb نمایش می‌دهد (غیرقابل کلیک).

PropTypeDefault
classNamestring-

کامپوننت BreadcrumbSeparator یک جداکننده بین آیتم‌های breadcrumb نمایش می‌دهد. می‌توانید children سفارشی پاس دهید تا آیکون جداکنندهٔ پیش‌فرض را بازنویسی کنید.

PropTypeDefault
childrenReact.ReactNode-
classNamestring-

کامپوننت BreadcrumbEllipsis یک نشانگر سه‌نقطه برای آیتم‌های جمع‌شدهٔ breadcrumb نمایش می‌دهد.

PropTypeDefault
classNamestring-