Skip to content
Edit this page

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

import Breadcrumbs from '@mui/joy/Breadcrumbs';
// or
import { Breadcrumbs } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:

node
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
separator

Custom separator node.

Type:

node

Default:

'/'
size

The size of the component. It accepts theme values between 'sm' and 'lg'.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ li?: func | object, ol?: func | object, root?: func | object, separator?: func | object }

Default:

{}
slots

The components used for each slot inside.

Type:

{ li?: elementType, ol?: elementType, root?: elementType, separator?: elementType }

Default:

{}
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
The ref is forwarded to the root element.

Theme default props

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

Slots

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

root'nav'Required

Global class: .MuiBreadcrumbs-root

Description: The component that renders the root.

ol'ol'Required

Global class: .MuiBreadcrumbs-ol

Description: The component that renders the ol.

li'li'Required

Global class: .MuiBreadcrumbs-li

Description: The component that renders the li.

separator'li'Required

Global class: .MuiBreadcrumbs-separator

Description: The component that renders the separator.

You can override the style of the component using one of these customization options:

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Class name applied to the root element if size="lg".

Class name applied to the root element if size="md".

Class name applied to the root element if size="sm".