Breadcrumbs API
Demos
For examples and details on the usage of this React component, visit the component demo pages:
Import
import Breadcrumbs from '@mui/material/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/material';Component name
The nameMuiBreadcrumbs can be used when providing default props or style overrides in the theme.Props
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 | 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.CSS
| 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
styleOverridesproperty in a custom theme.