> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes.heygen.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Skeleton Reveal

> A skeleton loader transition that pulses, then cross-fades into content

export const InstallCommand = ({command}) => {
  const [copied, setCopied] = React.useState(false);
  const copy = async () => {
    try {
      if (navigator.clipboard && window.isSecureContext) {
        await navigator.clipboard.writeText(command);
      } else {
        const previous = document.activeElement;
        const scratch = document.createElement("textarea");
        scratch.value = command;
        scratch.setAttribute("readonly", "");
        scratch.style.position = "fixed";
        scratch.style.opacity = "0";
        document.body.appendChild(scratch);
        scratch.select();
        document.execCommand("copy");
        document.body.removeChild(scratch);
        previous?.focus?.();
      }
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    } catch {}
  };
  return <div className="hf-install-command not-prose my-4 flex items-stretch overflow-hidden rounded-xl border border-zinc-200 bg-zinc-50 dark:border-zinc-800 dark:bg-zinc-900">
      <code className="flex-1 overflow-x-auto whitespace-nowrap border-r border-zinc-200 px-4 py-3 font-mono text-sm text-zinc-800 dark:border-zinc-800 dark:text-zinc-100">
        {command}
      </code>
      <button type="button" onClick={copy} data-copied={copied ? "true" : "false"} aria-label={`Copy ${command} to the clipboard`} className="hf-install-copy">
        <svg className="hf-install-copy-clipboard" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M14.25 5.25H7.25C6.14543 5.25 5.25 6.14543 5.25 7.25V14.25C5.25 15.3546 6.14543 16.25 7.25 16.25H14.25C15.3546 16.25 16.25 15.3546 16.25 14.25V7.25C16.25 6.14543 15.3546 5.25 14.25 5.25Z" />
          <path d="M2.80103 11.998L1.77203 5.07397C1.61003 3.98097 2.36403 2.96397 3.45603 2.80197L10.38 1.77297C11.313 1.63397 12.19 2.16297 12.528 3.00097" />
        </svg>
        <svg className="hf-install-copy-check" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 18 18" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" aria-hidden="true">
          <path d="M2.75 9.5L6.5 13.25L15.25 4.5" />
        </svg>
      </button>
      <span className="hf-install-copy-status" role="status" aria-live="polite">
        {copied ? "Copied" : ""}
      </span>
    </div>;
};

<iframe className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800" title="skeleton-reveal preview" loading="lazy" srcDoc={`<!doctype html><html><head><meta charset="utf-8"><style>html,body{margin:0;height:100%;overflow:hidden;background:transparent}hyperframes-player{display:block;width:100%;height:100%}</style><script src="https://cdn.jsdelivr.net/npm/@hyperframes/player@0.7/dist/hyperframes-player.global.js"><\/script></head><body><script>fetch("/public/catalog/components/skeleton-reveal.json").then(function(r){return r.json()}).then(function(d){var p=document.createElement("hyperframes-player");p.setAttribute("srcdoc",d.html);p.setAttribute("controls","");p.setAttribute("autoplay","");p.setAttribute("loop","");p.setAttribute("muted","");p.setAttribute("poster","https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/skeleton-reveal.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

<InstallCommand command="npx hyperframes add skeleton-reveal" />

That writes one file: `compositions/components/skeleton-reveal.html`.

## Variables

Every one of these has a default, so the piece works untouched. Set the ones you
want to change on the element:

| Variable | Default            | Accepts         | What it does                                                                                               |
| -------- | ------------------ | --------------- | ---------------------------------------------------------------------------------------------------------- |
| `name`   | `Jane Cooper`      | string          | Primary line revealed once the skeleton fades out.                                                         |
| `detail` | `jane@example.com` | string          | Secondary line under the name, such as an email or a role.                                                 |
| `tone`   | `light`            | `light`, `dark` | Card palette. Light is the paper card, dark is a near-black card with the matching skeleton bars and text. |

Set them with `data-variable-values` on the element that mounts it. These are the
defaults, so this behaves exactly like the preview above until you change one:

```html wrap theme={null}
<div
  data-composition-id="skeleton-reveal"
  data-composition-src="compositions/components/skeleton-reveal.html"
  data-variable-values='{"name":"Jane Cooper","detail":"jane@example.com","tone":"light"}'
></div>
```

## Source

<Accordion title={`skeleton-reveal.html`}>
  ```html theme={null}
  <!--
    Skeleton Reveal - transitions.dev-inspired primitive for HyperFrames.

    Paste the markup and CSS into a composition. Use the timeline integration
    note at the bottom as the starting point for deterministic GSAP animation.

    Variables. The script reads each one, falls back to the declared default on
    anything missing or invalid, and writes the result as a custom property the
    CSS below consumes, or straight onto the revealed text. The timeline recipe
    stays untouched: it keeps sweeping the skeleton and cross-fading to the
    content, and these decide what that content says and what both halves look
    like.

      - name (string, default Jane Cooper): the primary line revealed once the
        skeleton fades out. Blank falls back to the default.
      - detail (string, default jane@example.com): the secondary line under the
        name, such as an email or a role. Blank falls back to the default.
      - tone (light | dark, default light): card palette. Light is the paper card
        with grey bars, dark is a near-black card with the matching skeleton bars
        and text, for compositions on a dark stage.

    On every default the result is identical to the original: a white card that
    shimmers, then reveals Jane Cooper and jane@example.com.
  -->

  <div
    class="hf-transition-skeleton-reveal"
    data-composition-variables='[
      { "id": "name", "type": "string", "role": "content", "label": "Name", "description": "Primary line revealed once the skeleton fades out.", "default": "Jane Cooper" },
      { "id": "detail", "type": "string", "role": "content", "label": "Detail", "description": "Secondary line under the name, such as an email or a role.", "default": "jane@example.com" },
      { "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Card palette. Light is the paper card, dark is a near-black card with the matching skeleton bars and text.", "default": "light", "options": [{ "value": "light", "label": "Light" }, { "value": "dark", "label": "Dark" }] }
    ]'
  >
    <div class="skeleton"></div>
    <div class="content"><strong>Jane Cooper</strong><span>jane@example.com</span></div>
  </div>

  <style>
    .hf-transition-skeleton-reveal {
      position: relative;
      width: 340px;
      height: 76px;
      font-family: Inter, system-ui, sans-serif;
    }
    .hf-transition-skeleton-reveal .skeleton,
    .hf-transition-skeleton-reveal .content {
      position: absolute;
      inset: 0;
      border: 1px solid var(--hf-sr-border, #e4e4e7);
      border-radius: 14px;
      background: var(--hf-sr-surface, #fff);
    }
    .hf-transition-skeleton-reveal .skeleton {
      background: linear-gradient(
        90deg,
        var(--hf-sr-bar, #f4f4f5),
        var(--hf-sr-bar-strong, #e4e4e7),
        var(--hf-sr-bar, #f4f4f5)
      );
      background-size: 240% 100%;
      opacity: 1;
    }
    .hf-transition-skeleton-reveal .content {
      display: grid;
      align-content: center;
      gap: 5px;
      padding: 15px;
      opacity: 0;
      color: var(--hf-sr-ink, #18181b);
    }
    .hf-transition-skeleton-reveal span {
      color: var(--hf-sr-muted, #71717a);
      font-size: 14px;
    }
  </style>

  <script>
    (function () {
      "use strict";

      var vars =
        window.__hyperframes && window.__hyperframes.getVariables
          ? window.__hyperframes.getVariables()
          : {};

      // Unrecognised overrides return to their declared defaults.
      var tones = {
        light: null,
        dark: {
          "--hf-sr-surface": "#18181b",
          "--hf-sr-border": "#27272a",
          "--hf-sr-bar": "#27272a",
          "--hf-sr-bar-strong": "#3f3f46",
          "--hf-sr-ink": "#fafafa",
          "--hf-sr-muted": "#a1a1aa",
        },
      };
      var defaultName = "Jane Cooper";
      var defaultDetail = "jane@example.com";

      function pick(table, value, fallback) {
        return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
      }

      function text(value, fallback) {
        return typeof value === "string" && value.trim() ? value.trim() : fallback;
      }

      var tone = tones[pick(tones, vars.tone, "light")];
      var name = text(vars.name, defaultName);
      var detail = text(vars.detail, defaultDetail);

      var roots = document.querySelectorAll(".hf-transition-skeleton-reveal");
      for (var i = 0; i < roots.length; i += 1) {
        var root = roots[i];
        if (tone) {
          for (var key in tone) root.style.setProperty(key, tone[key]);
        }
        var strong = root.querySelector(".content strong");
        var span = root.querySelector(".content span");
        if (strong) strong.textContent = name;
        if (span) span.textContent = detail;
      }
    })();
  </script>

  <!--
    Timeline integration:
    tl.to('.hf-transition-skeleton-reveal .skeleton', { backgroundPosition: '100% 0', duration: 0.7, ease: 'none' }, startTime); tl.to('.hf-transition-skeleton-reveal .skeleton', { opacity: 0, duration: 0.22 }, startTime + 0.72); tl.to('.hf-transition-skeleton-reveal .content', { opacity: 1, duration: 0.24 }, startTime + 0.78);
  -->
  ```
</Accordion>

## Usage

Open `compositions/components/skeleton-reveal.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.

Tagged `video-primitive` `transition-primitive` `transitions-dev-port` `skeleton` `reveal`.

## Related topics

* [Browse the complete Catalog](/catalog)
* [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
* [Build a richer composition](/go-further)


## Related topics

- [Data and maps](/prompting/data-and-maps.md)
- [Panel Reveal](/catalog/components/panel-reveal.md)
- [Scramble Reveal](/catalog/components/scramble-reveal.md)
