ant-design/components/breadcrumb/index.zh-CN.md
ice ca66d5c592
docs(breadcrumb): add with params demo ()
* docs(breadcrumb): add with params demo

* test: add snap
2024-07-16 22:13:14 +08:00

4.0 KiB
Raw Blame History

category group title subtitle description cover coverDark demo
Components 导航 Breadcrumb 面包屑 显示当前页面在系统层级结构中的位置,并能向上返回。 https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*I5a2Tpqs3y0AAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Tr90QKrE_LcAAAAAAAAAAAAADrJ8AQ/original
cols
2

何时使用

  • 当系统拥有超过两级以上的层级结构时;
  • 当需要告知用户『你在哪里』时;
  • 当需要向上导航的功能时。
// >=5.3.0 可用,推荐的写法 ✅
return <Breadcrumb items={[{ title: 'sample' }]} />;

// <5.3.0 可用,>=5.3.0 时不推荐 🙅🏻‍♀️
return (
  <Breadcrumb>
    <Breadcrumb.Item>sample</Breadcrumb.Item>
  </Breadcrumb>
);

// 或

return <Breadcrumb routes={[{ breadcrumbName: 'sample' }]} />;

代码演示

基本 带有图标的 带有参数的 分隔符 带下拉菜单的面包屑 独立的分隔符 Debug Routes 组件 Token

API

通用属性参考:通用属性

Breadcrumb

参数 说明 类型 默认值 版本
itemRender 自定义链接函数,和 react-router 配置使用 (route, params, routes, paths) => ReactNode -
params 路由的参数 object -
items 路由栈信息 items[] - 5.3.0
separator 分隔符自定义 ReactNode /

ItemType

type ItemType = Omit<RouteItemType, 'title' | 'path'> | SeparatorType

RouteItemType

参数 说明 类型 默认值 版本
className 自定义类名 string -
dropdownProps 弹出下拉菜单的自定义配置 Dropdown -
href 链接的目的地,不能和 path 共用 string -
path 拼接路径,每一层都会拼接前一个 path 信息。不能和 href 共用 string -
menu 菜单配置项 MenuProps - 4.24.0
onClick 单击事件 (e:MouseEvent) => void -
title 名称 ReactNode - 5.3.0

SeparatorType

const item = {
  type: 'separator', // Must have
  separator: '/',
};
参数 说明 类型 默认值 版本
type 标记为分隔符 separator 5.3.0
separator 要显示的分隔符 ReactNode / 5.3.0

和 browserHistory 配合

和 react-router 一起使用时,默认生成的 url 路径是带有 # 的,如果和 browserHistory 一起使用的话,你可以使用 itemRender 属性定义面包屑链接。

import { Link } from 'react-router';

const items = [
  {
    path: '/index',
    title: 'home',
  },
  {
    path: '/first',
    title: 'first',
    children: [
      {
        path: '/general',
        title: 'General',
      },
      {
        path: '/layout',
        title: 'Layout',
      },
      {
        path: '/navigation',
        title: 'Navigation',
      },
    ],
  },
  {
    path: '/second',
    title: 'second',
  },
];

function itemRender(currentRoute, params, items, paths) {
  const isLast = currentRoute?.path === items[items.length - 1]?.path;

  return isLast ? (
    <span>{currentRoute.title}</span>
  ) : (
    <Link to={`/${paths.join("/")}`}>{currentRoute.title}</Link>
  );
}

return <Breadcrumb itemRender={itemRender} items={items} />;

主题变量Design Token