mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 04:58:55 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
71 lines
1.8 KiB
Markdown
71 lines
1.8 KiB
Markdown
---
|
|
category: Components
|
|
type: Navigation
|
|
title: Breadcrumb
|
|
---
|
|
|
|
A breadcrumb displays the current location within a hierarchy. It allows going back to states higher up in the hierarchy.
|
|
|
|
## When To Use
|
|
|
|
- When the system has more than two layers in a hierarchy.
|
|
- When you need to inform the user of where they are.
|
|
- When the user may need to navigate back to a higher level.
|
|
- When the application has multi-layer architecture.
|
|
|
|
## API
|
|
|
|
| Property | Description | Type | Optional | 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 | string\|ReactNode | | `/` | |
|
|
|
|
### Use with browserHistory
|
|
|
|
The link of Breadcrumb item targets `#` by default, you can use `itemRender` to make a `browserHistory` Link.
|
|
|
|
```jsx
|
|
import { Link } from 'react-router';
|
|
|
|
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',
|
|
},
|
|
];
|
|
function itemRender(route, params, routes, paths) {
|
|
const last = routes.indexOf(route) === routes.length - 1;
|
|
return last ? (
|
|
<span>{route.breadcrumbName}</span>
|
|
) : (
|
|
<Link to={paths.join('/')}>{route.breadcrumbName}</Link>
|
|
);
|
|
}
|
|
|
|
return <Breadcrumb itemRender={itemRender} routes={routes} />;
|
|
```
|