Breadcrumbs API
API reference docs for the React Breadcrumbs component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Breadcrumbs from '@mui/material/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/material';Props of the Typography component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The component used for the root node. Either a string to use a HTML element or a component.
Type:elementType
Override the default label for the expand button.
For localization purposes, you can use the provided translations.
Type:string
Default:'Show path'
If max items is exceeded, the number of items to show after the ellipsis.
Type:integer
Default:1
If max items is exceeded, the number of items to show before the ellipsis.
Type:integer
Default:1
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.
Type:integer
Default:8
The props used for each slot inside the Breadcumb.
Type:{ collapsedIcon?: func
| object }
Default:{}
The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component.
Type:{ CollapsedIcon?: elementType }
Default:{}
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
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
styleOverridesproperty in a custom theme.