Files
hyperframes/docs/catalog/components/scramble-reveal.mdx
T
Ular Kimsanov a06fdfe26e docs(catalog): put each item page's title, description and Docs text in the server HTML (#6711)
* docs(catalog): put each item page's title, description and Docs text in the server HTML

Mintlify renders snippet components in the browser only, so everything inside
CatalogDetail (title, standfirst, the Docs tab) was missing from the HTML search
engines read: 448 catalog pages served Googlebot no body text. The generator now
writes the H1 and standfirst as page markup above the component and the Docs tab
as page markup after it, shown with that tab (docs/custom.css). The component no
longer draws its own title. Pages patched structurally only; registry drift on 14
pages is left for a regeneration of its own.

* docs(catalog): keep the title's top spacing the component gave it

* fix(docs): catalog titles and descriptions keep markdown markers literal

MDX reads text inside the static <h1> and <p> as inline markdown, so @_blue_sweater_
rendered as italic blue_sweater. mdxText now writes backslash, backtick, * _ [ ] ~ as
character references too, with a unit test; the four affected pages are re-escaped.
2026-10-30 15:48:25 +00:00

376 lines
16 KiB
Plaintext

---
title: "Scramble Reveal"
description: "A deterministic hacker-style text reveal that cycles fixed glyph rows and locks the target string from left to right."
mode: "frame"
---
import { CatalogDetail, CatalogSlot } from "/snippets/catalog-detail.jsx";
import { InstallCommand } from "/snippets/install-command.jsx";
<div className="hf-ve-static-head not-prose">
<h1>Scramble Reveal</h1>
<p>A deterministic hacker-style text reveal that cycles fixed glyph rows and locks the target string from left to right.</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/scramble-reveal.json"
compositionId="scramble-reveal"
compositionSrc="compositions/components/scramble-reveal.html"
title="Scramble Reveal"
variables={[{"id":"text","type":"string","role":"content","label":"Text","description":"Target string that resolves from deterministic wrong glyphs.","default":"HYPERFRAMES"},{"id":"accent","type":"enum","role":"style","label":"Accent","description":"Color used by the text, prefix, and optional terminal frame.","default":"green","options":[{"value":"green","label":"Green"},{"value":"blue","label":"Blue"},{"value":"violet","label":"Violet"}]},{"id":"style","type":"enum","role":"style","label":"Style","description":"Terminal frame or clean text-only presentation.","default":"terminal","options":[{"value":"terminal","label":"Terminal"},{"value":"clean","label":"Clean"}]},{"id":"exit","type":"enum","role":"timing","label":"Exit","description":"Optional departure. Default none: the locked string holds until the frame cuts.","default":"none","options":[{"value":"none","label":"None"},{"value":"fade","label":"Fade"},{"value":"up","label":"Up"}]}]}
meta={{"category":"Typography & Text","badge":"Stable","codeLines":289}}
attribution={{"path":"registry/components/scramble-reveal","tags":["motion-primitive","text-effects","scramble","reveal","deterministic"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/scramble-reveal/scramble-reveal.html"
>
<CatalogSlot slot="code">
```html scramble-reveal.html
<!doctype html>
<!--
scramble-reveal: HyperFrames video primitive (text effects / reveal)
A target string begins as deterministic wrong glyphs, then resolves one
character at a time from left to right. Every visible frame comes from one
fixed-seed LCG table built before the timeline is registered.
Variables:
- text (string, default "HYPERFRAMES"): the target string.
- accent (green | blue | violet, default "green"): text and frame color.
- style (terminal | clean, default "terminal"): optional terminal frame.
- exit (none | fade | up, default "none"): optional departure.
Envelope, fixed IN and OUT with elastic HOLD only:
IN_BASE = 1.65s, curved arrival and the complete left-to-right lock
HOLD = max(0, D - IN - OUT), subtle drift followed by 0.30s stillness
OUT_BASE = 0.45s departure when exit is fade or up, 0s when exit is
none (the default: the locked string holds until the cut)
If D is shorter than IN_BASE + OUT_BASE, IN and OUT compress together.
The timeline is never time-scaled.
Determinism: frameTable is computed exactly once during synchronous
timeline construction from fixed LCG seed 0x27c0ffee. Timeline sets only
read authored rows from that table, so repeated or reverse seeks produce
the same string for the same time.
Mount contract: the runtime clones only this template. #root fills the host
box, establishes the container query basis, has no data-width or data-height,
and registers one paused timeline under the literal scramble-reveal key.
-->
<html
lang="en"
data-composition-id="scramble-reveal"
data-composition-duration="3"
data-composition-variables='[
{ "id": "text", "type": "string", "role": "content", "label": "Text", "description": "Target string that resolves from deterministic wrong glyphs.", "default": "HYPERFRAMES" },
{ "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Color used by the text, prefix, and optional terminal frame.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
{ "id": "style", "type": "enum", "role": "style", "label": "Style", "description": "Terminal frame or clean text-only presentation.", "default": "terminal", "options": [{ "value": "terminal", "label": "Terminal" }, { "value": "clean", "label": "Clean" }] },
{ "id": "exit", "type": "enum", "role": "timing", "label": "Exit", "description": "Optional departure. Default none: the locked string holds until the frame cuts.", "default": "none", "options": [{ "value": "none", "label": "None" }, { "value": "fade", "label": "Fade" }, { "value": "up", "label": "Up" }] }
]'
>
<head>
<meta charset="UTF-8" />
<title>Scramble Reveal</title>
</head>
<body>
<template>
<div id="root" data-composition-id="scramble-reveal" data-duration="3" data-fps="30">
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
#root {
position: absolute;
inset: 0;
overflow: hidden;
container-type: size;
isolation: isolate;
color: var(--fg, #f8fafc);
font-family: var(--font-mono, ui-monospace, "SF Mono", Menlo, Consolas, monospace);
pointer-events: none;
}
.sr-clip {
position: absolute;
inset: 0;
display: grid;
place-items: center;
overflow: hidden;
background: var(--bg, transparent);
}
.sr-stage {
display: block;
width: 88cqw;
max-width: 88cqw;
will-change: transform, opacity;
}
.sr-shell {
display: flex;
align-items: center;
justify-content: center;
width: 100%;
min-height: 34cqh;
padding: var(--space-3, 5cqh) var(--space-3, 5cqw);
overflow: hidden;
border: 0.16cqmin solid color-mix(in srgb, var(--sr-accent) 58%, var(--border, #475569));
border-radius: var(--radius, 2.4cqmin);
background: color-mix(in srgb, var(--surface, #0b1016) 92%, var(--sr-accent));
box-shadow:
0 3.5cqh 10cqh color-mix(in srgb, var(--bg, #000000) 42%, transparent),
inset 0 0 4cqh color-mix(in srgb, var(--sr-accent) 7%, transparent);
}
.sr-prefix {
flex: 0 0 auto;
margin-right: var(--space-1, 1.8cqw);
color: color-mix(in srgb, var(--sr-accent) 78%, var(--fg, #ffffff));
font-size: calc(var(--sr-font-size) * 0.74);
font-weight: 700;
line-height: 1;
opacity: 0.78;
}
.sr-text {
display: block;
min-width: 0;
overflow: hidden;
color: var(--sr-accent);
font-size: var(--sr-font-size);
font-weight: 780;
line-height: 1;
letter-spacing: 0.055em;
text-align: center;
text-shadow: 0 0 2.8cqh color-mix(in srgb, var(--sr-accent) 34%, transparent);
white-space: pre;
}
.sr-stage.sr-clean .sr-shell {
min-height: 26cqh;
padding: var(--space-2, 3cqh) var(--space-2, 2cqw);
border-color: transparent;
background: transparent;
box-shadow: none;
}
.sr-stage.sr-clean .sr-prefix {
display: none;
}
</style>
<div
id="scramble-reveal-clip"
class="sr-clip clip"
data-start="0"
data-duration="3"
data-track-index="0"
>
<div class="sr-stage" role="img">
<div class="sr-shell">
<span class="sr-prefix" aria-hidden="true">&gt;_</span>
<span class="sr-text" aria-hidden="true"></span>
</div>
</div>
</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 stage = root.querySelector(".sr-stage");
var textElement = root.querySelector(".sr-text");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
var text = vars.text == null ? "HYPERFRAMES" : String(vars.text);
// Each enum choice routes to a DIFFERENT contract token so the
// variable stays meaningful under a theme (green/blue/violet must
// not collapse into one themed accent).
var accentColors = {
green: "var(--brand, #71f5a7)",
blue: "var(--accent, #61a8ff)",
violet: "var(--accent-2, #c5a3ff)",
};
var accent = Object.prototype.hasOwnProperty.call(accentColors, vars.accent)
? vars.accent
: "green";
var style = vars.style === "clean" ? "clean" : "terminal";
var exit = vars.exit === "fade" || vars.exit === "up" ? vars.exit : "none";
root.style.setProperty("--sr-accent", accentColors[accent]);
stage.classList.toggle("sr-clean", style === "clean");
stage.setAttribute("aria-label", text);
var characters = Array.from(text);
var fittedCqw = Math.min(11, 118 / Math.max(1, characters.length));
root.style.setProperty("--sr-font-size", "min(" + fittedCqw.toFixed(3) + "cqw, 24cqh)");
var IN_BASE = 1.65;
var OUT_BASE = exit === "none" ? 0 : 0.45;
var ARRIVAL_BASE = 0.42;
var LOCK_TAIL_BASE = 0.15;
var STILLNESS = 0.3;
var FPS = 30;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "3"));
var totalBase = Math.max(0.001, IN_BASE + OUT_BASE);
var scale = duration < totalBase ? duration / totalBase : 1;
var IN = IN_BASE * scale;
var OUT = OUT_BASE * scale;
var ARRIVAL = ARRIVAL_BASE * scale;
var LOCK_TAIL = LOCK_TAIL_BASE * scale;
var HOLD = Math.max(0, duration - (IN + OUT));
var HOLD_START = IN;
var OUT_START = IN + HOLD;
var REVEAL_DURATION = Math.max(0, IN - LOCK_TAIL);
var lastFrame = Math.max(1, Math.round(REVEAL_DURATION * FPS));
// The LCG and all character-state decisions live here. This IIFE
// runs once before timeline construction, then only frameTable is
// read. Lock frames are monotonic by character index, so the final
// target resolves strictly from left to right.
var frameTable = (function () {
var glyphs = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789#$%&*+?<>";
var state = 0x27c0ffee;
var firstLockFrame = Math.min(lastFrame, Math.max(1, Math.round(0.2 * FPS * scale)));
var lockFrames = characters.map(function (character, index) {
if (/\s/.test(character)) return 0;
var position = characters.length <= 1 ? 1 : index / (characters.length - 1);
return Math.round(firstLockFrame + position * (lastFrame - firstLockFrame));
});
var rows = [];
for (var frame = 0; frame <= lastFrame; frame += 1) {
var row = characters
.map(function (character, index) {
if (/\s/.test(character) || frame >= lockFrames[index]) return character;
state = (Math.imul(1664525, state) + 1013904223) >>> 0;
var glyphIndex = state % glyphs.length;
var glyph = glyphs.charAt(glyphIndex);
if (glyph === character)
glyph = glyphs.charAt((glyphIndex + 1) % glyphs.length);
return glyph;
})
.join("");
rows.push(row);
}
return rows;
})();
gsap.set(stage, { opacity: 0, x: "-4cqw", y: "2.4cqh" });
textElement.textContent = frameTable[0];
var tl = gsap.timeline({ paused: true });
// IN: independently eased axes form the arrival arc. The authored
// frame rows then lock the target from left to right at 30 fps.
tl.to(stage, { opacity: 1, duration: ARRIVAL, ease: "power2.out" }, 0);
tl.to(stage, { x: "0cqw", duration: ARRIVAL, ease: "power3.out" }, 0);
tl.to(stage, { y: "0cqh", duration: ARRIVAL, ease: "sine.inOut" }, 0);
frameTable.forEach(function (row, frame) {
tl.set(textElement, { textContent: row }, frame / FPS);
});
// HOLD: finite drift ends with authored stillness before departure.
var driftHalf = Math.max(0, HOLD - STILLNESS) / 2;
if (driftHalf > 0) {
tl.to(
stage,
{
y: "-0.55cqh",
duration: driftHalf,
ease: "sine.inOut",
yoyo: true,
repeat: 1,
},
HOLD_START,
);
}
// OUT: optional departure; exit none holds until the frame cuts.
// The up exit keeps the original curved arc departure.
if (exit === "up") {
tl.to(stage, { x: "5cqw", duration: OUT, ease: "power2.in" }, OUT_START);
tl.to(stage, { y: "-3.5cqh", duration: OUT, ease: "sine.inOut" }, OUT_START);
tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
} else if (exit === "fade") {
tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
}
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines["scramble-reveal"] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add scramble-reveal" item="scramble-reveal" />
That writes one file: `compositions/components/scramble-reveal.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/scramble-reveal.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` | `HYPERFRAMES` | string | Target string that resolves from deterministic wrong glyphs. |
| `accent` | `green` | `green`, `blue`, `violet` | Color used by the text, prefix, and optional terminal frame. |
| `style` | `terminal` | `terminal`, `clean` | Terminal frame or clean text-only presentation. |
| `exit` | `none` | `none`, `fade`, `up` | Optional departure. Default none: the locked string holds until the frame cuts. |
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
<div
data-composition-id="scramble-reveal"
data-composition-src="compositions/components/scramble-reveal.html"
data-variable-values='{"text":"HYPERFRAMES","accent":"green","style":"terminal","exit":"none"}'
></div>
```
{/* hf:generated-footer */}
Tagged `motion-primitive` `text-effects` `scramble` `reveal` `deterministic`.
## Related topics
- [Browse the complete Catalog](/catalog)
- [Add assets and Catalog items in the browser editor](/studio/assets-and-blocks)
- [Put blocks together into one video](/concepts/compositions)
</div>