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>
298 lines
14 KiB
Plaintext
298 lines
14 KiB
Plaintext
---
|
|
title: "Strikethrough Replace"
|
|
description: "Draw a strike line across old text, then reveal the replacement."
|
|
---
|
|
|
|
import { InstallCommand } from "/snippets/install-command.jsx";
|
|
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add strikethrough-replace" item="strikethrough-replace" />
|
|
|
|
That writes one file: `compositions/components/strikethrough-replace.html`.
|
|
|
|
<VariablesExplorer
|
|
previewSrc="/public/catalog/components/strikethrough-replace.json"
|
|
compositionId="strikethrough-replace"
|
|
compositionSrc="compositions/components/strikethrough-replace.html"
|
|
variables={[{"id":"origin","type":"enum","role":"motion","label":"Origin","description":"Edge the strike grows out of as the timeline runs its scale from 0 to 1.","default":"left","options":[{"value":"left","label":"Left"},{"value":"center","label":"Center"},{"value":"right","label":"Right"}]},{"id":"thickness","type":"enum","role":"style","label":"Thickness","description":"Height of the strike line, from a hairline rule to a heavy bar.","default":"standard","options":[{"value":"thin","label":"Thin"},{"value":"standard","label":"Standard"},{"value":"thick","label":"Thick"}]},{"id":"tint","type":"enum","role":"style","label":"Tint","description":"Strike colour. Blue and violet ride --accent and --accent-2.","default":"red","options":[{"value":"red","label":"Red"},{"value":"amber","label":"Amber"},{"value":"blue","label":"Blue"},{"value":"violet","label":"Violet"}]},{"id":"tone","type":"enum","role":"style","label":"Tone","description":"Colour of both words: ink for light frames, paper for dark ones.","default":"ink","options":[{"value":"ink","label":"Ink"},{"value":"paper","label":"Paper"}]}]}
|
|
>
|
|
|
|
```html strikethrough-replace.html
|
|
<!--
|
|
Strikethrough Replace - 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 below consumes. The timeline recipe at the bottom is untouched by
|
|
them: it keeps drawing one strike and fading in one replacement, and these
|
|
decide which way that strike draws and what the pair looks like.
|
|
|
|
- origin (left | center | right, default left): the edge the strike grows
|
|
out of while the timeline runs its scale from 0 to 1. left wipes forward,
|
|
right wipes backward, center opens from the middle outwards. Once the
|
|
line is fully drawn all three look the same, so this reads while the
|
|
strike is drawing, not after it has landed.
|
|
- thickness (thin | standard | thick, default standard): height of the
|
|
strike line, 3px, 6px or 10px.
|
|
- tint (red | amber | blue | violet, default red): strike colour. red and
|
|
amber are literal, blue and violet ride --accent and --accent-2.
|
|
- tone (ink | paper, default ink): colour of both words. ink is near-black
|
|
for light frames, paper near-white for dark ones.
|
|
|
|
On every default the result is identical to the original: a 6px red line
|
|
wipes left to right across near-black text, then the replacement fades up.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-strikethrough-replace"
|
|
data-composition-variables='[
|
|
{ "id": "origin", "type": "enum", "role": "motion", "label": "Origin", "description": "Edge the strike grows out of as the timeline runs its scale from 0 to 1.", "default": "left", "options": [{ "value": "left", "label": "Left" }, { "value": "center", "label": "Center" }, { "value": "right", "label": "Right" }] },
|
|
{ "id": "thickness", "type": "enum", "role": "style", "label": "Thickness", "description": "Height of the strike line, from a hairline rule to a heavy bar.", "default": "standard", "options": [{ "value": "thin", "label": "Thin" }, { "value": "standard", "label": "Standard" }, { "value": "thick", "label": "Thick" }] },
|
|
{ "id": "tint", "type": "enum", "role": "style", "label": "Tint", "description": "Strike colour. Blue and violet ride --accent and --accent-2.", "default": "red", "options": [{ "value": "red", "label": "Red" }, { "value": "amber", "label": "Amber" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Colour of both words: ink for light frames, paper for dark ones.", "default": "ink", "options": [{ "value": "ink", "label": "Ink" }, { "value": "paper", "label": "Paper" }] }
|
|
]'
|
|
>
|
|
<span>Slow</span><i></i><strong>Fast</strong>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-strikethrough-replace {
|
|
color: var(--hf-strike-text-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-strikethrough-replace {
|
|
position: relative;
|
|
display: inline-grid;
|
|
grid-auto-flow: column;
|
|
gap: 18px;
|
|
align-items: center;
|
|
font-size: 58px;
|
|
}
|
|
.hf-catalog-strikethrough-replace i {
|
|
position: absolute;
|
|
left: 0;
|
|
width: 48%;
|
|
height: var(--hf-strike-thickness, 6px);
|
|
border-radius: 999px;
|
|
background: var(--hf-strike-color, #ef4444);
|
|
transform: scaleX(var(--hf-strike-progress, 1));
|
|
transform-origin: var(--hf-strike-origin, left center);
|
|
}
|
|
.hf-catalog-strikethrough-replace strong {
|
|
opacity: var(--hf-replace-opacity, 1);
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
var origins = { left: "left center", center: "center", right: "right center" };
|
|
var thicknesses = { thin: "3px", standard: "6px", thick: "10px" };
|
|
var tints = {
|
|
red: "#ef4444",
|
|
amber: "#f59e0b",
|
|
blue: "var(--accent, #38bdf8)",
|
|
violet: "var(--accent-2, #a78bfa)",
|
|
};
|
|
var tones = { ink: "#18181b", paper: "#fafafa" };
|
|
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
var origin = origins[pick(origins, vars.origin, "left")];
|
|
var thickness = thicknesses[pick(thicknesses, vars.thickness, "standard")];
|
|
var tint = tints[pick(tints, vars.tint, "red")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-strikethrough-replace");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-strike-origin", origin);
|
|
roots[i].style.setProperty("--hf-strike-thickness", thickness);
|
|
roots[i].style.setProperty("--hf-strike-color", tint);
|
|
roots[i].style.setProperty("--hf-strike-text-color", tone);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-strikethrough-replace i', { '--hf-strike-progress': 0 }, { '--hf-strike-progress': 1, duration: 0.28, ease: 'power2.out' }, startTime); tl.fromTo('.hf-catalog-strikethrough-replace strong', { '--hf-replace-opacity': 0, y: 14 }, { '--hf-replace-opacity': 1, y: 0, duration: 0.3, ease: 'power2.out' }, startTime + 0.24);
|
|
-->
|
|
```
|
|
|
|
</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 |
|
|
| --- | --- | --- | --- |
|
|
| `origin` | `left` | `left`, `center`, `right` | Edge the strike grows out of as the timeline runs its scale from 0 to 1. |
|
|
| `thickness` | `standard` | `thin`, `standard`, `thick` | Height of the strike line, from a hairline rule to a heavy bar. |
|
|
| `tint` | `red` | `red`, `amber`, `blue`, `violet` | Strike colour. Blue and violet ride --accent and --accent-2. |
|
|
| `tone` | `ink` | `ink`, `paper` | Colour of both words: ink for light frames, paper for dark ones. |
|
|
|
|
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="strikethrough-replace"
|
|
data-composition-src="compositions/components/strikethrough-replace.html"
|
|
data-variable-values='{"origin":"left","thickness":"standard","tint":"red","tone":"ink"}'
|
|
></div>
|
|
```
|
|
|
|
## Source
|
|
|
|
<Accordion title="strikethrough-replace.html">
|
|
|
|
```html
|
|
<!--
|
|
Strikethrough Replace - 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 below consumes. The timeline recipe at the bottom is untouched by
|
|
them: it keeps drawing one strike and fading in one replacement, and these
|
|
decide which way that strike draws and what the pair looks like.
|
|
|
|
- origin (left | center | right, default left): the edge the strike grows
|
|
out of while the timeline runs its scale from 0 to 1. left wipes forward,
|
|
right wipes backward, center opens from the middle outwards. Once the
|
|
line is fully drawn all three look the same, so this reads while the
|
|
strike is drawing, not after it has landed.
|
|
- thickness (thin | standard | thick, default standard): height of the
|
|
strike line, 3px, 6px or 10px.
|
|
- tint (red | amber | blue | violet, default red): strike colour. red and
|
|
amber are literal, blue and violet ride --accent and --accent-2.
|
|
- tone (ink | paper, default ink): colour of both words. ink is near-black
|
|
for light frames, paper near-white for dark ones.
|
|
|
|
On every default the result is identical to the original: a 6px red line
|
|
wipes left to right across near-black text, then the replacement fades up.
|
|
-->
|
|
|
|
<div
|
|
class="hf-catalog-strikethrough-replace"
|
|
data-composition-variables='[
|
|
{ "id": "origin", "type": "enum", "role": "motion", "label": "Origin", "description": "Edge the strike grows out of as the timeline runs its scale from 0 to 1.", "default": "left", "options": [{ "value": "left", "label": "Left" }, { "value": "center", "label": "Center" }, { "value": "right", "label": "Right" }] },
|
|
{ "id": "thickness", "type": "enum", "role": "style", "label": "Thickness", "description": "Height of the strike line, from a hairline rule to a heavy bar.", "default": "standard", "options": [{ "value": "thin", "label": "Thin" }, { "value": "standard", "label": "Standard" }, { "value": "thick", "label": "Thick" }] },
|
|
{ "id": "tint", "type": "enum", "role": "style", "label": "Tint", "description": "Strike colour. Blue and violet ride --accent and --accent-2.", "default": "red", "options": [{ "value": "red", "label": "Red" }, { "value": "amber", "label": "Amber" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
|
|
{ "id": "tone", "type": "enum", "role": "style", "label": "Tone", "description": "Colour of both words: ink for light frames, paper for dark ones.", "default": "ink", "options": [{ "value": "ink", "label": "Ink" }, { "value": "paper", "label": "Paper" }] }
|
|
]'
|
|
>
|
|
<span>Slow</span><i></i><strong>Fast</strong>
|
|
</div>
|
|
|
|
<style>
|
|
.hf-catalog-strikethrough-replace {
|
|
color: var(--hf-strike-text-color, #18181b);
|
|
font-family: Inter, system-ui, sans-serif;
|
|
font-weight: 900;
|
|
letter-spacing: -0.04em;
|
|
}
|
|
.hf-catalog-strikethrough-replace {
|
|
position: relative;
|
|
display: inline-grid;
|
|
grid-auto-flow: column;
|
|
gap: 18px;
|
|
align-items: center;
|
|
font-size: 58px;
|
|
}
|
|
.hf-catalog-strikethrough-replace i {
|
|
position: absolute;
|
|
left: 0;
|
|
width: 48%;
|
|
height: var(--hf-strike-thickness, 6px);
|
|
border-radius: 999px;
|
|
background: var(--hf-strike-color, #ef4444);
|
|
transform: scaleX(var(--hf-strike-progress, 1));
|
|
transform-origin: var(--hf-strike-origin, left center);
|
|
}
|
|
.hf-catalog-strikethrough-replace strong {
|
|
opacity: var(--hf-replace-opacity, 1);
|
|
}
|
|
</style>
|
|
|
|
<script>
|
|
(function () {
|
|
"use strict";
|
|
|
|
var vars =
|
|
window.__hyperframes && window.__hyperframes.getVariables
|
|
? window.__hyperframes.getVariables()
|
|
: {};
|
|
|
|
// Unrecognised overrides return to their declared defaults.
|
|
var origins = { left: "left center", center: "center", right: "right center" };
|
|
var thicknesses = { thin: "3px", standard: "6px", thick: "10px" };
|
|
var tints = {
|
|
red: "#ef4444",
|
|
amber: "#f59e0b",
|
|
blue: "var(--accent, #38bdf8)",
|
|
violet: "var(--accent-2, #a78bfa)",
|
|
};
|
|
var tones = { ink: "#18181b", paper: "#fafafa" };
|
|
|
|
function pick(table, value, fallback) {
|
|
return Object.prototype.hasOwnProperty.call(table, value) ? value : fallback;
|
|
}
|
|
|
|
var origin = origins[pick(origins, vars.origin, "left")];
|
|
var thickness = thicknesses[pick(thicknesses, vars.thickness, "standard")];
|
|
var tint = tints[pick(tints, vars.tint, "red")];
|
|
var tone = tones[pick(tones, vars.tone, "ink")];
|
|
|
|
var roots = document.querySelectorAll(".hf-catalog-strikethrough-replace");
|
|
for (var i = 0; i < roots.length; i += 1) {
|
|
roots[i].style.setProperty("--hf-strike-origin", origin);
|
|
roots[i].style.setProperty("--hf-strike-thickness", thickness);
|
|
roots[i].style.setProperty("--hf-strike-color", tint);
|
|
roots[i].style.setProperty("--hf-strike-text-color", tone);
|
|
}
|
|
})();
|
|
</script>
|
|
|
|
<!--
|
|
Timeline integration:
|
|
tl.fromTo('.hf-catalog-strikethrough-replace i', { '--hf-strike-progress': 0 }, { '--hf-strike-progress': 1, duration: 0.28, ease: 'power2.out' }, startTime); tl.fromTo('.hf-catalog-strikethrough-replace strong', { '--hf-replace-opacity': 0, y: 14 }, { '--hf-replace-opacity': 1, y: 0, duration: 0.3, ease: 'power2.out' }, startTime + 0.24);
|
|
-->
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
## Usage
|
|
|
|
Open `compositions/components/strikethrough-replace.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)
|