> ## 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.

# Text Shimmer

> A static headline receives one clean specular gradient sweep through its glyphs, then returns to its ordinary text color.

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="text-shimmer 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/text-shimmer.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/text-shimmer.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

<InstallCommand command="npx hyperframes add text-shimmer" />

That writes one file: `compositions/components/text-shimmer.html`.

## Paste it into your composition

Open `compositions/components/text-shimmer.html` and copy what is inside into your own composition.

A component has no size or duration of its own. It takes both from the composition
you paste it into.

## 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                                |
| ---------- | ------------ | ------------------------- | ------------------------------------------- |
| `text`     | `Effortless` | string                    | Text receiving the single shimmer pass.     |
| `accent`   | `green`      | `green`, `blue`, `violet` | Hue of the specular shimmer band.           |
| `sweep_at` | `1.2`        | 0.2s to 2s, step 0.1s     | Requested start time for the shimmer sweep. |

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="text-shimmer"
  data-composition-src="compositions/components/text-shimmer.html"
  data-variable-values='{"text":"Effortless","accent":"green","sweep_at":1.2}'
></div>
```

## Source

<Accordion title={`text-shimmer.html`}>
  ```html theme={null}
  <!doctype html>
  <!--
    text-shimmer: HyperFrames video primitive (text effects / drift / emphasize)

    Concept: a headline remains fixed while one narrow specular band crosses
    its glyphs. The text is clean before and after the pass. There is no
    entrance, exit, pulse, scale, or supporting decoration.

    Evidence: design-inspiration/INDEX.md and viral-micro-interactions.md,
    animated text shimmer by jhey Tan, adapted from an infinite CSS loop into
    one deterministic, seek-driven video beat.

    Variables:
      - text (string, default "Effortless"): headline copy.
      - accent (green | blue | violet, default green): shimmer hue.
      - sweep_at (number, 0.2 to 2 seconds, default 1.2): requested sweep start.

    Envelope: IN includes clean stillness until sweep_at, then one fixed 0.9s
    sweep. If the mounted duration is too short, the sweep starts earlier and
    compresses only when it cannot fit. HOLD is elastic and keeps the clean end
    state alive with an off-glyph drift. OUT is intentionally zero because the
    treatment returns to ordinary text rather than dismissing it.

    Mount contract: everything renderable lives inside the template. #root is
    elastic, fills the host box, establishes the container query basis, and has
    no data-width or data-height. The paused GSAP timeline registers under the
    hardcoded text-shimmer key.
  -->
  <html
    lang="en"
    data-composition-id="text-shimmer"
    data-composition-duration="3"
    data-composition-variables='[
      { "id": "text", "type": "string", "role": "content", "label": "Headline", "description": "Text receiving the single shimmer pass.", "default": "Effortless" },
      { "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Hue of the specular shimmer band.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
      { "id": "sweep_at", "type": "number", "role": "timing", "label": "Sweep start", "description": "Requested start time for the shimmer sweep.", "default": 1.2, "min": 0.2, "max": 2, "step": 0.1, "unit": "s" }
    ]'
  >
    <head>
      <meta charset="UTF-8" />
      <title>Text Shimmer</title>
    </head>
    <body>
      <template>
        <div id="root" data-composition-id="text-shimmer" data-duration="3" data-fps="30">
          <style>
            *,
            *::before,
            *::after {
              box-sizing: border-box;
            }

            #root {
              position: absolute;
              inset: 0;
              container-type: size;
              isolation: isolate;
              overflow: hidden;
              background: var(--bg, transparent);
              color: var(--fg, #f8fafc);
              font-family: var(--font-display, Inter, system-ui, sans-serif);
              pointer-events: none;
            }

            .ts-clip {
              position: absolute;
              inset: 0;
              display: grid;
              place-items: center;
              overflow: hidden;
              padding: var(--space-3, 4cqmin);
              background: var(--surface, transparent);
            }

            .ts-headline {
              --ts-base: var(--fg, #f8fafc);
              --ts-accent: var(--brand, #22c55e);
              display: block;
              max-width: 90cqw;
              color: transparent;
              font-size: clamp(28px, 16cqmin, 176px);
              font-weight: 780;
              line-height: 0.96;
              letter-spacing: -0.055em;
              overflow-wrap: anywhere;
              text-align: center;
              background-image: linear-gradient(
                110deg,
                var(--ts-base) 0%,
                var(--ts-base) 40%,
                color-mix(in srgb, var(--ts-accent) 58%, var(--fg, white)) 47%,
                var(--fg, white) 50%,
                color-mix(in srgb, var(--ts-accent) 72%, var(--fg, white)) 53%,
                var(--ts-base) 60%,
                var(--ts-base) 100%
              );
              background-position: 100% 50%;
              background-repeat: no-repeat;
              background-size: 300% 100%;
              background-clip: text;
              -webkit-background-clip: text;
              -webkit-text-fill-color: transparent;
              will-change: background-position;
            }
          </style>

          <div
            id="text-shimmer-clip"
            class="ts-clip clip"
            data-start="0"
            data-duration="3"
            data-track-index="0"
          >
            <span class="ts-headline"></span>
          </div>

          <script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
          <script>
            (function () {
              "use strict";

              var root = document.getElementById("root");
              var headline = root.querySelector(".ts-headline");
              var vars =
                window.__hyperframes && window.__hyperframes.getVariables
                  ? window.__hyperframes.getVariables()
                  : {};

              var text = vars.text == null ? "Effortless" : String(vars.text);
              var accent = vars.accent === "blue" || vars.accent === "violet" ? vars.accent : "green";
              var accentTokens = {
                green: "var(--brand, #22c55e)",
                blue: "var(--accent, #38bdf8)",
                violet: "var(--accent-2, #a78bfa)",
              };
              var accentColor = accentTokens[accent];
              var sweepAtValue = vars.sweep_at;
              var sweepAt =
                typeof sweepAtValue === "number" && Number.isFinite(sweepAtValue)
                  ? Math.max(0.2, Math.min(2, sweepAtValue))
                  : 1.2;

              headline.textContent = text;
              headline.style.setProperty("--ts-accent", accentColor);

              var SWEEP_BASE = 0.9;
              var durationValue = parseFloat(root.dataset.duration || "3");
              var duration = Number.isFinite(durationValue) ? Math.max(0.001, durationValue) : 3;
              var SWEEP = Math.min(SWEEP_BASE, duration);
              var SWEEP_START = Math.min(sweepAt, Math.max(0, duration - SWEEP));
              var IN = SWEEP_START + SWEEP;
              var HOLD = Math.max(0, duration - IN);

              var tl = gsap.timeline({ paused: true });
              tl.fromTo(
                headline,
                { backgroundPosition: "100% 50%" },
                { backgroundPosition: "0% 50%", duration: SWEEP, ease: "sine.inOut" },
                SWEEP_START,
              );

              if (HOLD > 0) {
                tl.to(
                  headline,
                  { backgroundPosition: "4% 50%", duration: HOLD, ease: "sine.inOut" },
                  IN,
                );
              }

              tl.seek(0);
              window.__timelines = window.__timelines || {};
              window.__timelines["text-shimmer"] = tl;
            })();
          </script>
        </div>
      </template>
    </body>
  </html>
  ```
</Accordion>

Tagged `motion-primitive` `text-effects` `shimmer` `specular` `emphasis`.

## 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

- [Shimmer Sweep](/catalog/components/shimmer-sweep.md)
- [VFX and liquid glass](/prompting/vfx-and-liquid-glass.md)
- [Text Stagger](/catalog/components/text-stagger.md)
