mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-26 20:20:00 +08:00
d44f404eae
* chore: improve sort api table scripts
* sort api
* add ignore
* Revert "sort api"
This reverts commit 343505d5f0.
* sort api
* Update package.json
* sort api
* Delete sort-api.js
* sort api
* sort api
* sort api
* fix
* Update index.zh-CN.md
* fix input-number
* fix input-number
* sort func
* fix
* Method moved to the end
* carousel method
103 lines
2.6 KiB
Markdown
103 lines
2.6 KiB
Markdown
---
|
|
category: Components
|
|
type: Navigation
|
|
title: Breadcrumb
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/9Ltop8JwH/Breadcrumb.svg
|
|
---
|
|
|
|
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.
|
|
|
|
## API
|
|
|
|
### Breadcrumb
|
|
|
|
| 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 | `/` | |
|
|
|
|
### Breadcrumb.Item
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| dropdownProps | The dropdown props | [Dropdown](/components/dropdown) | - | |
|
|
| href | Target of hyperlink | string | - | |
|
|
| overlay | The dropdown menu | [Menu](/components/menu) \| () => Menu | - | |
|
|
| onClick | Set the handler to handle click event | (e:MouseEvent) => void | - | |
|
|
|
|
### Breadcrumb.Separator
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| children | Custom separator | ReactNode | `/` | |
|
|
|
|
> 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;
|
|
}>;
|
|
}
|
|
```
|
|
|
|
### 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} />;
|
|
```
|