Breadcrumbs API
The API documentation of the Breadcrumbs React component. Learn more about the properties and the CSS customization points.
import Breadcrumbs from '@material-ui/core/Breadcrumbs';Props
| Name | Type | Default | Description |
|---|---|---|---|
| children * | node | The breadcrumb children. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| component | elementType | 'nav' | The component used for the root node. Either a string to use a DOM element or a component. By default, it maps the variant to a good default headline component. |
| itemsAfterCollapse | number | 1 | If max items is exceeded, the number of items to show after the ellipsis. |
| itemsBeforeCollapse | number | 1 | If max items is exceeded, the number of items to show before the ellipsis. |
| maxItems | number | 8 | Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first and last will be shown, with an ellipsis in between. |
| separator | node | '/' | Custom separator node. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| ol | Styles applied to the ol element. |
| li | Styles applied to the li element. |
| separator | Styles applied to the separator element. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiBreadcrumbs.
Notes
The component is fully StrictMode compatible.