Breadcrumbs API

API reference docs for the React Breadcrumbs component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Breadcrumbs

Import

import Breadcrumbs from '@mui/material/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Typography 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 classes 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.
slotProps	{ collapsedIcon?: func \| object }	{}	The props used for each slot inside the Breadcumb.
slots	{ CollapsedIcon?: elementType }	{}	The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component.
sx	Array<func \| object \| bool> \| func \| 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.

Inheritance

While not explicitly documented above, the props of the Typography component are also available in Breadcrumbs. You can take advantage of this to target nested components.

Theme default props

You can use MuiBreadcrumbs to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiBreadcrumbs-li	li	Styles applied to the li element.
.MuiBreadcrumbs-ol	ol	Styles applied to the ol element.
.MuiBreadcrumbs-root	root	Styles applied to the root element.
.MuiBreadcrumbs-separator	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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.