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/material/Skeleton';
// or
import { Skeleton } from '@mui/material';

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-

Optional children to infer width and height from.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

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

heightnumber
| string
-

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

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'
| 'rectangular'
| 'rounded'
| 'text'
| string
'text'

The type of content that will be rendered.

widthnumber
| 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 MuiSkeleton to change the default props of this component with the theme.

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-circularcircularStyles applied to the root element if variant="circular".
.MuiSkeleton-fitContentfitContentStyles applied when the component is passed children and no width.
.MuiSkeleton-heightAutoheightAutoStyles applied when the component is passed children and no height.
.MuiSkeleton-pulsepulseStyles applied to the root element if animation="pulse".
.MuiSkeleton-rectangularrectangularStyles applied to the root element if variant="rectangular".
.MuiSkeleton-rootrootStyles applied to the root element.
.MuiSkeleton-roundedroundedStyles applied to the root element if variant="rounded".
.MuiSkeleton-texttextStyles applied to the root element if variant="text".
.MuiSkeleton-wavewaveStyles applied to the root element if animation="wave".
.MuiSkeleton-withChildrenwithChildrenStyles applied when the component is passed children.

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.