Skip to content

Breadcrumbs API

API reference docs for the React Breadcrumbs component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

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

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

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.

See Slots API below for more details.

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.

See the `sx` page for more details.

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.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiBreadcrumbs-sizeLg

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

Rule name:sizeLg

.MuiBreadcrumbs-sizeMd

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

Rule name:sizeMd

.MuiBreadcrumbs-sizeSm

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

Rule name:sizeSm


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