www/docs/components/placeholder.mdx
import PlaceholderAnimation from '!!raw-loader!../examples/Placeholder/Animation'; import PlaceholderCard from '!!raw-loader!../examples/Placeholder/Card'; import PlaceholderColor from '!!raw-loader!../examples/Placeholder/Color'; import PlaceholderExample from '!!raw-loader!../examples/Placeholder/Example'; import PlaceholderSize from '!!raw-loader!../examples/Placeholder/Size'; import PlaceholderWidth from '!!raw-loader!../examples/Placeholder/Width';
Placeholders can be used to enhance the experience of your application. They’re built only with HTML and CSS, meaning you don’t need any JavaScript to create them. You will, however, need some custom JavaScript to toggle their visibility. Their appearance, color, and sizing can be easily customized with our utility classes.
In the example below, we take a typical card component and recreate it with placeholders applied to create a “loading card”. Size and proportions are the same between the two.
<CodeBlock language="jsx" live> {PlaceholderCard} </CodeBlock>Create placeholders with the Placeholder component and a grid column prop (e.g., xs={6})
to set the width. They can replace the text inside an element or be added to an existing
component via the as prop.
Additional styling is applied to PlaceholderButtons via ::before to ensure the height
is respected. You may extend this pattern for other situations as needed, or add a
within the element to reflect the height when actual text is rendered in its place.
:::info
The use of aria-hidden="true" only indicates that the element
should be hidden to screen readers. The loading behaviour of the
placeholder depends on how authors will actually use the placeholder styles,
how they plan to update things, etc. Some JavaScript code may be needed to
swap the state of the placeholder and inform AT users of the update.
:::
You can change the width through grid column classes, width utilities, or inline styles.
By default, the Placeholder uses currentColor. This can be overridden with a custom color
or utility class.
The size of Placeholders are based on the typographic style of the parent element.
Customize them with sizing props: lg, sm, or xs.
Animate placeholders by setting the prop animation to glow or wave to better
convey the perception of something being actively loaded.