> ## Documentation Index
> Fetch the complete documentation index at: https://hyperframes-fix-nested-composition-media-inpoint.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shimmer Sweep

> Animated light sweep across text or elements using a CSS gradient mask — ideal for AI accents and premium reveals

export const InstallCommand = ({command, item}) => {
  const [copied, setCopied] = React.useState(false);
  const [tuned, setTuned] = React.useState("");
  React.useEffect(() => {
    if (!item) return;
    const read = () => {
      try {
        const raw = new URLSearchParams(window.location.search).get(`vars-${item}`);
        if (!raw) return setTuned("");
        const parsed = JSON.parse(raw);
        if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return setTuned("");
        if (Object.keys(parsed).length === 0) return setTuned("");
        setTuned(` --vars '${JSON.stringify(parsed)}'`);
      } catch {
        setTuned("");
      }
    };
    read();
    window.addEventListener("hf-vars-changed", read);
    window.addEventListener("popstate", read);
    return () => {
      window.removeEventListener("hf-vars-changed", read);
      window.removeEventListener("popstate", read);
    };
  }, [item]);
  const fullCommand = `${command}${tuned}`;
  const copy = async () => {
    try {
      if (navigator.clipboard && window.isSecureContext) {
        await navigator.clipboard.writeText(fullCommand);
      } else {
        const previous = document.activeElement;
        const scratch = document.createElement("textarea");
        scratch.value = fullCommand;
        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">
        {fullCommand}
      </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="shimmer-sweep 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/shimmer-sweep.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/shimmer-sweep.png");document.body.appendChild(p)});<\/script></body></html>`} />

## Install

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

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

## Source

<Accordion title={`shimmer-sweep.html`}>
  ```html theme={null}
  <!--
    Shimmer Sweep — animated light pass across text or elements.

    Usage: place this snippet AFTER your .shimmer-sweep-target elements.
    Wrap your text element with class="shimmer-sweep-target" and
    paste this snippet into your composition. The GSAP timeline drives
    the sweep position for deterministic frame-by-frame rendering.

    Customize:
    - --shimmer-color: highlight color (default rgba(255,255,255,0.6))
    - --shimmer-width: highlight band width as % (default 20%)
    - --shimmer-angle: sweep angle (default 120deg)
    - Timeline duration/ease: adjust in the script below
  -->

  <style>
    .shimmer-sweep-target {
      position: relative;
      display: inline-block;
    }

    .shimmer-sweep-target .shimmer-mask {
      position: absolute;
      top: 0;
      left: 0;
      width: 100%;
      height: 100%;
      pointer-events: none;
      background: linear-gradient(
        var(--shimmer-angle, 120deg),
        transparent 0%,
        transparent calc(var(--shimmer-pos, -20%) - var(--shimmer-width, 20%) / 2),
        var(--shimmer-color, rgba(255, 255, 255, 0.6)) var(--shimmer-pos, -20%),
        transparent calc(var(--shimmer-pos, -20%) + var(--shimmer-width, 20%) / 2),
        transparent 100%
      );
      mix-blend-mode: overlay;
    }
  </style>

  <script>
    (function () {
      // Auto-inject .shimmer-mask into every .shimmer-sweep-target
      document.querySelectorAll(".shimmer-sweep-target").forEach((el) => {
        if (!el.querySelector(".shimmer-mask")) {
          const mask = document.createElement("div");
          mask.className = "shimmer-mask";
          el.appendChild(mask);
        }
      });
    })();
  </script>

  <!--
    Timeline integration example (add to your composition's GSAP timeline):

    // Single sweep from left to right
    tl.fromTo(".shimmer-sweep-target", {
      "--shimmer-pos": "-20%",
    }, {
      "--shimmer-pos": "120%",
      duration: 1.2,
      ease: "power2.inOut",
      stagger: 0.15,
    }, startTime);
  -->
  ```
</Accordion>

## Usage

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

Tagged `text` `shimmer` `highlight` `effect`.

## Related topics

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