mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 07:50:13 +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.
209 lines
8.9 KiB
Plaintext
209 lines
8.9 KiB
Plaintext
---
|
|
title: "Number Wheel"
|
|
description: "A rolling digit counter primitive for metrics, prices, counts, and scoreboards"
|
|
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>Number Wheel</h1>
|
|
<p>A rolling digit counter primitive for metrics, prices, counts, and scoreboards</p>
|
|
</div>
|
|
|
|
<CatalogDetail
|
|
previewSrc="/public/catalog/components/number-wheel.json"
|
|
compositionId="number-wheel"
|
|
compositionSrc="compositions/components/number-wheel.html"
|
|
title="Number Wheel"
|
|
variables={[{"id":"spin","type":"enum","role":"motion","label":"Spin","description":"How many full 0 to 9 revolutions each column adds before it lands, which is how far the reel travels in the same time.","default":"single","options":[{"value":"single","label":"Single"},{"value":"double","label":"Double"},{"value":"triple","label":"Triple"}]},{"id":"spacing","type":"enum","role":"layout","label":"Spacing","description":"Gap between the digit columns.","default":"standard","options":[{"value":"tight","label":"Tight"},{"value":"standard","label":"Standard"},{"value":"wide","label":"Wide"}]},{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Digit colour: inherit keeps the surrounding text colour, ink suits light frames, paper suits dark ones, accent rides --brand.","default":"inherit","options":[{"value":"inherit","label":"Inherit"},{"value":"ink","label":"Ink"},{"value":"paper","label":"Paper"},{"value":"accent","label":"Accent"}]}]}
|
|
meta={{"category":"Motion Primitives","badge":"Stable","codeLines":122}}
|
|
attribution={{"path":"registry/components/number-wheel","tags":["video-primitive","motion-primitive","number","counter","data"]}}
|
|
hasCode
|
|
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/number-wheel/number-wheel.html"
|
|
>
|
|
|
|
<CatalogSlot slot="code">
|
|
|
|
```html number-wheel.html
|
|
<!--
|
|
Number Wheel - rolling digit counter.
|
|
|
|
Markup:
|
|
<span class="hf-number-wheel" data-value="30222"></span>
|
|
|
|
Paste this snippet once. It builds one column per digit. Animate the generated
|
|
.hf-number-wheel-strip elements with the data-target-y custom property.
|
|
|
|
Variables. The script reads each one, falls back to the declared default on
|
|
anything missing or unrecognised, and either builds a longer strip or writes a
|
|
custom property the CSS above consumes. Every strip still starts on 0 and
|
|
still lands on its own digit, so only the run in between changes.
|
|
|
|
- spin (single | double | triple, default single): how many full 0 to 9
|
|
revolutions each column adds before it lands. Extra revolutions lengthen
|
|
the strip and push --hf-number-target-y further, so the reel covers more
|
|
ground in the same time. Nothing moves at rest, so this one only shows
|
|
once the timeline runs.
|
|
- spacing (tight | standard | wide, default standard): the gap between digit
|
|
columns.
|
|
- tone (inherit | ink | paper | accent, default inherit): digit colour.
|
|
inherit leaves the surrounding text colour alone, 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: one column per
|
|
digit, each rolling 0 up to its own digit in the inherited text colour.
|
|
-->
|
|
|
|
<style
|
|
data-composition-variables='[
|
|
{ "id": "spin", "type": "enum", "role": "motion", "label": "Spin", "description": "How many full 0 to 9 revolutions each column adds before it lands, which is how far the reel travels in the same time.", "default": "single", "options": [{ "value": "single", "label": "Single" }, { "value": "double", "label": "Double" }, { "value": "triple", "label": "Triple" }] },
|
|
{ "id": "spacing", "type": "enum", "role": "layout", "label": "Spacing", "description": "Gap between the digit columns.", "default": "standard", "options": [{ "value": "tight", "label": "Tight" }, { "value": "standard", "label": "Standard" }, { "value": "wide", "label": "Wide" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Digit colour: inherit keeps the surrounding text colour, ink suits light frames, paper suits dark ones, accent rides --brand.", "default": "inherit", "options": [{ "value": "inherit", "label": "Inherit" }, { "value": "ink", "label": "Ink" }, { "value": "paper", "label": "Paper" }, { "value": "accent", "label": "Accent" }] }
|
|
]'
|
|
>
|
|
.hf-number-wheel {
|
|
display: inline-flex;
|
|
align-items: baseline;
|
|
gap: var(--hf-wheel-gap, 0.02em);
|
|
color: var(--hf-wheel-color, inherit);
|
|
font-variant-numeric: tabular-nums;
|
|
}
|
|
.hf-number-wheel-digit {
|
|
display: inline-block;
|
|
height: 1em;
|
|
overflow: hidden;
|
|
}
|
|
.hf-number-wheel-strip {
|
|
display: grid;
|
|
transform: translateY(0em);
|
|
will-change: transform;
|
|
}
|
|
.hf-number-wheel-strip span {
|
|
height: 1em;
|
|
line-height: 1em;
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
const vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
const spins = { single: 0, double: 1, triple: 2 };
|
|
const gaps = { tight: "0em", standard: "0.02em", wide: "0.14em" };
|
|
const tones = {
|
|
inherit: "inherit",
|
|
ink: "#18181b",
|
|
paper: "#fafafa",
|
|
accent: "var(--brand, #34d399)",
|
|
};
|
|
const pick = (table, value, fallback) =>
|
|
Object.prototype.hasOwnProperty.call(table, value) ? table[value] : table[fallback];
|
|
|
|
const cycles = pick(spins, vars.spin, "single");
|
|
const gap = pick(gaps, vars.spacing, "standard");
|
|
const tone = pick(tones, vars.tone, "inherit");
|
|
|
|
document.querySelectorAll(".hf-number-wheel").forEach((el) => {
|
|
if (el.dataset.hfNumberWheelReady === "1") return;
|
|
el.style.setProperty("--hf-wheel-gap", gap);
|
|
el.style.setProperty("--hf-wheel-color", tone);
|
|
const value = el.dataset.value || "0";
|
|
el.textContent = "";
|
|
for (const char of value) {
|
|
if (!/\d/.test(char)) {
|
|
el.append(document.createTextNode(char));
|
|
continue;
|
|
}
|
|
const stops = cycles * 10 + Number(char);
|
|
const frame = document.createElement("span");
|
|
frame.className = "hf-number-wheel-digit";
|
|
const strip = document.createElement("span");
|
|
strip.className = "hf-number-wheel-strip";
|
|
strip.style.setProperty("--hf-number-target-y", `${-stops}em`);
|
|
for (let i = 0; i <= stops; i++) {
|
|
const step = document.createElement("span");
|
|
step.textContent = String(i % 10);
|
|
strip.appendChild(step);
|
|
}
|
|
frame.appendChild(strip);
|
|
el.appendChild(frame);
|
|
}
|
|
el.dataset.hfNumberWheelReady = "1";
|
|
});
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
|
|
tl.to(".hf-number-wheel-strip", {
|
|
y: (_, strip) => strip.style.getPropertyValue("--hf-number-target-y"),
|
|
duration: 1.1,
|
|
ease: "power3.out",
|
|
stagger: 0.05,
|
|
}, startTime);
|
|
-->
|
|
```
|
|
|
|
</CatalogSlot>
|
|
|
|
<CatalogSlot slot="install">
|
|
|
|
<InstallCommand command="npx hyperframes add number-wheel" item="number-wheel" />
|
|
|
|
That writes one file: `compositions/components/number-wheel.html`.
|
|
|
|
</CatalogSlot>
|
|
|
|
</CatalogDetail>
|
|
|
|
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/number-wheel.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 |
|
|
| --- | --- | --- | --- |
|
|
| `spin` | `single` | `single`, `double`, `triple` | How many full 0 to 9 revolutions each column adds before it lands, which is how far the reel travels in the same time. |
|
|
| `spacing` | `standard` | `tight`, `standard`, `wide` | Gap between the digit columns. |
|
|
| `tone` | `inherit` | `inherit`, `ink`, `paper`, `accent` | Digit colour: inherit keeps the surrounding text colour, ink suits light frames, paper suits 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="number-wheel"
|
|
data-composition-src="compositions/components/number-wheel.html"
|
|
data-variable-values='{"spin":"single","spacing":"standard","tone":"inherit"}'
|
|
></div>
|
|
```
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `video-primitive` `motion-primitive` `number` `counter` `data`.
|
|
|
|
## 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>
|