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.
224 lines
9.9 KiB
Plaintext
224 lines
9.9 KiB
Plaintext
---
|
|
title: "Slot Machine Roll"
|
|
description: "A vertical reel scrolls characters from one value to another."
|
|
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>Slot Machine Roll</h1>
|
|
<p>A vertical reel scrolls characters from one value to another.</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/slot-machine-roll.json"
|
|
compositionId="slot-machine-roll"
|
|
compositionSrc="compositions/components/slot-machine-roll.html"
|
|
title="Slot Machine Roll"
|
|
variables={[{"id":"result","type":"string","role":"content","label":"Result","description":"Characters the reels land on, one reel column per character. Whitespace is stripped and every reel starts on a zero.","default":"A7K"},{"id":"direction","type":"enum","role":"motion","label":"Direction","description":"Which way the reels roll: up lifts the zero out through the top, down drops it out through the bottom.","default":"up","options":[{"value":"up","label":"Up"},{"value":"down","label":"Down"}]},{"id":"size","type":"enum","role":"layout","label":"Size","description":"Reel height and type size. The roll distance scales with it so the reel always lands exactly one row on.","default":"standard","options":[{"value":"small","label":"Small"},{"value":"standard","label":"Standard"},{"value":"large","label":"Large"}]},{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Character 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":136}}
|
|
attribution={{"path":"registry/components/slot-machine-roll","tags":["video-primitive","motion-primitive","typography"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/slot-machine-roll/slot-machine-roll.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```html slot-machine-roll.html
|
|
<!--
|
|
Slot Machine Roll - 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 as a custom property
|
|
the CSS below consumes. The timeline recipe stays untouched by them: it keeps
|
|
driving one vertical offset of exactly one row, and these decide how tall that
|
|
row is, which way it travels and what it lands on.
|
|
|
|
- result (text, default "A7K"): the characters the reels land on, one reel
|
|
column per character. Whitespace is stripped, and blank or non-text input
|
|
falls back to the default three. Every reel starts on a zero.
|
|
- direction (up | down, default up): which way the reels roll. up lifts the
|
|
zero out through the top, down drops it out through the bottom.
|
|
- size (small | standard | large, default standard): reel height and type
|
|
size, 48px, 74px or 104px. The roll distance is scaled by the same factor,
|
|
so whatever the size the reel still lands exactly one row on.
|
|
- tone (ink | paper | accent, default ink): character 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: three 74px reels in
|
|
near-black rolling 0 up to A, 7 and K.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-slot-machine-roll"
|
|
data-composition-variables='[
|
|
{ "id": "result", "type": "string", "role": "content", "label": "Result", "description": "Characters the reels land on, one reel column per character. Whitespace is stripped and every reel starts on a zero.", "default": "A7K" },
|
|
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Which way the reels roll: up lifts the zero out through the top, down drops it out through the bottom.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
|
|
{ "id": "size", "type": "enum", "role": "layout", "label": "Size", "description": "Reel height and type size. The roll distance scales with it so the reel always lands exactly one row on.", "default": "standard", "options": [{ "value": "small", "label": "Small" }, { "value": "standard", "label": "Standard" }, { "value": "large", "label": "Large" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Character 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
|
|
><i>0<br />A</i></span
|
|
><span
|
|
><i>0<br />7</i></span
|
|
><span
|
|
><i>0<br />K</i></span
|
|
>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-slot-machine-roll {
|
|
color: var(--hf-slot-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-slot-machine-roll {
|
|
display: inline-flex;
|
|
gap: 6px;
|
|
height: var(--hf-slot-row, 74px);
|
|
overflow: hidden;
|
|
font:
|
|
900 var(--hf-slot-row, 74px)/1 ui-monospace,
|
|
SFMono-Regular,
|
|
Menlo,
|
|
monospace;
|
|
}
|
|
.hf-catalog-slot-machine-roll span {
|
|
display: block;
|
|
height: var(--hf-slot-row, 74px);
|
|
overflow: hidden;
|
|
}
|
|
.hf-catalog-slot-machine-roll i {
|
|
display: block;
|
|
font-style: normal;
|
|
transform: translateY(
|
|
calc(
|
|
var(--hf-slot-base, 0px) + var(--hf-slot-y, 0px) * var(--hf-slot-dir, 1) *
|
|
var(--hf-slot-gain, 1)
|
|
)
|
|
);
|
|
}
|
|
</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 directions = { up: 1, down: -1 };
|
|
var sizes = { small: 48, standard: 74, large: 104 };
|
|
var tones = {
|
|
ink: "#18181b",
|
|
paper: "#fafafa",
|
|
accent: "var(--brand, #34d399)",
|
|
};
|
|
|
|
var dir = directions[pick(directions, vars.direction, "up")];
|
|
var row = sizes[pick(sizes, vars.size, "standard")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
var result = (typeof vars.result === "string" ? vars.result : "").replace(/\s+/g, "");
|
|
if (result.length === 0) result = "A7K";
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-slot-machine-roll");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
var root = roots[i];
|
|
root.style.setProperty("--hf-slot-row", row + "px");
|
|
root.style.setProperty("--hf-slot-gain", String(row / 74));
|
|
root.style.setProperty("--hf-slot-dir", String(dir));
|
|
// Rolling down starts one row up, so the zero still sits in frame at rest.
|
|
root.style.setProperty("--hf-slot-base", (dir === 1 ? 0 : -row) + "px");
|
|
root.style.setProperty("--hf-slot-color", tone);
|
|
root.textContent = "";
|
|
for (var j = 0; j < result.length; j += 1) {
|
|
var reel = document.createElement("i");
|
|
reel.appendChild(document.createTextNode(dir === 1 ? "0" : result.charAt(j)));
|
|
reel.appendChild(document.createElement("br"));
|
|
reel.appendChild(document.createTextNode(dir === 1 ? result.charAt(j) : "0"));
|
|
var slot = document.createElement("span");
|
|
slot.appendChild(reel);
|
|
root.appendChild(slot);
|
|
}
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-slot-machine-roll i', { '--hf-slot-y': '0px' }, { '--hf-slot-y': '-74px', duration: 0.52, stagger: 0.06, ease: 'power3.inOut' }, startTime);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add slot-machine-roll" item="slot-machine-roll" />
|
|
|
|
That writes one file: `compositions/components/slot-machine-roll.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/slot-machine-roll.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 |
|
|
| --- | --- | --- | --- |
|
|
| `result` | `A7K` | string | Characters the reels land on, one reel column per character. Whitespace is stripped and every reel starts on a zero. |
|
|
| `direction` | `up` | `up`, `down` | Which way the reels roll: up lifts the zero out through the top, down drops it out through the bottom. |
|
|
| `size` | `standard` | `small`, `standard`, `large` | Reel height and type size. The roll distance scales with it so the reel always lands exactly one row on. |
|
|
| `tone` | `ink` | `ink`, `paper`, `accent` | Character 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="slot-machine-roll"
|
|
data-composition-src="compositions/components/slot-machine-roll.html"
|
|
data-variable-values='{"result":"A7K","direction":"up","size":"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>
|