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

animation

The animation. If false the animation effect is disabled.

Type:'pulse' | 'wave' | false

Default:'pulse'

children

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

Type:node

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:Array<number | string> | number | { lg?: number | string, md?: number | string, sm?: number | string, xl?: number | string, xs?: number | string } | string

level

Applies the theme typography styles.

Default:variant === 'text' ? 'body-md' : 'inherit'

If true, the skeleton appears.

Type:bool

Default:true

overlay

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.

Type:bool

Default:false

slotProps

The props used for each slot inside.

Type:{ root?: func | object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

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.

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

Default:'overlay'

width

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

Type:Array<number | string> | number | { lg?: number | string, md?: number | string, sm?: number | string, xl?: number | string, xs?: number | string } | string

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.

root

The component that renders the root.

Class name: .MuiSkeleton-root

Default component: 'span'

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-body-lg

Class name applied to the root element if level="body-lg".

Rule name:body-lg

.MuiSkeleton-body-md

Class name applied to the root element if level="body-md".

Rule name:body-md

.MuiSkeleton-body-sm

Class name applied to the root element if level="body-sm".

Rule name:body-sm

.MuiSkeleton-body-xs

Class name applied to the root element if level="body-xs".

Rule name:body-xs

.MuiSkeleton-h1

Class name applied to the root element if level="h1".

Rule name:h1

.MuiSkeleton-h2

Class name applied to the root element if level="h2".

Rule name:h2

.MuiSkeleton-h3

Class name applied to the root element if level="h3".

Rule name:h3

.MuiSkeleton-h4

Class name applied to the root element if level="h4".

Rule name:h4

.MuiSkeleton-title-lg

Class name applied to the root element if level="title-lg".

Rule name:title-lg

.MuiSkeleton-title-md

Class name applied to the root element if level="title-md".

Rule name:title-md

.MuiSkeleton-title-sm

Class name applied to the root element if level="title-sm".

Rule name:title-sm

.MuiSkeleton-variantCircular

Class name applied to the root element if variant="circular".

Rule name:variantCircular

.MuiSkeleton-variantInline

Class name applied to the root element if variant="inline".

Rule name:variantInline

.MuiSkeleton-variantOverlay

Class name applied to the root element if variant="overlay".

Rule name:variantOverlay

.MuiSkeleton-variantRectangular

Class name applied to the root element if variant="rectangular".

Rule name:variantRectangular

.MuiSkeleton-variantText

Class name applied to the root element if variant="text".

Rule name:variantText

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.