mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 16:08:56 +00:00
* 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.
192 lines
8.2 KiB
Plaintext
192 lines
8.2 KiB
Plaintext
---
|
|
title: "Bottom Up Letters"
|
|
description: "Splits text into letters and reveals each glyph from below with deterministic staggered timing"
|
|
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>Bottom Up Letters</h1>
|
|
<p>Splits text into letters and reveals each glyph from below with deterministic staggered timing</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/bottom-up-letters.json"
|
|
compositionId="bottom-up-letters"
|
|
compositionSrc="compositions/components/bottom-up-letters.html"
|
|
title="Bottom Up Letters"
|
|
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"}]}]}
|
|
meta={{"category":"Typography & Text","badge":"Stable","codeLines":105}}
|
|
attribution={{"path":"registry/components/bottom-up-letters","tags":["motion-primitive","text","letters","reveal"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/bottom-up-letters/bottom-up-letters.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```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);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add bottom-up-letters" item="bottom-up-letters" />
|
|
|
|
That writes one file: `compositions/components/bottom-up-letters.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/bottom-up-letters.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 |
|
|
| --- | --- | --- | --- |
|
|
| `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>
|
|
```
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `motion-primitive` `text` `letters` `reveal`.
|
|
|
|
## 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>
|