Skip to content
Edit this page

Breadcrumbs API

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

Import

import Breadcrumbs from '@mui/material/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/material';
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

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The 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.
itemsAfterCollapseinteger1
If max items is exceeded, the number of items to show after the ellipsis.
itemsBeforeCollapseinteger1
If max items is exceeded, the number of items to show before the ellipsis.
maxItemsinteger8
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.
separatornode'/'
Custom separator node.
sxArray<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.

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:

Demos