mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-29 05:29:37 +08:00
51 lines
1.5 KiB
Markdown
51 lines
1.5 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 |
|
||
| -------- | ----------- | ---- | -------- | ------- |
|
||
| itemRender | Custom item renderer | (route, params, routes, paths) => ReactNode | | - |
|
||
| params | Routing parameters | object | | - |
|
||
| routes | The routing stack information of router | object\[] | | - |
|
||
| separator | Custom separator | string\|ReactNode | | `/` |
|
||
|
||
> `linkRender` and `nameRender` were removed after `antd@2.0`, please use `itemRender` instead.
|
||
|
||
### 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'
|
||
}, {
|
||
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} />;
|
||
```
|