Files
hyperframes/docs/catalog/components/shimmer-sweep.mdx
T
Miguel Ángel 9734578e60 feat(registry): bring back the video-primitive moves (#3169)
Restores the 208 catalog items reverted after their previews 404'd in
production, this time on the payload mechanism rather than the .html files
that caused the outage.

The generator no longer writes a preview document to docs/public. That writer,
and the machinery under it, existed only to produce files the docs host
discards, so it is gone rather than bypassed. Items now embed the composition
itself via a payload, which is what the previous change already does for the
items that were already in the catalog.

The variables explorer is parked, not restored: it drove its preview through
the same unpublished .html path, so it would have shown an empty frame. Items
that declare variables get the live player plus the static variables table, and
reconnecting the explorer to payloads is a follow-up.
2026-08-10 18:46:03 -04:00

109 lines
3.7 KiB
Plaintext

---
title: "Shimmer Sweep"
description: "Animated light sweep across text or elements using a CSS gradient mask — ideal for AI accents and premium reveals"
---
import { InstallCommand } from "/snippets/install-command.jsx";
<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" />
That writes one file: `compositions/components/shimmer-sweep.html`.
## Source
<Accordion title={`shimmer-sweep.html`}>
```html
<!--
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.
{/* hf:generated-footer */}
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)