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, and this page is available as Markdown at https://ifhover.github.io/leaf-ui/components/breadcrumb.md.

Breadcrumb 面包屑

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

基础用法

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

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 设置路径层级之间的分隔内容。

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 折叠较长路径。点击省略按钮后,仍可访问被折叠的中间链接。

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

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

属性类型默认值说明
itemsreadonly BreadcrumbItem[]必填路径列表
separatorReactNodeChevronRight分隔内容
maxItemsnumberInfinity超过此项数时折叠中间路径;最小阈值为 3,默认不折叠。
itemsBeforeCollapsenumber1折叠后保留的起始项数。
itemsAfterCollapsenumber1折叠后保留的末尾项数。
itemRender(item: BreadcrumbItem, index: number) => ReactNode—自定义条目内容。
aria-labelstring语言默认值导航名称

通过 items 定义的路径层级。

属性类型默认值说明
keystring—稳定标识
titleReactNode必填页面名称
iconReactNode—前置图标
menureadonly DropdownItem[]—该路径项的下拉菜单。
hrefstring—链接目标。
targetstring—链接的打开目标,遵循原生 a 元素的 target。