import Link from "next/link"
import {面包屑显示当前页面在站点层级中的位置,并把它上面的每一级都做成链接。它不是 Base UI 基元——只是语义化的 HTML(nav + <ol>),用 Base UI 的 useRender 来实现 render 属性式的组合——并按新粗野主义的配方设计:链接用标题字体,当前页面用加粗的前景色。
适合以下场景:
- 文档与知识库——Docs / Components / Breadcrumb,读者不用在侧边栏里翻找就能退回上一级。
- 电商分类树——Home / Clothing / Jackets,一次点击就能从很深的商品页里脱身。
- 仪表盘与文件浏览器——嵌套的项目、设置或目录路径,光看 URL 定不清方位。
安装#
pnpm dlx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.jsonnpx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.jsonyarn dlx shadcn@latest add https://neobrutalism.com/r/base/breadcrumb.jsonbunx --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,自定义分隔符#
将自定义组件作为 <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"无障碍#
面包屑遵循 WAI-ARIA Breadcrumb 模式:Breadcrumb 渲染一个 <nav aria-label="breadcrumb"> 地标,里面包着一个有序列表,于是屏幕阅读器会把它播报为面包屑导航,用户也可以直接跳到这里。BreadcrumbPage 带上 aria-current="page" 来标记当前位置,分隔符带 aria-hidden,不会被读出来。各项都是普通链接——Tab 和 Enter 的行为都是标准的,不需要额外接键盘逻辑。
API 参考#
Breadcrumb#
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 | - |