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.
199 lines
8.5 KiB
Plaintext
199 lines
8.5 KiB
Plaintext
---
|
|
title: "Top-Down Letters"
|
|
description: "Letters descend from above in a pronounced staircase with zero blur."
|
|
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>Top-Down Letters</h1>
|
|
<p>Letters descend from above in a pronounced staircase with zero blur.</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/top-down-letters.json"
|
|
compositionId="top-down-letters"
|
|
compositionSrc="compositions/components/top-down-letters.html"
|
|
title="Top-Down Letters"
|
|
variables={[{"id":"text","type":"string","role":"content","label":"Text","description":"Word that cascades in. Every character becomes one letter span, in source order.","default":"CASCADE"},{"id":"distance","type":"enum","role":"motion","label":"Distance","description":"Multiplies the drop the timeline drives, so the letters 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":"tone","type":"enum","role":"style","label":"Tone","description":"Letter 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":"Motion Primitives","badge":"Stable","codeLines":112}}
|
|
attribution={{"path":"registry/components/top-down-letters","tags":["video-primitive","motion-primitive","typography"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/top-down-letters/top-down-letters.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```html top-down-letters.html
|
|
<!--
|
|
Top-Down Letters - 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 writes the result either into the
|
|
markup or into a custom property the CSS above consumes. The timeline recipe
|
|
below is untouched by them: it keeps driving one offset per letter, and these
|
|
decide which letters fall, how far that offset carries them, and what colour
|
|
they are.
|
|
|
|
- text (string, default CASCADE): the word that cascades. Every character
|
|
becomes one span, in source order, exactly like the hand-written markup;
|
|
a space becomes a non-breaking space so it keeps its width in the flex
|
|
row. Anything that is not a non-empty string keeps the shipped word.
|
|
- distance (close | standard | far, default standard): multiplies the drop
|
|
the timeline drives, so the letters cover a shorter or longer run in the
|
|
same time. close covers half of it, standard leaves the shipped 42px
|
|
alone, far carries them nearly double.
|
|
- tone (ink | paper | accent, default ink): letter 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: the seven
|
|
near-black letters of CASCADE dropping 42px into place.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-top-down-letters"
|
|
data-composition-variables='[
|
|
{ "id": "text", "type": "string", "role": "content", "label": "Text", "description": "Word that cascades in. Every character becomes one letter span, in source order.", "default": "CASCADE" },
|
|
{ "id": "distance", "type": "enum", "role": "motion", "label": "Distance", "description": "Multiplies the drop the timeline drives, so the letters 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": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Letter 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>C</span><span>A</span><span>S</span><span>C</span><span>A</span><span>D</span><span>E</span>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-top-down-letters {
|
|
color: var(--hf-letters-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-top-down-letters {
|
|
display: inline-flex;
|
|
gap: 1px;
|
|
font-size: 74px;
|
|
line-height: 0.9;
|
|
overflow: hidden;
|
|
}
|
|
.hf-catalog-top-down-letters span {
|
|
display: inline-block;
|
|
transform: translateY(calc(var(--hf-char-y, 0px) * var(--hf-char-distance, 1)));
|
|
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.
|
|
var distances = { close: 0.5, standard: 1, far: 1.8 };
|
|
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 distance = distances[pick(distances, vars.distance, "standard")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
var text = typeof vars.text === "string" && vars.text !== "" ? vars.text : null;
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-top-down-letters");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
var root = roots[i];
|
|
root.style.setProperty("--hf-char-distance", String(distance));
|
|
root.style.setProperty("--hf-letters-color", tone);
|
|
|
|
// Only rebuild when text was supplied; the shipped markup is already the
|
|
// exact span-per-character output this branch produces for CASCADE.
|
|
if (text !== null) {
|
|
var characters = Array.from(text);
|
|
root.textContent = "";
|
|
for (var j = 0; j < characters.length; j += 1) {
|
|
var span = document.createElement("span");
|
|
span.textContent = characters[j] === " " ? "\u00a0" : characters[j];
|
|
root.appendChild(span);
|
|
}
|
|
root.setAttribute("aria-label", text);
|
|
}
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-top-down-letters span', { opacity: 0, '--hf-char-y': '-42px' }, { opacity: 1, '--hf-char-y': '0px', duration: 0.22, stagger: 0.035, ease: 'power3.out' }, startTime);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add top-down-letters" item="top-down-letters" />
|
|
|
|
That writes one file: `compositions/components/top-down-letters.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/top-down-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 |
|
|
| --- | --- | --- | --- |
|
|
| `text` | `CASCADE` | string | Word that cascades in. Every character becomes one letter span, in source order. |
|
|
| `distance` | `standard` | `close`, `standard`, `far` | Multiplies the drop the timeline drives, so the letters cover a shorter or longer run in the same time. |
|
|
| `tone` | `ink` | `ink`, `paper`, `accent` | Letter 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="top-down-letters"
|
|
data-composition-src="compositions/components/top-down-letters.html"
|
|
data-variable-values='{"text":"CASCADE","distance":"standard","tone":"ink"}'
|
|
></div>
|
|
```
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `video-primitive` `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>
|