Skeleton

<gstock-skeleton> | GstockSkeleton

 <gstock-skeleton></gstock-skeleton>

These are simple containers for scaffolding layouts that mimic what users will see when content has finished loading. This prevents large areas of empty space during asynchronous operations.

Skeletons try not to be opinionated, as there are endless possibilities for designing layouts. Therefore, you’ll likely use more than one skeleton to create the effect you want. If you find yourself using them frequently, consider creating a template that renders them with the desired arrangement and styles.

<div class="skeleton-overview">
  <header>
    <gstock-skeleton></gstock-skeleton>
    <gstock-skeleton></gstock-skeleton>
  </header>

  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
</div>

<style>
  .skeleton-overview header {
    display: flex;
    align-items: center;
    margin-bottom: 1rem;
  }

  .skeleton-overview header gstock-skeleton:last-child {
    flex: 0 0 auto;
    width: 30%;
  }

  .skeleton-overview gstock-skeleton {
    margin-bottom: 1rem;
  }

  .skeleton-overview gstock-skeleton:nth-child(1) {
    float: left;
    width: 3rem;
    height: 3rem;
    margin-right: 1rem;
    vertical-align: middle;
  }

  .skeleton-overview gstock-skeleton:nth-child(3) {
    width: 95%;
  }

  .skeleton-overview gstock-skeleton:nth-child(4) {
    width: 80%;
  }
</style>

Examples

Effects

There are two built-in effects, sheen and pulse. Effects are intentionally subtle, as they can be distracting when used extensively. The default is none, which displays a static, non-animated skeleton.

None Sheen Pulse

<div class="skeleton-effects">
  <gstock-skeleton effect="none"></gstock-skeleton>
  None

  <gstock-skeleton effect="sheen"></gstock-skeleton>
  Sheen

  <gstock-skeleton effect="pulse"></gstock-skeleton>
  Pulse
</div>

<style>
  .skeleton-effects {
    font-size: var(--gstock-legacy-font-size-small);
  }

  .skeleton-effects gstock-skeleton:not(:first-child) {
    margin-top: 1rem;
  }
</style>

Paragraphs

Use multiple skeletons and some clever styles to simulate paragraphs.

<div class="skeleton-paragraphs">
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
</div>

<style>
  .skeleton-paragraphs gstock-skeleton {
    margin-bottom: 1rem;
  }

  .skeleton-paragraphs gstock-skeleton:nth-child(2) {
    width: 95%;
  }

  .skeleton-paragraphs gstock-skeleton:nth-child(4) {
    width: 90%;
  }

  .skeleton-paragraphs gstock-skeleton:last-child {
    width: 50%;
  }
</style>

Avatars

Set a matching width and height to make a circle, square, or rounded avatar skeleton.

<div class="skeleton-avatars">
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
  <gstock-skeleton></gstock-skeleton>
</div>

<style>
  .skeleton-avatars gstock-skeleton {
    display: inline-block;
    width: 3rem;
    height: 3rem;
    margin-right: 0.5rem;
  }

  .skeleton-avatars gstock-skeleton:nth-child(1) {
    --border-radius: 0;
  }

  .skeleton-avatars gstock-skeleton:nth-child(2) {
    --border-radius: var(--gstock-border-radius-medium);
  }
</style>

Custom Shapes

Use the --border-radius custom property to make circles, squares, and rectangles. For more complex shapes, you can apply clip-path to the indicator part. Try Clippy if you need help generating custom shapes.

<div class="skeleton-shapes">
  <gstock-skeleton class="square"></gstock-skeleton>
  <gstock-skeleton class="circle"></gstock-skeleton>
  <gstock-skeleton class="triangle"></gstock-skeleton>
  <gstock-skeleton class="cross"></gstock-skeleton>
  <gstock-skeleton class="comment"></gstock-skeleton>
</div>

<style>
  .skeleton-shapes gstock-skeleton {
    display: inline-flex;
    width: 50px;
    height: 50px;
  }

  .skeleton-shapes .square::part(indicator) {
    --border-radius: var(--gstock-border-radius-medium);
  }

  .skeleton-shapes .circle::part(indicator) {
    --border-radius: var(--gstock-border-radius-circle);
  }

  .skeleton-shapes .triangle::part(indicator) {
    --border-radius: 0;
    clip-path: polygon(50% 0, 0 100%, 100% 100%);
  }

  .skeleton-shapes .cross::part(indicator) {
    --border-radius: 0;
    clip-path: polygon(
      20% 0%,
      0% 20%,
      30% 50%,
      0% 80%,
      20% 100%,
      50% 70%,
      80% 100%,
      100% 80%,
      70% 50%,
      100% 20%,
      80% 0%,
      50% 30%
    );
  }

  .skeleton-shapes .comment::part(indicator) {
    --border-radius: 0;
    clip-path: polygon(0% 0%, 100% 0%, 100% 75%, 75% 75%, 75% 100%, 50% 75%, 0% 75%);
  }

  .skeleton-shapes gstock-skeleton:not(:last-child) {
    margin-right: 0.5rem;
  }
</style>

Custom Colors

Set the --color and --sheen-color custom properties to adjust the skeleton’s color.

<gstock-skeleton effect="sheen" style="--color: tomato; --sheen-color: #ffb094;"></gstock-skeleton>