2016-06-19 11:14:21 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Navigation
2016-06-19 11:14:21 +08:00
title: Breadcrumb
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*I5a2Tpqs3y0AAAAAAAAAAAAADrJ8AQ/original
2023-02-09 22:17:31 +08:00
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Tr90QKrE_LcAAAAAAAAAAAAADrJ8AQ/original
2022-11-09 12:28:04 +08:00
demo:
cols: 2
2016-06-19 11:14:21 +08:00
---
2016-11-29 17:13:24 +08:00
A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy.
2016-06-19 11:14:21 +08:00
2016-09-10 13:43:30 +08:00
## When To Use
2016-06-19 11:14:21 +08:00
- When the system has more than two layers in a hierarchy.
- When you need to inform the user of where they are.
2016-11-29 17:13:24 +08:00
- When the user may need to navigate back to a higher level.
2016-06-19 11:14:21 +08:00
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/basic.tsx" > Basic Usage< / code >
< code src = "./demo/withIcon.tsx" > With an Icon< / code >
2022-11-17 11:30:20 +08:00
< code src = "./demo/react-router.tsx" iframe = "200" > react-router V6< / code >
2022-11-09 12:28:04 +08:00
< code src = "./demo/separator.tsx" > Configuring the Separator< / code >
< code src = "./demo/overlay.tsx" > Bread crumbs with drop down menu< / code >
< code src = "./demo/separator-component.tsx" > Configuring the Separator< / code >
2016-06-19 11:14:21 +08:00
## API
2019-11-20 18:10:44 +08:00
### Breadcrumb
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| itemRender | Custom item renderer | (route, params, routes, paths) => ReactNode | - | |
| params | Routing parameters | object | - | |
| routes | The routing stack information of router | [routes\[\]](#routes) | - | |
| separator | Custom separator | ReactNode | `/` | |
2019-11-20 18:10:44 +08:00
### Breadcrumb.Item
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| className | The additional css class | string | - | |
| dropdownProps | The dropdown props | [Dropdown ](/components/dropdown ) | - | |
| href | Target of hyperlink | string | - | |
2022-12-22 14:12:26 +08:00
| menu | The menu props | [MenuProps ](/components/menu/#api ) | - | 4.24.0 |
2022-11-17 17:31:26 +08:00
| onClick | Set the handler to handle click event | (e:MouseEvent) => void | - | |
2019-11-20 18:10:44 +08:00
### Breadcrumb.Separator
2022-10-23 00:33:45 +08:00
| Property | Description | Type | Default | Version |
| -------- | ---------------- | --------- | ------- | ------- |
| children | Custom separator | ReactNode | `/` | |
2019-11-20 18:10:44 +08:00
> When using `Breadcrumb.Separator`,its parent component must be set to `separator=""`, otherwise the default separator of the parent component will appear.
### routes
```ts
interface Route {
path: string;
breadcrumbName: string;
children: Array< {
path: string;
breadcrumbName: string;
}>;
}
```
2016-08-29 16:52:35 +08:00
2016-12-04 15:17:17 +08:00
### Use with browserHistory
2017-09-08 09:43:43 +08:00
The link of Breadcrumb item targets `#` by default, you can use `itemRender` to make a `browserHistory` Link.
2016-12-04 15:17:17 +08:00
```jsx
import { Link } from 'react-router';
2019-05-06 12:04:39 +08:00
const routes = [
{
path: 'index',
breadcrumbName: 'home',
},
{
path: 'first',
breadcrumbName: 'first',
children: [
{
path: '/general',
breadcrumbName: 'General',
},
{
path: '/layout',
breadcrumbName: 'Layout',
},
{
path: '/navigation',
breadcrumbName: 'Navigation',
},
],
},
{
path: 'second',
breadcrumbName: 'second',
},
];
2016-12-04 15:17:17 +08:00
function itemRender(route, params, routes, paths) {
const last = routes.indexOf(route) === routes.length - 1;
2019-05-06 12:04:39 +08:00
return last ? (
< span > {route.breadcrumbName}< / span >
) : (
< Link to = {paths.join('/')} > {route.breadcrumbName}< / Link >
);
2016-12-04 15:17:17 +08:00
}
2017-10-19 22:36:49 +08:00
return < Breadcrumb itemRender = {itemRender} routes = {routes} / > ;
2016-12-04 15:17:17 +08:00
```