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

Name	Default class	Default value	Description
li	.MuiBreadcrumbs-li	'li'	The component used to render the li. You can use this slot in `slotProps` prop or in `extendTheme` function to customize its style or extend variants.
ol	.MuiBreadcrumbs-ol	'ol'	The component used to render the ol. You can use this slot in `slotProps` prop or in `extendTheme` function to customize its style or extend variants.
root	.MuiBreadcrumbs-root	'nav'	The component used to render the root. You can use this slot in `slotProps` prop or in `extendTheme` function to customize its style or extend variants.
separator	.MuiBreadcrumbs-separator	'li'	The component used to render the separator. You can use this slot in `slotProps` prop or in `extendTheme` function to customize its style or extend variants.