ant-design/components/breadcrumb/index.en-US.md

51 lines
1.5 KiB
Markdown
Raw Normal View History

---
category: Components
type: Navigation
title: Breadcrumb
---
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-09-10 13:43:30 +08:00
## 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.
2016-11-29 17:13:24 +08:00
- When the user may need to navigate back to a higher level.
- When the application has multi-layer architecture.
## API
2017-10-25 10:25:44 +08:00
| 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.
2016-12-04 15:17:17 +08:00
### Use with browserHistory
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';
const routes = [{
path: 'index',
 breadcrumbName: 'home'
}, {
path: 'first',
breadcrumbName: 'first'
}, {
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;
return last ? <span>{route.breadcrumbName}</span> : <Link to={paths.join('/')}>{route.breadcrumbName}</Link>;
}
return <Breadcrumb itemRender={itemRender} routes={routes} />;
2016-12-04 15:17:17 +08:00
```