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';
// o
import { Skeleton } from '@material-ui/core';
Component name
The nameMuiSkeleton
can be used when providing default props or style overrides in the theme.Props
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
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 | 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 | 'circular' | 'rectangular' | '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. |
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 | Descripción |
---|---|---|
root | .MuiSkeleton-root | Styles applied to the root element. |
text | .MuiSkeleton-text | Styles applied to the root element if variant="text" . |
rectangular | .MuiSkeleton-rectangular | Styles applied to the root element if variant="rectangular" . |
circular | .MuiSkeleton-circular | Styles applied to the root element if variant="circular" . |
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 using one of these customization options:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
styleOverrides
property.