Skip to content

Breadcrumbs API

API documentation for the React Breadcrumbs component. Learn about the available props, and the CSS API.

Import

import Breadcrumbs from '@material-ui/core/Breadcrumbs';
// or
import { Breadcrumbs } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiBreadcrumbs can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
expandTextstring'Show path'Override the default label for the expand button.
For localization purposes, you can use the provided translations.
itemsAfterCollapsenumber1If max items is exceeded, the number of items to show after the ellipsis.
itemsBeforeCollapsenumber1If max items is exceeded, the number of items to show before the ellipsis.
maxItemsnumber8Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first itemsBeforeCollapse and last itemsAfterCollapse will be shown, with an ellipsis in between.
separatornode'/'Custom separator node.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiBreadcrumbs-rootStyles applied to the root element.
ol.MuiBreadcrumbs-olStyles applied to the ol element.
li.MuiBreadcrumbs-liStyles applied to the li element.
separator.MuiBreadcrumbs-separatorStyles applied to the separator element.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos