mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-11 19:09:20 +00:00
miga-heygenandMiguel Ángel
7b5fdb1ad2
The generated catalog pages rendered the "Source" accordion title as a
JSX expression, `<Accordion title={`name.html`}>`. Mintlify's search
indexer stringifies expression attribute nodes rather than evaluating
them, so every one of the 399 catalog pages surfaced its Source section
in search results as "[object Object]" (visible on the Scroll Feed page,
among others).
The template literal carried no escaping benefit: every title is a
single-segment `name.html` path, and a double-quoted JSX string handles
it directly. Introduce `mdxStringAttribute`, which emits a plain
`name="value"` attribute and escapes `& " < { }` as HTML character
references (MDX decodes references inside quoted attribute values, and
unlike JSON.stringify it does not rely on backslash escapes, which JSX
strings do not honour). Use it for both the Source accordion title and
the preview iframe title, and regenerate the catalog pages.
Regenerated with `npx tsx scripts/generate-catalog-pages.ts`; the only
change across the 399 pages is the one Accordion title line each.
Co-authored-by: Miguel Ángel <miguel.sierra@heygen.com>
281 lines
12 KiB
Plaintext
281 lines
12 KiB
Plaintext
---
|
|
title: "Bottom Up Letters"
|
|
description: "Splits text into letters and reveals each glyph from below with deterministic staggered timing"
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add bottom-up-letters" item="bottom-up-letters" />
|
|
|
|
That writes one file: `compositions/components/bottom-up-letters.html`.
|
|
|
|
<VariablesExplorer
|
|
previewSrc="/public/catalog/components/bottom-up-letters.json"
|
|
compositionId="bottom-up-letters"
|
|
compositionSrc="compositions/components/bottom-up-letters.html"
|
|
variables={[{"id":"unit","type":"enum","role":"content","label":"Split unit","description":"What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact.","default":"letter","options":[{"value":"letter","label":"Letter"},{"value":"word","label":"Word"}]},{"id":"direction","type":"enum","role":"motion","label":"Direction","description":"Where each span starts. Up starts below the baseline and rises, down starts above and drops.","default":"up","options":[{"value":"up","label":"Up"},{"value":"down","label":"Down"}]},{"id":"travel","type":"enum","role":"motion","label":"Travel","description":"How far each span starts from its resting position, from 0.45em to 1.5em.","default":"standard","options":[{"value":"close","label":"Close"},{"value":"standard","label":"Standard"},{"value":"far","label":"Far"}]}]}
|
|
>
|
|
|
|
```html bottom-up-letters.html
|
|
<!--
|
|
Bottom Up Letters - deterministic text splitter.
|
|
|
|
Add class="hf-bottom-up-letters" to a plain text element. This script wraps
|
|
each character in a span so your paused GSAP timeline can stagger the reveal.
|
|
|
|
Variables. This fragment has no markup of its own, so the declaration rides
|
|
the <style> element below; the runtime collects every element carrying
|
|
data-composition-variables, not just the document root. The script reads each
|
|
value, falls back to the declared default on anything missing or
|
|
unrecognised, and either changes how the text is split or writes a custom
|
|
property the CSS consumes. The timeline recipe below is untouched by them: it
|
|
still tweens opacity and y back to rest, and these decide what a single
|
|
stagger step covers and where rest is travelled from.
|
|
|
|
- unit (letter | word, default letter): what each animated span holds.
|
|
letter staggers glyph by glyph; word keeps whole words intact, so a long
|
|
line reads instead of shimmers.
|
|
- direction (up | down, default up): where the spans start. up starts
|
|
below the baseline and rises into place, down starts above and drops.
|
|
- travel (close | standard | far, default standard): how far each span
|
|
starts from rest, from 0.45em through 0.85em to 1.5em.
|
|
|
|
On every default the result is identical to the original: one span per
|
|
character, each starting 0.85em below the baseline.
|
|
-->
|
|
|
|
<style
|
|
data-composition-variables='[
|
|
{ "id": "unit", "type": "enum", "role": "content", "label": "Split unit", "description": "What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact.", "default": "letter", "options": [{ "value": "letter", "label": "Letter" }, { "value": "word", "label": "Word" }] },
|
|
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Where each span starts. Up starts below the baseline and rises, down starts above and drops.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
|
|
{ "id": "travel", "type": "enum", "role": "motion", "label": "Travel", "description": "How far each span starts from its resting position, from 0.45em to 1.5em.", "default": "standard", "options": [{ "value": "close", "label": "Close" }, { "value": "standard", "label": "Standard" }, { "value": "far", "label": "Far" }] }
|
|
]'
|
|
>
|
|
.hf-bottom-up-letters {
|
|
display: inline-block;
|
|
}
|
|
.hf-bottom-up-letters-char {
|
|
display: inline-block;
|
|
opacity: 0;
|
|
transform: translate3d(
|
|
0,
|
|
calc(var(--hf-letters-travel, 0.85em) * var(--hf-letters-direction, 1)),
|
|
0
|
|
);
|
|
will-change: transform, opacity;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
var travels = { close: "0.45em", standard: "0.85em", far: "1.5em" };
|
|
var directions = { up: "1", down: "-1" };
|
|
var units = { letter: true, word: true };
|
|
|
|
var travel = travels[pick(travels, vars.travel, "standard")];
|
|
var direction = directions[pick(directions, vars.direction, "up")];
|
|
var unit = pick(units, vars.unit, "letter");
|
|
|
|
document.querySelectorAll(".hf-bottom-up-letters").forEach((el) => {
|
|
el.style.setProperty("--hf-letters-travel", travel);
|
|
el.style.setProperty("--hf-letters-direction", direction);
|
|
if (el.dataset.hfLettersReady === "1") return;
|
|
const text = el.textContent || "";
|
|
el.textContent = "";
|
|
const parts = unit === "word" ? text.split(/(\s+)/) : Array.from(text);
|
|
for (const part of parts) {
|
|
if (part === "") continue;
|
|
if (unit === "word" && /^\s+$/.test(part)) {
|
|
el.appendChild(document.createTextNode(part));
|
|
continue;
|
|
}
|
|
const span = document.createElement("span");
|
|
span.className = "hf-bottom-up-letters-char";
|
|
span.textContent = part === " " ? "\u00a0" : part;
|
|
el.appendChild(span);
|
|
}
|
|
el.dataset.hfLettersReady = "1";
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
|
|
tl.to(".hf-bottom-up-letters-char", {
|
|
opacity: 1,
|
|
y: 0,
|
|
duration: 0.48,
|
|
ease: "back.out(1.7)",
|
|
stagger: 0.025,
|
|
}, startTime);
|
|
-->
|
|
```
|
|
|
|
</VariablesExplorer>
|
|
|
|
## 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 |
|
|
| --- | --- | --- | --- |
|
|
| `unit` | `letter` | `letter`, `word` | What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact. |
|
|
| `direction` | `up` | `up`, `down` | Where each span starts. Up starts below the baseline and rises, down starts above and drops. |
|
|
| `travel` | `standard` | `close`, `standard`, `far` | How far each span starts from its resting position, from 0.45em to 1.5em. |
|
|
|
|
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="bottom-up-letters"
|
|
data-composition-src="compositions/components/bottom-up-letters.html"
|
|
data-variable-values='{"unit":"letter","direction":"up","travel":"standard"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title="bottom-up-letters.html">
|
|
|
|
```html
|
|
<!--
|
|
Bottom Up Letters - deterministic text splitter.
|
|
|
|
Add class="hf-bottom-up-letters" to a plain text element. This script wraps
|
|
each character in a span so your paused GSAP timeline can stagger the reveal.
|
|
|
|
Variables. This fragment has no markup of its own, so the declaration rides
|
|
the <style> element below; the runtime collects every element carrying
|
|
data-composition-variables, not just the document root. The script reads each
|
|
value, falls back to the declared default on anything missing or
|
|
unrecognised, and either changes how the text is split or writes a custom
|
|
property the CSS consumes. The timeline recipe below is untouched by them: it
|
|
still tweens opacity and y back to rest, and these decide what a single
|
|
stagger step covers and where rest is travelled from.
|
|
|
|
- unit (letter | word, default letter): what each animated span holds.
|
|
letter staggers glyph by glyph; word keeps whole words intact, so a long
|
|
line reads instead of shimmers.
|
|
- direction (up | down, default up): where the spans start. up starts
|
|
below the baseline and rises into place, down starts above and drops.
|
|
- travel (close | standard | far, default standard): how far each span
|
|
starts from rest, from 0.45em through 0.85em to 1.5em.
|
|
|
|
On every default the result is identical to the original: one span per
|
|
character, each starting 0.85em below the baseline.
|
|
-->
|
|
|
|
<style
|
|
data-composition-variables='[
|
|
{ "id": "unit", "type": "enum", "role": "content", "label": "Split unit", "description": "What each animated span holds. Letter staggers glyph by glyph, word keeps whole words intact.", "default": "letter", "options": [{ "value": "letter", "label": "Letter" }, { "value": "word", "label": "Word" }] },
|
|
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Where each span starts. Up starts below the baseline and rises, down starts above and drops.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
|
|
{ "id": "travel", "type": "enum", "role": "motion", "label": "Travel", "description": "How far each span starts from its resting position, from 0.45em to 1.5em.", "default": "standard", "options": [{ "value": "close", "label": "Close" }, { "value": "standard", "label": "Standard" }, { "value": "far", "label": "Far" }] }
|
|
]'
|
|
>
|
|
.hf-bottom-up-letters {
|
|
display: inline-block;
|
|
}
|
|
.hf-bottom-up-letters-char {
|
|
display: inline-block;
|
|
opacity: 0;
|
|
transform: translate3d(
|
|
0,
|
|
calc(var(--hf-letters-travel, 0.85em) * var(--hf-letters-direction, 1)),
|
|
0
|
|
);
|
|
will-change: transform, opacity;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
var travels = { close: "0.45em", standard: "0.85em", far: "1.5em" };
|
|
var directions = { up: "1", down: "-1" };
|
|
var units = { letter: true, word: true };
|
|
|
|
var travel = travels[pick(travels, vars.travel, "standard")];
|
|
var direction = directions[pick(directions, vars.direction, "up")];
|
|
var unit = pick(units, vars.unit, "letter");
|
|
|
|
document.querySelectorAll(".hf-bottom-up-letters").forEach((el) => {
|
|
el.style.setProperty("--hf-letters-travel", travel);
|
|
el.style.setProperty("--hf-letters-direction", direction);
|
|
if (el.dataset.hfLettersReady === "1") return;
|
|
const text = el.textContent || "";
|
|
el.textContent = "";
|
|
const parts = unit === "word" ? text.split(/(\s+)/) : Array.from(text);
|
|
for (const part of parts) {
|
|
if (part === "") continue;
|
|
if (unit === "word" && /^\s+$/.test(part)) {
|
|
el.appendChild(document.createTextNode(part));
|
|
continue;
|
|
}
|
|
const span = document.createElement("span");
|
|
span.className = "hf-bottom-up-letters-char";
|
|
span.textContent = part === " " ? "\u00a0" : part;
|
|
el.appendChild(span);
|
|
}
|
|
el.dataset.hfLettersReady = "1";
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
|
|
tl.to(".hf-bottom-up-letters-char", {
|
|
opacity: 1,
|
|
y: 0,
|
|
duration: 0.48,
|
|
ease: "back.out(1.7)",
|
|
stagger: 0.025,
|
|
}, startTime);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/bottom-up-letters.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `motion-primitive` `text` `letters` `reveal`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
|
- [Build a richer composition](/go-further)
|