Files
hyperframes/docs/catalog/components/per-word-crossfade.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

203 lines
9.4 KiB
Plaintext

---
title: "Per-Word Crossfade"
description: "Words gently fade into place with a short vertical drift for calm keynote rhythm."
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>Per-Word Crossfade</h1>
<p>Words gently fade into place with a short vertical drift for calm keynote rhythm.</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/per-word-crossfade.json"
compositionId="per-word-crossfade"
compositionSrc="compositions/components/per-word-crossfade.html"
title="Per-Word Crossfade"
variables={[{"id":"text","type":"string","role":"content","label":"Text","description":"The line to animate. It is split on whitespace and every word gets its own span, so the stagger picks up the new words.","default":"Create once reuse everywhere"},{"id":"drift","type":"enum","role":"motion","label":"Drift","description":"Scales the vertical offset, so the words cover a shorter or longer run in the same time.","default":"standard","options":[{"value":"close","label":"Close"},{"value":"standard","label":"Standard"},{"value":"far","label":"Far"}]},{"id":"blur","type":"enum","role":"style","label":"Blur","description":"Scales the blur radius the timeline drives, from a light haze to a full smear.","default":"standard","options":[{"value":"soft","label":"Soft"},{"value":"standard","label":"Standard"},{"value":"heavy","label":"Heavy"}]},{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Word colour: ink for light frames, paper for dark ones, accent rides --brand.","default":"ink","options":[{"value":"ink","label":"Ink"},{"value":"paper","label":"Paper"},{"value":"accent","label":"Accent"}]}]}
meta={{"category":"Typography & Text","badge":"Stable","codeLines":115}}
attribution={{"path":"registry/components/per-word-crossfade","tags":["motion-primitive","typography"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/per-word-crossfade/per-word-crossfade.html"
>
<CatalogSlot slot="code">
```html per-word-crossfade.html
<!--
Per-Word Crossfade - typography primitive for HyperFrames.
Paste the markup, CSS and script into a composition. Drive the timeline
integration from a paused GSAP timeline so renders remain deterministic.
Variables. The script reads each one, falls back to the declared default on
anything missing or unrecognised, and either rewrites the words or writes a
custom property the CSS below consumes. The timeline recipe at the end is
untouched by them: it keeps driving one offset and one blur, and these
decide what that offset and that blur mean on screen.
- text (string, default "Create once reuse everywhere"): the line to
animate. It is split on whitespace and every word gets its own span, so
the stagger picks up the new words with no other change.
- drift (close | standard | far, default standard): scales the vertical
offset. close covers half the run, far nearly double, in the same time.
- blur (soft | standard | heavy, default standard): scales the blur
radius, from a light haze to a full smear.
- tone (ink | paper | accent, default ink): word colour. ink is near-black
for light frames, paper near-white for dark ones, accent rides --brand.
On every default the result is identical to the original: four near-black
words drifting 22px up through a 5px blur.
-->
<div
class="hf-catalog-per-word-crossfade"
data-composition-variables='[
{ "id": "text", "type": "string", "role": "content", "label": "Text", "description": "The line to animate. It is split on whitespace and every word gets its own span, so the stagger picks up the new words.", "default": "Create once reuse everywhere" },
{ "id": "drift", "type": "enum", "role": "motion", "label": "Drift", "description": "Scales the vertical offset, so the words cover a shorter or longer run in the same time.", "default": "standard", "options": [{ "value": "close", "label": "Close" }, { "value": "standard", "label": "Standard" }, { "value": "far", "label": "Far" }] },
{ "id": "blur", "type": "enum", "role": "style", "label": "Blur", "description": "Scales the blur radius the timeline drives, from a light haze to a full smear.", "default": "standard", "options": [{ "value": "soft", "label": "Soft" }, { "value": "standard", "label": "Standard" }, { "value": "heavy", "label": "Heavy" }] },
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Word colour: ink for light frames, paper for dark ones, accent rides --brand.", "default": "ink", "options": [{ "value": "ink", "label": "Ink" }, { "value": "paper", "label": "Paper" }, { "value": "accent", "label": "Accent" }] }
]'
>
<span>Create</span><span>once</span><span>reuse</span><span>everywhere</span>
</div>
<style>
.hf-catalog-per-word-crossfade {
color: var(--hf-word-color, #18181b);
font-family: Inter, system-ui, sans-serif;
font-weight: 900;
letter-spacing: -0.04em;
}
.hf-catalog-per-word-crossfade {
display: inline-flex;
gap: 12px;
font-size: 56px;
line-height: 1;
}
.hf-catalog-per-word-crossfade span {
display: inline-block;
transform: translate(
var(--hf-word-x, 0px),
calc(var(--hf-word-y, 0px) * var(--hf-word-drift, 1))
)
scale(var(--hf-word-scale, 1));
filter: blur(calc(var(--hf-word-blur, 0px) * var(--hf-word-blur-scale, 1)));
will-change: transform, filter, opacity;
}
</style>
<script>
(function () {
"use strict";
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
// Unrecognised overrides return to their declared defaults.
var drifts = { close: 0.5, standard: 1, far: 1.85 };
var blurScales = { soft: 0.45, standard: 1, heavy: 2.2 };
var tones = {
ink: "#18181b",
paper: "#fafafa",
accent: "var(--brand, #34d399)",
};
function pick(table, value, fallback) {
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
}
var drift = drifts[pick(drifts, vars.drift, "standard")];
var blurScale = blurScales[pick(blurScales, vars.blur, "standard")];
var tone = tones[pick(tones, vars.tone, "ink")];
var text = typeof vars.text === "string" ? vars.text.trim() : "";
var words = (text || "Create once reuse everywhere").split(/\s+/);
var roots = document.querySelectorAll(".hf-catalog-per-word-crossfade");
for (var i = 0; i < roots.length; i += 1) {
var root = roots[i];
root.style.setProperty("--hf-word-drift", String(drift));
root.style.setProperty("--hf-word-blur-scale", String(blurScale));
root.style.setProperty("--hf-word-color", tone);
while (root.firstChild) {
root.removeChild(root.firstChild);
}
for (var w = 0; w < words.length; w += 1) {
var span = document.createElement("span");
span.textContent = words[w];
root.appendChild(span);
}
}
})();
</script>
<!--
Timeline integration:
tl.fromTo('.hf-catalog-per-word-crossfade span', { opacity: 0, '--hf-word-y': '22px', '--hf-word-scale': 0.92, '--hf-word-blur': '5px' }, { opacity: 1, '--hf-word-y': '0px', '--hf-word-scale': 1, '--hf-word-blur': '0px', duration: 0.3, stagger: 0.055, ease: 'power3.out' }, startTime);
-->
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add per-word-crossfade" item="per-word-crossfade" />
That writes one file: `compositions/components/per-word-crossfade.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/per-word-crossfade.html` and copy what is inside into your own composition.
The file opens with a comment header that walks you through it.
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` | `Create once reuse everywhere` | string | The line to animate. It is split on whitespace and every word gets its own span, so the stagger picks up the new words. |
| `drift` | `standard` | `close`, `standard`, `far` | Scales the vertical offset, so the words cover a shorter or longer run in the same time. |
| `blur` | `standard` | `soft`, `standard`, `heavy` | Scales the blur radius the timeline drives, from a light haze to a full smear. |
| `tone` | `ink` | `ink`, `paper`, `accent` | Word colour: ink for light frames, paper for dark ones, accent rides --brand. |
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="per-word-crossfade"
data-composition-src="compositions/components/per-word-crossfade.html"
data-variable-values='{"text":"Create once reuse everywhere","drift":"standard","blur":"standard","tone":"ink"}'
></div>
```
{/* hf:generated-footer */}
Tagged `motion-primitive` `typography`.
## 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>