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';

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'. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
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.

You can use JoyBreadcrumbs to change the default props of this component with the theme.

To learn how to customize the slot, check out the Overriding component structure guide.

Name	Default class	Default HTML tag	Description
root	.MuiBreadcrumbs-root	'nav'	The component that renders the root.
ol	.MuiBreadcrumbs-ol	'ol'	The component that renders the ol.
li	.MuiBreadcrumbs-li	'li'	The component that renders the li.
separator	.MuiBreadcrumbs-separator	'li'	The component that renders the separator.

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 styleOverrides property in a custom theme.