Skip to content
Edit this page

Skeleton API

API reference docs for the React Skeleton 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 Skeleton from '@mui/material/Skeleton';
// or
import { Skeleton } from '@mui/material';
You can 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 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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule nameGlobal classDescription
root.MuiSkeleton-rootStyles applied to the root element.
text.MuiSkeleton-textStyles applied to the root element if variant="text".
rectangular.MuiSkeleton-rectangularStyles applied to the root element if variant="rectangular".
rounded.MuiSkeleton-roundedStyles applied to the root element if variant="rounded".
circular.MuiSkeleton-circularStyles applied to the root element if variant="circular".
pulse.MuiSkeleton-pulseStyles applied to the root element if animation="pulse".
wave.MuiSkeleton-waveStyles applied to the root element if animation="wave".
withChildren.MuiSkeleton-withChildrenStyles applied when the component is passed children.
fitContent.MuiSkeleton-fitContentStyles applied when the component is passed children and no width.
heightAuto.MuiSkeleton-heightAutoStyles applied when the component is passed children and no height.

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