mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-07 15:27:14 +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>
279 lines
12 KiB
Plaintext
279 lines
12 KiB
Plaintext
---
|
|
title: "Dynamic Grid"
|
|
description: "A responsive animated grid background driven by CSS variables for SaaS, code, and data scenes"
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add dynamic-grid" item="dynamic-grid" />
|
|
|
|
That writes one file: `compositions/components/dynamic-grid.html`.
|
|
|
|
<VariablesExplorer
|
|
previewSrc="/public/catalog/components/dynamic-grid.json"
|
|
compositionId="dynamic-grid"
|
|
compositionSrc="compositions/components/dynamic-grid.html"
|
|
variables={[{"id":"density","type":"enum","role":"style","label":"Density","description":"Cell size of the grid: fine reads as graph paper, coarse as a few large panels.","default":"standard","options":[{"value":"fine","label":"Fine"},{"value":"standard","label":"Standard"},{"value":"coarse","label":"Coarse"}]},{"id":"weight","type":"enum","role":"style","label":"Weight","description":"Thickness of the grid lines, from a hairline rule to a bold structural grid.","default":"hairline","options":[{"value":"hairline","label":"Hairline"},{"value":"standard","label":"Standard"},{"value":"bold","label":"Bold"}]},{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2.","default":"neutral","options":[{"value":"neutral","label":"Neutral"},{"value":"green","label":"Green"},{"value":"blue","label":"Blue"},{"value":"violet","label":"Violet"}]}]}
|
|
>
|
|
|
|
```html dynamic-grid.html
|
|
<!--
|
|
Dynamic Grid - animated background primitive.
|
|
|
|
Paste the grid as the first child of a scene. Animate --hf-grid-x,
|
|
--hf-grid-y, and --hf-grid-opacity from your paused GSAP timeline.
|
|
|
|
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 consumes. The timeline recipe below is untouched by them: it keeps
|
|
driving the scroll offset and the opacity.
|
|
|
|
- density (fine | standard | coarse, default standard): cell size of the
|
|
grid, 44px, 72px or 112px. fine reads as graph paper, coarse as a few
|
|
large panels.
|
|
- weight (hairline | standard | bold, default hairline): line thickness,
|
|
1px, 2px or 3px.
|
|
- tone (neutral | green | blue | violet, default neutral): line colour.
|
|
neutral is the translucent white the original ships with, and the three
|
|
accents ride --brand, --accent and --accent-2.
|
|
|
|
On every default the result is identical to the original: 72px cells drawn
|
|
in 1px translucent white lines.
|
|
-->
|
|
|
|
<div
|
|
class="hf-dynamic-grid"
|
|
aria-hidden="true"
|
|
data-composition-variables='[
|
|
{ "id": "density", "type": "enum", "role": "style", "label": "Density", "description": "Cell size of the grid: fine reads as graph paper, coarse as a few large panels.", "default": "standard", "options": [{ "value": "fine", "label": "Fine" }, { "value": "standard", "label": "Standard" }, { "value": "coarse", "label": "Coarse" }] },
|
|
{ "id": "weight", "type": "enum", "role": "style", "label": "Weight", "description": "Thickness of the grid lines, from a hairline rule to a bold structural grid.", "default": "hairline", "options": [{ "value": "hairline", "label": "Hairline" }, { "value": "standard", "label": "Standard" }, { "value": "bold", "label": "Bold" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2.", "default": "neutral", "options": [{ "value": "neutral", "label": "Neutral" }, { "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] }
|
|
]'
|
|
></div>
|
|
|
|
<style>
|
|
.hf-dynamic-grid {
|
|
--hf-grid-size: 72px;
|
|
--hf-grid-line: 1px;
|
|
--hf-grid-color: rgba(255, 255, 255, 0.16);
|
|
--hf-grid-x: 0px;
|
|
--hf-grid-y: 0px;
|
|
--hf-grid-opacity: 1;
|
|
position: absolute;
|
|
inset: 0;
|
|
pointer-events: none;
|
|
opacity: var(--hf-grid-opacity);
|
|
background-image:
|
|
linear-gradient(var(--hf-grid-color) var(--hf-grid-line), transparent var(--hf-grid-line)),
|
|
linear-gradient(
|
|
90deg,
|
|
var(--hf-grid-color) var(--hf-grid-line),
|
|
transparent var(--hf-grid-line)
|
|
);
|
|
background-size: var(--hf-grid-size) var(--hf-grid-size);
|
|
background-position: var(--hf-grid-x) var(--hf-grid-y);
|
|
}
|
|
</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 sizes = { fine: "44px", standard: "72px", coarse: "112px" };
|
|
var weights = { hairline: "1px", standard: "2px", bold: "3px" };
|
|
var tones = {
|
|
neutral: "rgba(255, 255, 255, 0.16)",
|
|
green: "color-mix(in srgb, var(--brand, #34d399) 34%, transparent)",
|
|
blue: "color-mix(in srgb, var(--accent, #38bdf8) 34%, transparent)",
|
|
violet: "color-mix(in srgb, var(--accent-2, #a78bfa) 34%, transparent)",
|
|
};
|
|
|
|
var size = sizes[pick(sizes, vars.density, "standard")];
|
|
var line = weights[pick(weights, vars.weight, "hairline")];
|
|
var color = tones[pick(tones, vars.tone, "neutral")];
|
|
|
|
var roots = document.querySelectorAll(".hf-dynamic-grid");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-grid-size", size);
|
|
roots[i].style.setProperty("--hf-grid-line", line);
|
|
roots[i].style.setProperty("--hf-grid-color", color);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
|
|
tl.to(".hf-dynamic-grid", {
|
|
"--hf-grid-x": "72px",
|
|
"--hf-grid-y": "-72px",
|
|
duration: 6,
|
|
ease: "none",
|
|
}, 0);
|
|
-->
|
|
```
|
|
|
|
</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 |
|
|
| --- | --- | --- | --- |
|
|
| `density` | `standard` | `fine`, `standard`, `coarse` | Cell size of the grid: fine reads as graph paper, coarse as a few large panels. |
|
|
| `weight` | `hairline` | `hairline`, `standard`, `bold` | Thickness of the grid lines, from a hairline rule to a bold structural grid. |
|
|
| `tone` | `neutral` | `neutral`, `green`, `blue`, `violet` | Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2. |
|
|
|
|
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="dynamic-grid"
|
|
data-composition-src="compositions/components/dynamic-grid.html"
|
|
data-variable-values='{"density":"standard","weight":"hairline","tone":"neutral"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title="dynamic-grid.html">
|
|
|
|
```html
|
|
<!--
|
|
Dynamic Grid - animated background primitive.
|
|
|
|
Paste the grid as the first child of a scene. Animate --hf-grid-x,
|
|
--hf-grid-y, and --hf-grid-opacity from your paused GSAP timeline.
|
|
|
|
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 consumes. The timeline recipe below is untouched by them: it keeps
|
|
driving the scroll offset and the opacity.
|
|
|
|
- density (fine | standard | coarse, default standard): cell size of the
|
|
grid, 44px, 72px or 112px. fine reads as graph paper, coarse as a few
|
|
large panels.
|
|
- weight (hairline | standard | bold, default hairline): line thickness,
|
|
1px, 2px or 3px.
|
|
- tone (neutral | green | blue | violet, default neutral): line colour.
|
|
neutral is the translucent white the original ships with, and the three
|
|
accents ride --brand, --accent and --accent-2.
|
|
|
|
On every default the result is identical to the original: 72px cells drawn
|
|
in 1px translucent white lines.
|
|
-->
|
|
|
|
<div
|
|
class="hf-dynamic-grid"
|
|
aria-hidden="true"
|
|
data-composition-variables='[
|
|
{ "id": "density", "type": "enum", "role": "style", "label": "Density", "description": "Cell size of the grid: fine reads as graph paper, coarse as a few large panels.", "default": "standard", "options": [{ "value": "fine", "label": "Fine" }, { "value": "standard", "label": "Standard" }, { "value": "coarse", "label": "Coarse" }] },
|
|
{ "id": "weight", "type": "enum", "role": "style", "label": "Weight", "description": "Thickness of the grid lines, from a hairline rule to a bold structural grid.", "default": "hairline", "options": [{ "value": "hairline", "label": "Hairline" }, { "value": "standard", "label": "Standard" }, { "value": "bold", "label": "Bold" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Line colour: neutral is the translucent white the original ships with, and the accents ride --brand, --accent and --accent-2.", "default": "neutral", "options": [{ "value": "neutral", "label": "Neutral" }, { "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] }
|
|
]'
|
|
></div>
|
|
|
|
<style>
|
|
.hf-dynamic-grid {
|
|
--hf-grid-size: 72px;
|
|
--hf-grid-line: 1px;
|
|
--hf-grid-color: rgba(255, 255, 255, 0.16);
|
|
--hf-grid-x: 0px;
|
|
--hf-grid-y: 0px;
|
|
--hf-grid-opacity: 1;
|
|
position: absolute;
|
|
inset: 0;
|
|
pointer-events: none;
|
|
opacity: var(--hf-grid-opacity);
|
|
background-image:
|
|
linear-gradient(var(--hf-grid-color) var(--hf-grid-line), transparent var(--hf-grid-line)),
|
|
linear-gradient(
|
|
90deg,
|
|
var(--hf-grid-color) var(--hf-grid-line),
|
|
transparent var(--hf-grid-line)
|
|
);
|
|
background-size: var(--hf-grid-size) var(--hf-grid-size);
|
|
background-position: var(--hf-grid-x) var(--hf-grid-y);
|
|
}
|
|
</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 sizes = { fine: "44px", standard: "72px", coarse: "112px" };
|
|
var weights = { hairline: "1px", standard: "2px", bold: "3px" };
|
|
var tones = {
|
|
neutral: "rgba(255, 255, 255, 0.16)",
|
|
green: "color-mix(in srgb, var(--brand, #34d399) 34%, transparent)",
|
|
blue: "color-mix(in srgb, var(--accent, #38bdf8) 34%, transparent)",
|
|
violet: "color-mix(in srgb, var(--accent-2, #a78bfa) 34%, transparent)",
|
|
};
|
|
|
|
var size = sizes[pick(sizes, vars.density, "standard")];
|
|
var line = weights[pick(weights, vars.weight, "hairline")];
|
|
var color = tones[pick(tones, vars.tone, "neutral")];
|
|
|
|
var roots = document.querySelectorAll(".hf-dynamic-grid");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-grid-size", size);
|
|
roots[i].style.setProperty("--hf-grid-line", line);
|
|
roots[i].style.setProperty("--hf-grid-color", color);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
|
|
tl.to(".hf-dynamic-grid", {
|
|
"--hf-grid-x": "72px",
|
|
"--hf-grid-y": "-72px",
|
|
duration: 6,
|
|
ease: "none",
|
|
}, 0);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/dynamic-grid.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `video-primitive` `motion-primitive` `background` `grid` `ui`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
|
- [Build a richer composition](/go-further)
|