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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

animation

The animation. If false the animation effect is disabled.

Type:

'pulse' | 'wave' | false

Default:

'pulse'
children

Optional children to infer width and height from.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
component

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

Type:

elementType
height

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

Type:

number | string
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
variant

The type of content that will be rendered.

Type:

'circular' | 'rectangular' | 'rounded' | 'text' | string

Default:

'text'
width

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

Type:

number | string
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.


.MuiSkeleton-rootroot

Styles applied to the root element.

.MuiSkeleton-texttext

Styles applied to the root element if variant="text".

.MuiSkeleton-rectangularrectangular

Styles applied to the root element if variant="rectangular".

.MuiSkeleton-roundedrounded

Styles applied to the root element if variant="rounded".

.MuiSkeleton-circularcircular

Styles applied to the root element if variant="circular".

.MuiSkeleton-pulsepulse

Styles applied to the root element if animation="pulse".

.MuiSkeleton-wavewave

Styles applied to the root element if animation="wave".

.MuiSkeleton-withChildrenwithChildren

Styles applied when the component is passed children.

.MuiSkeleton-fitContentfitContent

Styles applied when the component is passed children and no width.

.MuiSkeleton-heightAutoheightAuto

Styles applied when the component is passed children and no height.

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