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:

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

The name JoyBreadcrumbs can be used when providing default props or style overrides in the theme.

Props of the native component are also available.

Name	Type	Default	Description
children	node		The content of the component.
separator	node	'/'	Custom separator node.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'.
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.

Name	Default class	Default value	Description
li	.MuiBreadcrumbs-li	'li'	The component used to render the li.
ol	.MuiBreadcrumbs-ol	'ol'	The component used to render the ol.
root	.MuiBreadcrumbs-root	'nav'	The component used to render the root.
separator	.MuiBreadcrumbs-separator	'li'	The component used to render the separator.