CAST Figuration®

Placeholder

Use loading placeholders for your components or pages to indicate something may still be loading.

Page Contents

About

Placeholders can be used to enhance the experience of your application. They are 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.

Example

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.

Card image cap
Card title

Some example text to build on the card title and make up the bulk of the card's content.

Go somewhere 
<div class="card">
  <img src="..." class="card-img-top" alt="...">

  <div class="card-body">
    <h5 class="card-title">Card title</h5>
    <p class="card-text">Some  example text to build on the card title and make up the bulk of the card's content.</p>
    <a href="#" class="btn btn-primary">Go somewhere</a>
  </div>
</div>

<div class="card" aria-hidden="true">
  <img src="..." class="card-img-top" alt="...">
  <div class="card-body">
    <h5 class="card-title placeholder-glow">
      <span class="placeholder col-6"></span>
    </h5>
    <p class="card-text placeholder-glow">
      <span class="placeholder col-7"></span>
      <span class="placeholder col-4"></span>
      <span class="placeholder col-4"></span>
      <span class="placeholder col-6"></span>
      <span class="placeholder col-8"></span>
    </p>
    <a class="btn btn-primary disabled placeholder col-6" aria-disabled="true"></a>
  </div>
</div>

How It Works

Create placeholders with the .placeholder class and a grid column class (e.g., .col-6) to set the width. They can replace the text inside an element or as be added as a modifier class to an existing component.

We apply additional styling to .btns via ::before to ensure the height is respected. You may extend this pattern for other situations as needed, or add a &nbsp; within the element to reflect the height when actual text is rendered in its place.

<p aria-hidden="true">
  <span class="placeholder col-6"></span>
</p>

<a class="btn btn-primary disabled placeholder col-4" aria-disabled="true"></a>

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 JavasSript code may be needed to swap the state of the placeholder and inform AT users of the update.

Width

You can change the width through grid column classes, width utilities, or inline styles.

<span class="placeholder col-6"></span>
<span class="placeholder w-75"></span>
<span class="placeholder" style="width: 25%;"></span>

Color

By default, the placeholder uses currentcolor. This can be overriden with a custom color or utility class.

<span class="placeholder col-12"></span>

<span class="placeholder col-12 bg-primary"></span>
<span class="placeholder col-12 bg-secondary"></span>
<span class="placeholder col-12 bg-success"></span>
<span class="placeholder col-12 bg-danger"></span>
<span class="placeholder col-12 bg-warning"></span>
<span class="placeholder col-12 bg-info"></span>
<span class="placeholder col-12 bg-light"></span>
<span class="placeholder col-12 bg-dark"></span>

Sizing

The size of .placeholders are based on the typographic style of the parent element. Customize them with sizing modifiers: .placeholder-large, .placeholder-small, or .placeholder-xsmall.

<span class="placeholder col-12 placeholder-large"></span>
<span class="placeholder col-12"></span>
<span class="placeholder col-12 placeholder-small"></span>
<span class="placeholder col-12 placeholder-xsmall"></span>

Animation

Animate placehodlers with .placeholder-glow or .placeholder-wave to better convey the perception of something being actively loaded.

<p class="placeholder-glow">
  <span class="placeholder col-12"></span>
</p>

<p class="placeholder-wave">
  <span class="placeholder col-12"></span>
</p>

SASS Reference

Variables

The available Customization options, or Sass variables, that can be customized for the placeholder component.

Name Type Default Description
$enable-placeholder boolean true Enable the generation of the placeholder component classes.
$enable-placeholder-sizes boolean true Enable the generation of the placeholder size classes.
$enable-placeholder-wave boolean true Enable the generation of the placeholder wave animation class.
$enable-placeholder-glow boolean true Enable the generation of the placeholder glow animation class.
$placeholder-opacity-max string .5 Maximum opacity level to use with placeholder elements and animations.
$placeholder-opacity-min string .2 Minimum opacity level to use with placeholder animations.
$placeholder-sizes map 
("xsmall":   .5em,
"small":    .75em,
"large":    1.25em)
 Map of placeholder sizes to be generated.

Mixins

No mixins available.

Top of Page