ant-design/components/breadcrumb/index.en-US.md
Khalifa Lame 224e65fc27 docs: update Breadcrumb English doc (#7490)
Fixed minor typos.
2017-09-08 09:43:43 +08:00

1.5 KiB

category type title
Components Navigation 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
routes The routing stack information of router object[] -
params Routing parameters object -
separator Custom separator string|ReactNode /
itemRender Custom item renderer (route, params, routes, paths) => 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.

import { Link } from 'react-router';

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} />;