Skeleton API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Skeleton

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

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 classes

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

.MuiSkeleton-circular

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

Rule name:circular

.MuiSkeleton-fitContent

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

Rule name:fitContent

.MuiSkeleton-heightAuto

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

Rule name:heightAuto

.MuiSkeleton-pulse

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

Rule name:pulse

.MuiSkeleton-rectangular

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

Rule name:rectangular

.MuiSkeleton-root

Styles applied to the root element.

Rule name:root

.MuiSkeleton-rounded

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

Rule name:rounded

.MuiSkeleton-text

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

Rule name:text

.MuiSkeleton-wave

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

Rule name:wave

.MuiSkeleton-withChildren

Styles applied when the component is passed children.

Rule name:withChildren

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.