Skip to content

Skeleton API

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

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
animation'pulse'
| 'wave'
| false		'pulse'

The animation. If false the animation effect is disabled.

childrennode-

Used to render icon or text elements inside the Skeleton if src is not set. This can be an element, or just a string.

componentelementType-

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

heightArray<number
| string>
| number
| { lg?: number
| string, md?: number
| string, sm?: number
| string, xl?: number
| string, xs?: number
| string }
| string		-

Height of the skeleton. Useful when you don't want to adapt the skeleton to a text element but for instance a card.

level'h1'
| 'h2'
| 'h3'
| 'h4'
| 'title-lg'
| 'title-md'
| 'title-sm'
| 'body-lg'
| 'body-md'
| 'body-sm'
| 'body-xs'
| 'inherit'
| string		variant === 'text' ? 'body-md' : 'inherit'

Applies the theme typography styles.

loadingbooltrue

If true, the skeleton appears.

overlayboolfalse

If true, the skeleton's position will change to absolute to fill the available space of the nearest parent. This prop is useful to create a placeholder that has the element's dimensions.

slotProps{ root?: func
| object }		{}

The props used for each slot inside.

slots{ root?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

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

variant'circular'
| 'inline'
| 'overlay'
| 'rectangular'
| 'text'
| string		'overlay'

The type of content that will be rendered.

To learn how to add your own variants, check out Themed components—Extend variants.

widthArray<number
| string>
| number
| { lg?: number
| string, md?: number
| string, sm?: number
| string, xl?: number
| string, xs?: number
| string }
| string		-

Width of the skeleton. Useful when the skeleton is inside an inline element with no width of its own.

The ref is forwarded to the root element.

Theme default props

You can use JoySkeleton 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.

Slot nameClass nameDefault componentDescription
root.MuiSkeleton-root'span'The component that renders the root.

CSS classes

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

Class nameRule nameDescription
.MuiSkeleton-body-lgbody-lgClass name applied to the root element if level="body-lg".
.MuiSkeleton-body-mdbody-mdClass name applied to the root element if level="body-md".
.MuiSkeleton-body-smbody-smClass name applied to the root element if level="body-sm".
.MuiSkeleton-body-xsbody-xsClass name applied to the root element if level="body-xs".
.MuiSkeleton-h1h1Class name applied to the root element if level="h1".
.MuiSkeleton-h2h2Class name applied to the root element if level="h2".
.MuiSkeleton-h3h3Class name applied to the root element if level="h3".
.MuiSkeleton-h4h4Class name applied to the root element if level="h4".
.MuiSkeleton-title-lgtitle-lgClass name applied to the root element if level="title-lg".
.MuiSkeleton-title-mdtitle-mdClass name applied to the root element if level="title-md".
.MuiSkeleton-title-smtitle-smClass name applied to the root element if level="title-sm".
.MuiSkeleton-variantCircularvariantCircularClass name applied to the root element if variant="circular".
.MuiSkeleton-variantInlinevariantInlineClass name applied to the root element if variant="inline".
.MuiSkeleton-variantOverlayvariantOverlayClass name applied to the root element if variant="overlay".
.MuiSkeleton-variantRectangularvariantRectangularClass name applied to the root element if variant="rectangular".
.MuiSkeleton-variantTextvariantTextClass name applied to the root element if variant="text".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.