mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-11 19:09:20 +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>
296 lines
14 KiB
Plaintext
296 lines
14 KiB
Plaintext
---
|
|
title: "Icon Swap"
|
|
description: "A scale-and-blur icon swap primitive for toolbar and action state changes"
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add icon-swap" item="icon-swap" />
|
|
|
|
That writes one file: `compositions/components/icon-swap.html`.
|
|
|
|
<VariablesExplorer
|
|
previewSrc="/public/catalog/components/icon-swap.json"
|
|
compositionId="icon-swap"
|
|
compositionSrc="compositions/components/icon-swap.html"
|
|
variables={[{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Button fill and glyph colour. Accent rides --brand.","default":"dark","options":[{"value":"dark","label":"Dark"},{"value":"light","label":"Light"},{"value":"accent","label":"Accent"}]},{"id":"size","type":"enum","role":"layout","label":"Size","description":"Button box and glyph size, from a toolbar chip to a hero action.","default":"standard","options":[{"value":"small","label":"Small"},{"value":"standard","label":"Standard"},{"value":"large","label":"Large"}]},{"id":"shape","type":"enum","role":"style","label":"Shape","description":"Corner treatment of the button box.","default":"rounded","options":[{"value":"rounded","label":"Rounded"},{"value":"circle","label":"Circle"},{"value":"square","label":"Square"}]},{"id":"blur","type":"enum","role":"motion","label":"Blur","description":"Scales the blur radius the timeline drives through the swap, from a light haze to a full smear.","default":"standard","options":[{"value":"soft","label":"Soft"},{"value":"standard","label":"Standard"},{"value":"heavy","label":"Heavy"}]}]}
|
|
>
|
|
|
|
```html icon-swap.html
|
|
<!--
|
|
Icon Swap - transitions.dev-inspired primitive for HyperFrames.
|
|
|
|
Paste the markup, CSS and script into a composition. Use the timeline integration
|
|
note at the bottom as the starting point for deterministic GSAP animation.
|
|
|
|
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.
|
|
|
|
- tone (dark | light | accent, default dark): button fill and glyph colour. dark is the
|
|
matte chip, light inverts it for bright frames, accent rides --brand.
|
|
- size (small | standard | large, default standard): the button box and the glyph inside
|
|
it, 44px, 58px or 76px.
|
|
- shape (rounded | circle | square, default rounded): corner radius of the box.
|
|
- blur (soft | standard | heavy, default standard): scales the blur radius the timeline
|
|
drives through the swap, from a light haze to a full smear.
|
|
|
|
On every default the result is identical to the original: a 58px near-black chip with
|
|
16px corners and an 8px swap blur.
|
|
-->
|
|
|
|
<button
|
|
class="hf-transition-icon-swap"
|
|
type="button"
|
|
data-composition-variables='[
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Button fill and glyph colour. Accent rides --brand.", "default": "dark", "options": [{ "value": "dark", "label": "Dark" }, { "value": "light", "label": "Light" }, { "value": "accent", "label": "Accent" }] },
|
|
{ "id": "size", "type": "enum", "role": "layout", "label": "Size", "description": "Button box and glyph size, from a toolbar chip to a hero action.", "default": "standard", "options": [{ "value": "small", "label": "Small" }, { "value": "standard", "label": "Standard" }, { "value": "large", "label": "Large" }] },
|
|
{ "id": "shape", "type": "enum", "role": "style", "label": "Shape", "description": "Corner treatment of the button box.", "default": "rounded", "options": [{ "value": "rounded", "label": "Rounded" }, { "value": "circle", "label": "Circle" }, { "value": "square", "label": "Square" }] },
|
|
{ "id": "blur", "type": "enum", "role": "motion", "label": "Blur", "description": "Scales the blur radius the timeline drives through the swap, from a light haze to a full smear.", "default": "standard", "options": [{ "value": "soft", "label": "Soft" }, { "value": "standard", "label": "Standard" }, { "value": "heavy", "label": "Heavy" }] }
|
|
]'
|
|
>
|
|
<span class="from">+</span><span class="to">OK</span>
|
|
</button>
|
|
|
|
<style>
|
|
.hf-transition-icon-swap {
|
|
position: relative;
|
|
display: grid;
|
|
place-items: center;
|
|
width: var(--hf-icon-size, 58px);
|
|
height: var(--hf-icon-size, 58px);
|
|
border: 0;
|
|
border-radius: var(--hf-icon-radius, 16px);
|
|
background: var(--hf-icon-bg, #18181b);
|
|
color: var(--hf-icon-fg, #fff);
|
|
font:
|
|
900 28px/1 Inter,
|
|
system-ui,
|
|
sans-serif;
|
|
font-size: var(--hf-icon-font-size, 28px);
|
|
box-shadow: 0 18px 44px rgba(24, 24, 27, 0.22);
|
|
}
|
|
.hf-transition-icon-swap span {
|
|
position: absolute;
|
|
filter: blur(calc(var(--hf-icon-blur, 0px) * var(--hf-icon-blur-scale, 1)));
|
|
transform: scale(var(--hf-icon-scale, 1)) rotate(var(--hf-icon-rotate, 0deg));
|
|
will-change: transform, filter, opacity;
|
|
}
|
|
.hf-transition-icon-swap .to {
|
|
opacity: 0;
|
|
}
|
|
</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 tones = {
|
|
dark: { bg: "#18181b", fg: "#ffffff" },
|
|
light: { bg: "#fafafa", fg: "#18181b" },
|
|
accent: { bg: "var(--brand, #34d399)", fg: "#052e21" },
|
|
};
|
|
var sizes = {
|
|
small: { box: "44px", font: "22px" },
|
|
standard: { box: "58px", font: "28px" },
|
|
large: { box: "76px", font: "38px" },
|
|
};
|
|
var shapes = { rounded: "16px", circle: "50%", square: "6px" };
|
|
var blurScales = { soft: 0.45, standard: 1, heavy: 2.2 };
|
|
|
|
var tone = tones[pick(tones, vars.tone, "dark")];
|
|
var size = sizes[pick(sizes, vars.size, "standard")];
|
|
var shape = shapes[pick(shapes, vars.shape, "rounded")];
|
|
var blurScale = blurScales[pick(blurScales, vars.blur, "standard")];
|
|
|
|
var roots = document.querySelectorAll(".hf-transition-icon-swap");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-icon-bg", tone.bg);
|
|
roots[i].style.setProperty("--hf-icon-fg", tone.fg);
|
|
roots[i].style.setProperty("--hf-icon-size", size.box);
|
|
roots[i].style.setProperty("--hf-icon-font-size", size.font);
|
|
roots[i].style.setProperty("--hf-icon-radius", shape);
|
|
roots[i].style.setProperty("--hf-icon-blur-scale", String(blurScale));
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.to('.hf-transition-icon-swap .from', { opacity: 0, '--hf-icon-scale': 0.55, '--hf-icon-blur': '8px', '--hf-icon-rotate': '-18deg', duration: 0.18, ease: 'power2.in' }, startTime); tl.fromTo('.hf-transition-icon-swap .to', { opacity: 0, '--hf-icon-scale': 1.35, '--hf-icon-blur': '8px', '--hf-icon-rotate': '18deg' }, { opacity: 1, '--hf-icon-scale': 1, '--hf-icon-blur': '0px', '--hf-icon-rotate': '0deg', duration: 0.26, ease: 'back.out(1.7)' }, startTime + 0.12);
|
|
-->
|
|
```
|
|
|
|
</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 |
|
|
| --- | --- | --- | --- |
|
|
| `tone` | `dark` | `dark`, `light`, `accent` | Button fill and glyph colour. Accent rides --brand. |
|
|
| `size` | `standard` | `small`, `standard`, `large` | Button box and glyph size, from a toolbar chip to a hero action. |
|
|
| `shape` | `rounded` | `rounded`, `circle`, `square` | Corner treatment of the button box. |
|
|
| `blur` | `standard` | `soft`, `standard`, `heavy` | Scales the blur radius the timeline drives through the swap, from a light haze to a full smear. |
|
|
|
|
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="icon-swap"
|
|
data-composition-src="compositions/components/icon-swap.html"
|
|
data-variable-values='{"tone":"dark","size":"standard","shape":"rounded","blur":"standard"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title="icon-swap.html">
|
|
|
|
```html
|
|
<!--
|
|
Icon Swap - transitions.dev-inspired primitive for HyperFrames.
|
|
|
|
Paste the markup, CSS and script into a composition. Use the timeline integration
|
|
note at the bottom as the starting point for deterministic GSAP animation.
|
|
|
|
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.
|
|
|
|
- tone (dark | light | accent, default dark): button fill and glyph colour. dark is the
|
|
matte chip, light inverts it for bright frames, accent rides --brand.
|
|
- size (small | standard | large, default standard): the button box and the glyph inside
|
|
it, 44px, 58px or 76px.
|
|
- shape (rounded | circle | square, default rounded): corner radius of the box.
|
|
- blur (soft | standard | heavy, default standard): scales the blur radius the timeline
|
|
drives through the swap, from a light haze to a full smear.
|
|
|
|
On every default the result is identical to the original: a 58px near-black chip with
|
|
16px corners and an 8px swap blur.
|
|
-->
|
|
|
|
<button
|
|
class="hf-transition-icon-swap"
|
|
type="button"
|
|
data-composition-variables='[
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Button fill and glyph colour. Accent rides --brand.", "default": "dark", "options": [{ "value": "dark", "label": "Dark" }, { "value": "light", "label": "Light" }, { "value": "accent", "label": "Accent" }] },
|
|
{ "id": "size", "type": "enum", "role": "layout", "label": "Size", "description": "Button box and glyph size, from a toolbar chip to a hero action.", "default": "standard", "options": [{ "value": "small", "label": "Small" }, { "value": "standard", "label": "Standard" }, { "value": "large", "label": "Large" }] },
|
|
{ "id": "shape", "type": "enum", "role": "style", "label": "Shape", "description": "Corner treatment of the button box.", "default": "rounded", "options": [{ "value": "rounded", "label": "Rounded" }, { "value": "circle", "label": "Circle" }, { "value": "square", "label": "Square" }] },
|
|
{ "id": "blur", "type": "enum", "role": "motion", "label": "Blur", "description": "Scales the blur radius the timeline drives through the swap, from a light haze to a full smear.", "default": "standard", "options": [{ "value": "soft", "label": "Soft" }, { "value": "standard", "label": "Standard" }, { "value": "heavy", "label": "Heavy" }] }
|
|
]'
|
|
>
|
|
<span class="from">+</span><span class="to">OK</span>
|
|
</button>
|
|
|
|
<style>
|
|
.hf-transition-icon-swap {
|
|
position: relative;
|
|
display: grid;
|
|
place-items: center;
|
|
width: var(--hf-icon-size, 58px);
|
|
height: var(--hf-icon-size, 58px);
|
|
border: 0;
|
|
border-radius: var(--hf-icon-radius, 16px);
|
|
background: var(--hf-icon-bg, #18181b);
|
|
color: var(--hf-icon-fg, #fff);
|
|
font:
|
|
900 28px/1 Inter,
|
|
system-ui,
|
|
sans-serif;
|
|
font-size: var(--hf-icon-font-size, 28px);
|
|
box-shadow: 0 18px 44px rgba(24, 24, 27, 0.22);
|
|
}
|
|
.hf-transition-icon-swap span {
|
|
position: absolute;
|
|
filter: blur(calc(var(--hf-icon-blur, 0px) * var(--hf-icon-blur-scale, 1)));
|
|
transform: scale(var(--hf-icon-scale, 1)) rotate(var(--hf-icon-rotate, 0deg));
|
|
will-change: transform, filter, opacity;
|
|
}
|
|
.hf-transition-icon-swap .to {
|
|
opacity: 0;
|
|
}
|
|
</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 tones = {
|
|
dark: { bg: "#18181b", fg: "#ffffff" },
|
|
light: { bg: "#fafafa", fg: "#18181b" },
|
|
accent: { bg: "var(--brand, #34d399)", fg: "#052e21" },
|
|
};
|
|
var sizes = {
|
|
small: { box: "44px", font: "22px" },
|
|
standard: { box: "58px", font: "28px" },
|
|
large: { box: "76px", font: "38px" },
|
|
};
|
|
var shapes = { rounded: "16px", circle: "50%", square: "6px" };
|
|
var blurScales = { soft: 0.45, standard: 1, heavy: 2.2 };
|
|
|
|
var tone = tones[pick(tones, vars.tone, "dark")];
|
|
var size = sizes[pick(sizes, vars.size, "standard")];
|
|
var shape = shapes[pick(shapes, vars.shape, "rounded")];
|
|
var blurScale = blurScales[pick(blurScales, vars.blur, "standard")];
|
|
|
|
var roots = document.querySelectorAll(".hf-transition-icon-swap");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-icon-bg", tone.bg);
|
|
roots[i].style.setProperty("--hf-icon-fg", tone.fg);
|
|
roots[i].style.setProperty("--hf-icon-size", size.box);
|
|
roots[i].style.setProperty("--hf-icon-font-size", size.font);
|
|
roots[i].style.setProperty("--hf-icon-radius", shape);
|
|
roots[i].style.setProperty("--hf-icon-blur-scale", String(blurScale));
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.to('.hf-transition-icon-swap .from', { opacity: 0, '--hf-icon-scale': 0.55, '--hf-icon-blur': '8px', '--hf-icon-rotate': '-18deg', duration: 0.18, ease: 'power2.in' }, startTime); tl.fromTo('.hf-transition-icon-swap .to', { opacity: 0, '--hf-icon-scale': 1.35, '--hf-icon-blur': '8px', '--hf-icon-rotate': '18deg' }, { opacity: 1, '--hf-icon-scale': 1, '--hf-icon-blur': '0px', '--hf-icon-rotate': '0deg', duration: 0.26, ease: 'back.out(1.7)' }, startTime + 0.12);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/icon-swap.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `video-primitive` `transition-primitive` `transitions-dev-port` `icon` `swap`.
|
|
|
|
## Related topics
|
|
|
|
- [Browse the complete Catalog](/catalog)
|
|
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
|
- [Build a richer composition](/go-further)
|