Skeleton API
API reference docs for the React Skeleton component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Skeleton from '@mui/material/Skeleton';
// or
import { Skeleton } from '@mui/material';
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
animation | 'pulse' | 'wave' | false | 'pulse' | The animation. If |
children | node | - | Optional children to infer width and height from. |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
component | elementType | - | 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. |
sx | Array<func | object | bool> | func | object | - | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
variant | 'circular' | 'rectangular' | 'rounded' | 'text' | string | '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. |
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.MuiSkeleton-circular | circular | Styles applied to the root element if variant="circular" . |
.MuiSkeleton-fitContent | fitContent | Styles applied when the component is passed children and no width. |
.MuiSkeleton-heightAuto | heightAuto | Styles applied when the component is passed children and no height. |
.MuiSkeleton-pulse | pulse | Styles applied to the root element if animation="pulse" . |
.MuiSkeleton-rectangular | rectangular | Styles applied to the root element if variant="rectangular" . |
.MuiSkeleton-root | root | Styles applied to the root element. |
.MuiSkeleton-rounded | rounded | Styles applied to the root element if variant="rounded" . |
.MuiSkeleton-text | text | Styles applied to the root element if variant="text" . |
.MuiSkeleton-wave | wave | Styles applied to the root element if animation="wave" . |
.MuiSkeleton-withChildren | withChildren | Styles applied when the component is passed children. |
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.