mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-08 15:57:01 +00:00
miga-heygenandMiguel Ángel
7b5fdb1ad2
The generated catalog pages rendered the "Source" accordion title as a
JSX expression, `<Accordion title={`name.html`}>`. Mintlify's search
indexer stringifies expression attribute nodes rather than evaluating
them, so every one of the 399 catalog pages surfaced its Source section
in search results as "[object Object]" (visible on the Scroll Feed page,
among others).
The template literal carried no escaping benefit: every title is a
single-segment `name.html` path, and a double-quoted JSX string handles
it directly. Introduce `mdxStringAttribute`, which emits a plain
`name="value"` attribute and escapes `& " < { }` as HTML character
references (MDX decodes references inside quoted attribute values, and
unlike JSON.stringify it does not rely on backslash escapes, which JSX
strings do not honour). Use it for both the Source accordion title and
the preview iframe title, and regenerate the catalog pages.
Regenerated with `npx tsx scripts/generate-catalog-pages.ts`; the only
change across the 399 pages is the one Accordion title line each.
Co-authored-by: Miguel Ángel <miguel.sierra@heygen.com>
265 lines
11 KiB
Plaintext
265 lines
11 KiB
Plaintext
---
|
|
title: "Shared Axis Z"
|
|
description: "Scale-based shared-axis transition for focus shifts and context depth."
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add shared-axis-z" item="shared-axis-z" />
|
|
|
|
That writes one file: `compositions/components/shared-axis-z.html`.
|
|
|
|
<VariablesExplorer
|
|
previewSrc="/public/catalog/components/shared-axis-z.json"
|
|
compositionId="shared-axis-z"
|
|
compositionSrc="compositions/components/shared-axis-z.html"
|
|
variables={[{"id":"direction","type":"enum","role":"motion","label":"Direction","description":"Which way the words travel along the z axis: in swells up from small, out settles down from large.","default":"in","options":[{"value":"in","label":"In"},{"value":"out","label":"Out"}]},{"id":"depth","type":"enum","role":"motion","label":"Depth","description":"Scales how far the words start from their final size, so the push covers a shorter or longer run in the same time.","default":"standard","options":[{"value":"shallow","label":"Shallow"},{"value":"standard","label":"Standard"},{"value":"deep","label":"Deep"}]},{"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"}]}]}
|
|
>
|
|
|
|
```html shared-axis-z.html
|
|
<!--
|
|
Shared Axis Z - 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 scale from 0.72 to 1, and these decide how far from the
|
|
final size that start really sits. At rest the scale is 1, so every setting
|
|
lands on the same final frame.
|
|
|
|
- direction (in | out, default in): which way the words travel along the
|
|
z axis. in swells up from a smaller start, out settles down from a
|
|
larger one.
|
|
- depth (shallow | standard | deep, default standard): scales the gap
|
|
between the start size and the final size. shallow covers half the run,
|
|
deep 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 swell from
|
|
0.72 to full size in near-black.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-shared-axis-z"
|
|
data-composition-variables='[
|
|
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Which way the words travel along the z axis: in swells up from small, out settles down from large.", "default": "in", "options": [{ "value": "in", "label": "In" }, { "value": "out", "label": "Out" }] },
|
|
{ "id": "depth", "type": "enum", "role": "motion", "label": "Depth", "description": "Scales how far the words start from their final size, so the push covers a shorter or longer run in the same time.", "default": "standard", "options": [{ "value": "shallow", "label": "Shallow" }, { "value": "standard", "label": "Standard" }, { "value": "deep", "label": "Deep" }] },
|
|
{ "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>Zoom</span><span>context</span>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-shared-axis-z {
|
|
color: var(--hf-word-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-shared-axis-z {
|
|
display: inline-flex;
|
|
gap: 12px;
|
|
font-size: 56px;
|
|
line-height: 1;
|
|
}
|
|
.hf-catalog-shared-axis-z span {
|
|
display: inline-block;
|
|
transform: translate(var(--hf-word-x, 0px), var(--hf-word-y, 0px))
|
|
scale(calc(1 + (var(--hf-word-scale, 1) - 1) * var(--hf-word-depth, 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 = { in: 1, out: -1 };
|
|
var reaches = { shallow: 0.5, standard: 1, deep: 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, "in")];
|
|
var reach = reaches[pick(reaches, vars.depth, "standard")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-shared-axis-z");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-word-depth", String(sign * reach));
|
|
roots[i].style.setProperty("--hf-word-color", tone);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-shared-axis-z span', { opacity: 0, '--hf-word-scale': 0.72 }, { opacity: 1, '--hf-word-scale': 1, duration: 0.34, stagger: 0.06, ease: 'back.out(1.8)' }, startTime);
|
|
-->
|
|
```
|
|
|
|
</VariablesExplorer>
|
|
|
|
## 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` | `in` | `in`, `out` | Which way the words travel along the z axis: in swells up from small, out settles down from large. |
|
|
| `depth` | `standard` | `shallow`, `standard`, `deep` | Scales how far the words start from their final size, so the push covers 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-z"
|
|
data-composition-src="compositions/components/shared-axis-z.html"
|
|
data-variable-values='{"direction":"in","depth":"standard","tone":"ink"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title="shared-axis-z.html">
|
|
|
|
```html
|
|
<!--
|
|
Shared Axis Z - 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 scale from 0.72 to 1, and these decide how far from the
|
|
final size that start really sits. At rest the scale is 1, so every setting
|
|
lands on the same final frame.
|
|
|
|
- direction (in | out, default in): which way the words travel along the
|
|
z axis. in swells up from a smaller start, out settles down from a
|
|
larger one.
|
|
- depth (shallow | standard | deep, default standard): scales the gap
|
|
between the start size and the final size. shallow covers half the run,
|
|
deep 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 swell from
|
|
0.72 to full size in near-black.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-shared-axis-z"
|
|
data-composition-variables='[
|
|
{ "id": "direction", "type": "enum", "role": "motion", "label": "Direction", "description": "Which way the words travel along the z axis: in swells up from small, out settles down from large.", "default": "in", "options": [{ "value": "in", "label": "In" }, { "value": "out", "label": "Out" }] },
|
|
{ "id": "depth", "type": "enum", "role": "motion", "label": "Depth", "description": "Scales how far the words start from their final size, so the push covers a shorter or longer run in the same time.", "default": "standard", "options": [{ "value": "shallow", "label": "Shallow" }, { "value": "standard", "label": "Standard" }, { "value": "deep", "label": "Deep" }] },
|
|
{ "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>Zoom</span><span>context</span>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-shared-axis-z {
|
|
color: var(--hf-word-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-shared-axis-z {
|
|
display: inline-flex;
|
|
gap: 12px;
|
|
font-size: 56px;
|
|
line-height: 1;
|
|
}
|
|
.hf-catalog-shared-axis-z span {
|
|
display: inline-block;
|
|
transform: translate(var(--hf-word-x, 0px), var(--hf-word-y, 0px))
|
|
scale(calc(1 + (var(--hf-word-scale, 1) - 1) * var(--hf-word-depth, 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 = { in: 1, out: -1 };
|
|
var reaches = { shallow: 0.5, standard: 1, deep: 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, "in")];
|
|
var reach = reaches[pick(reaches, vars.depth, "standard")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-shared-axis-z");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-word-depth", String(sign * reach));
|
|
roots[i].style.setProperty("--hf-word-color", tone);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-shared-axis-z span', { opacity: 0, '--hf-word-scale': 0.72 }, { opacity: 1, '--hf-word-scale': 1, duration: 0.34, stagger: 0.06, ease: 'back.out(1.8)' }, startTime);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/shared-axis-z.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `motion-primitive` `typography`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
|
- [Build a richer composition](/go-further)
|