跳转到内容

🎉 v5 beta is out! Head to the v5 documentation to get started.

Skeleton API

The API documentation of the Skeleton React component. Learn more about the props and the CSS customization points.

Import

import Skeleton from '@material-ui/lab/Skeleton';
// or
import { Skeleton } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiSkeleton name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
animation 'pulse'
| 'wave'
| false
'pulse' The animation. If false the animation effect is disabled.
children node Optional children to infer width and height from.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType 'span' The component used for the root node. Either a string to use a HTML element or a component.
height number
| string
Height of the skeleton. Useful when you don't want to adapt the skeleton to a text element but for instance a card.
variant 'text'
| 'rect'
| 'circle'
'text' The type of content that will be rendered.
width number
| 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.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiSkeleton-root Styles applied to the root element.
text .MuiSkeleton-text Styles applied to the root element if variant="text".
rect .MuiSkeleton-rect Styles applied to the root element if variant="rect".
circle .MuiSkeleton-circle Styles applied to the root element if variant="circle".
pulse .MuiSkeleton-pulse Styles applied to the root element if animation="pulse".
wave .MuiSkeleton-wave Styles applied to the root element if animation="wave".
withChildren .MuiSkeleton-withChildren Styles applied when the component is passed children.
fitContent .MuiSkeleton-fitContent Styles applied when the component is passed children and no width.
heightAuto .MuiSkeleton-heightAuto Styles applied when the component is passed children and no height.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos