跳转到内容
编辑此页面

Skeleton API

API documentation for the React Skeleton component. Learn about the available props, and the CSS API.

Import

import Skeleton from '@material-ui/core/Skeleton';
// or
import { Skeleton } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSkeleton can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
animation'pulse'
| 'wave'
| false		'pulse'The animation. If false the animation effect is disabled.
childrennodeOptional children to infer width and height from.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe 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.
variant'circular'
| 'rectangular'
| '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.
Any other props supplied will be provided to the root element (native element).

CSS

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".
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: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos