Files
hyperframes/docs/catalog/components/shared-axis-y.mdx
T
Ular Kimsanov a06fdfe26e docs(catalog): put each item page's title, description and Docs text in the server HTML (#6711)
* 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.
2026-10-30 15:48:25 +00:00

185 lines
7.6 KiB
Plaintext

---
title: "Shared Axis Y"
description: "Per-word vertical shared-axis transition for sharp editorial swaps."
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>Shared Axis Y</h1>
<p>Per-word vertical shared-axis transition for sharp editorial swaps.</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/shared-axis-y.json"
compositionId="shared-axis-y"
compositionSrc="compositions/components/shared-axis-y.html"
title="Shared Axis Y"
variables={[{"id":"direction","type":"enum","role":"motion","label":"Direction","description":"Which side of the baseline the words travel in from.","default":"up","options":[{"value":"up","label":"Up"},{"value":"down","label":"Down"}]},{"id":"distance","type":"enum","role":"motion","label":"Distance","description":"Scales the vertical offset, so the words 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":"Word 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":"Typography & Text","badge":"Stable","codeLines":98}}
attribution={{"path":"registry/components/shared-axis-y","tags":["motion-primitive","typography"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/shared-axis-y/shared-axis-y.html"
>
<CatalogSlot slot="code">
```html shared-axis-y.html
<!--
Shared Axis Y - 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 above consumes. The timeline recipe below is untouched by them: it
keeps driving one vertical offset, and these decide what that offset means
on screen. At rest the offset is 0, so every setting lands on the same
final frame.
- direction (up | down, default up): which side of the baseline the words
travel in from. up rises into place, down drops in.
- distance (close | standard | far, default standard): scales the offset.
close covers half the run, far nearly double, in the same time.
- tone (ink | paper | accent, default ink): word 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: words rise 32px
into place in near-black.
-->
<div
class="hf-catalog-shared-axis-y"
data-composition-variables='[
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Which side of the baseline the words travel in from.", "default": "up", "options": [{ "value": "up", "label": "Up" }, { "value": "down", "label": "Down" }] },
{ "id": "distance", "type": "enum", "role": "motion", "label": "Distance", "description": "Scales the vertical offset, so the words 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": "Word 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>Plan</span><span>Debug</span><span>Ask</span>
</div>
<style>
.hf-catalog-shared-axis-y {
color: var(--hf-word-color, #18181b);
font-family: Inter, system-ui, sans-serif;
font-weight: 900;
letter-spacing: -0.04em;
}
.hf-catalog-shared-axis-y {
display: inline-flex;
gap: 12px;
font-size: 56px;
line-height: 1;
}
.hf-catalog-shared-axis-y span {
display: inline-block;
transform: translate(
var(--hf-word-x, 0px),
calc(var(--hf-word-y, 0px) * var(--hf-word-axis-y, 1))
)
scale(var(--hf-word-scale, 1));
filter: blur(var(--hf-word-blur, 0px));
will-change: transform, filter, opacity;
}
</style>
<script>
(function () {
"use strict";
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
// Unrecognised overrides return to their declared defaults.
var signs = { up: 1, down: -1 };
var reaches = { close: 0.5, standard: 1, far: 1.85 };
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 sign = signs[pick(signs, vars.direction, "up")];
var reach = reaches[pick(reaches, vars.distance, "standard")];
var tone = tones[pick(tones, vars.tone, "ink")];
var roots = document.querySelectorAll(".hf-catalog-shared-axis-y");
for (var i = 0; i < roots.length; i += 1) {
roots[i].style.setProperty("--hf-word-axis-y", String(sign * reach));
roots[i].style.setProperty("--hf-word-color", tone);
}
})();
</script>
<!--
Timeline integration:
tl.fromTo('.hf-catalog-shared-axis-y span', { opacity: 0, '--hf-word-y': '32px' }, { opacity: 1, '--hf-word-y': '0px', duration: 0.22, stagger: 0.075, ease: 'power2.out' }, startTime);
-->
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add shared-axis-y" item="shared-axis-y" />
That writes one file: `compositions/components/shared-axis-y.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/shared-axis-y.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 |
| --- | --- | --- | --- |
| `direction` | `up` | `up`, `down` | Which side of the baseline the words travel in from. |
| `distance` | `standard` | `close`, `standard`, `far` | Scales the vertical offset, so the words cover a shorter or longer run in the same time. |
| `tone` | `ink` | `ink`, `paper`, `accent` | Word 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="shared-axis-y"
data-composition-src="compositions/components/shared-axis-y.html"
data-variable-values='{"direction":"up","distance":"standard","tone":"ink"}'
></div>
```
{/* hf:generated-footer */}
Tagged `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>