Breadcrumb

用於在您的文件中實作 Breadcrumb 的 hook。它會根據指定的頁面樹，回傳該頁面的 Breadcrumb 項目。

若資料夾有索引頁面，則會以該頁面作為項目。

使用方式

它匯出一個 useBreadcrumb hook：

import {  } from 'fumadocs-core/breadcrumb';
// 或使用您的 React 框架所提供的 hook
import {  } from 'fumadocs-core/framework';

const  = ();
const items = (, );      
const items: BreadcrumbItem[]

範例

以下是一個已套用樣式的範例。搭配對應的框架 provider，Fumadocs 的 usePathname() 與 Link 可在任何框架上運作。

'use client';
import { usePathname } from 'fumadocs-core/framework';
import { useBreadcrumb } from 'fumadocs-core/breadcrumb';
import type { PageTree } from 'fumadocs-core/page-tree';
import { Fragment } from 'react';
import { ChevronRight } from 'lucide-react';
import Link from 'fumadocs-core/link';

export function Breadcrumb({ tree }: { tree: PageTree.Root }) {
  const pathname = usePathname();
  const items = useBreadcrumb(pathname, tree);

  if (items.length === 0) return null;

  return (
    <div className="-mb-3 flex flex-row items-center gap-1 text-sm font-medium text-fd-muted-foreground">
      {items.map((item, i) => (
        <Fragment key={i}>
          {i !== 0 && <ChevronRight className="size-4 shrink-0 rtl:rotate-180" />}
          {item.url ? (
            <Link href={item.url} className="truncate hover:text-fd-accent-foreground">
              {item.name}
            </Link>
          ) : (
            <span className="truncate">{item.name}</span>
          )}
        </Fragment>
      ))}
    </div>
  );
}

您可以在伺服器元件中，透過 tree prop 傳入頁面樹來使用它。

屬性

型別

使用方式複製錨點連結

範例複製錨點連結

Breadcrumb 項目複製錨點連結

本頁目錄

使用方式

範例

Breadcrumb 項目