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';

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

Props of the native component are also available.

Name	Type	Default	Description
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
expandText	string	'Show path'	Override the default label for the expand button. For localization purposes, you can use the provided translations.
itemsAfterCollapse	integer	1	If max items is exceeded, the number of items to show after the ellipsis.
itemsBeforeCollapse	integer	1	If max items is exceeded, the number of items to show before the ellipsis.
maxItems	integer	8	Specifies 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.
separator	node	'/'	Custom separator node.
sx	object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

Rule name	Global class	Description
root	.MuiBreadcrumbs-root	Styles applied to the root element.
ol	.MuiBreadcrumbs-ol	Styles applied to the ol element.
li	.MuiBreadcrumbs-li	Styles applied to the li element.
separator	.MuiBreadcrumbs-separator	Styles applied to the separator element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.