> Leaf UI 0.17.3 · Package: @ifhover/leaf-ui · Source: c3221834f84f2f48481a2054026b713456f8e5dc
> Browser documentation: https://ifhover.github.io/leaf-ui/components/breadcrumb.html

> For AI agents: the complete documentation index is available at https://ifhover.github.io/leaf-ui/llms.txt, the full documentation bundle is available at https://ifhover.github.io/leaf-ui/llms-full.txt.

# Breadcrumb 面包屑

展示当前页面在导航层级中的位置。


## 基础用法

最后一项表示当前页面，可以省略 `href`。如果 `title` 已经是路由框架的 Link，也不要再传 `href`，避免嵌套链接。


1. [首页](https://ifhover.github.io/leaf-ui/)
1. [组件](https://ifhover.github.io/leaf-ui/components/index.html)
1. Breadcrumb

basic.tsx

复制代码

```tsx lineNumbers file="../../src/examples/breadcrumb/basic.tsx"
import { Breadcrumb } from '@ifhover/leaf-ui';

export function BreadcrumbBasic() {
  return (
    <Breadcrumb
      items={[
        { title: '首页', href: 'https://ifhover.github.io/leaf-ui/' },
        { title: '组件', href: 'https://ifhover.github.io/leaf-ui/components/index.html' },
        { title: 'Breadcrumb' },
      ]}
    />
  );
}
```

展开代码


## 示例

### 分隔符

通过 `separator` 设置路径层级之间的分隔内容。


1. [首页](https://ifhover.github.io/leaf-ui/)
1. /[组件](https://ifhover.github.io/leaf-ui/components/index.html)
1. /Breadcrumb

separator.tsx

复制代码

```tsx lineNumbers file="../../src/examples/breadcrumb/separator.tsx"
import { Breadcrumb } from '@ifhover/leaf-ui';

export function BreadcrumbSeparator() {
  return (
    <Breadcrumb
      separator="/"
      items={[
        { title: '首页', href: 'https://ifhover.github.io/leaf-ui/' },
        { title: '组件', href: 'https://ifhover.github.io/leaf-ui/components/index.html' },
        { title: 'Breadcrumb' },
      ]}
    />
  );
}
```

展开代码

### 折叠长路径

通过 `maxItems` 折叠较长路径。点击省略按钮后，仍可访问被折叠的中间链接。


1. [首页](https://ifhover.github.io/leaf-ui/)
1. 
1. API

capabilities.tsx

复制代码

```tsx lineNumbers file="../../src/examples/breadcrumb/capabilities.tsx"
import { Breadcrumb } from '@ifhover/leaf-ui';

export function Capabilities() {
  return (
    <Breadcrumb
      aria-label="折叠后的文档路径"
      items={[
        { title: '首页', href: 'https://ifhover.github.io/leaf-ui/' },
        { title: '组件', href: 'https://ifhover.github.io/leaf-ui/components/index.html' },
        { title: 'Breadcrumb', href: '#基础用法' },
        { title: 'API' },
      ]}
      maxItems={3}
    />
  );
}
```

展开代码


## API

### Breadcrumb API

路径层级、分隔内容与中间路径折叠的配置。

| 属性                    | 类型                                                                          | 默认值          | 说明                          |
| --------------------- | --------------------------------------------------------------------------- | ------------ | --------------------------- |
| `items`               | `readonly `[`BreadcrumbItem`](#breadcrumbitem)`[]`                          | 必填           | 路径列表                        |
| `separator`           | `ReactNode`                                                                 | ChevronRight | 分隔内容                        |
| `maxItems`            | `number`                                                                    | `Infinity`   | 超过此项数时折叠中间路径；最小阈值为 3，默认不折叠。 |
| `itemsBeforeCollapse` | `number`                                                                    | `1`          | 折叠后保留的起始项数。                 |
| `itemsAfterCollapse`  | `number`                                                                    | `1`          | 折叠后保留的末尾项数。                 |
| `itemRender`          | `(item: `[`BreadcrumbItem`](#breadcrumbitem)`, index: number) => ReactNode` | —            | 自定义条目内容。                    |
| `aria-label`          | `string`                                                                    | 语言默认值        | 导航名称                        |

### BreadcrumbItem

通过 `items` 定义的路径层级。

| 属性       | 类型                                                                                                     | 默认值 | 说明                         |
| -------- | ------------------------------------------------------------------------------------------------------ | --- | -------------------------- |
| `key`    | `string`                                                                                               | —   | 稳定标识                       |
| `title`  | `ReactNode`                                                                                            | 必填  | 页面名称                       |
| `icon`   | `ReactNode`                                                                                            | —   | 前置图标                       |
| `menu`   | `readonly `[`DropdownItem`](https://ifhover.github.io/leaf-ui/components/dropdown.md#dropdownitem)`[]` | —   | 该路径项的下拉菜单。                 |
| `href`   | `string`                                                                                               | —   | 链接目标。                      |
| `target` | `string`                                                                                               | —   | 链接的打开目标，遵循原生 a 元素的 target。 |
