mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-11 19:09:20 +00:00
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>
210 lines
7.2 KiB
Plaintext
210 lines
7.2 KiB
Plaintext
---
|
||
title: "Scribble Transition"
|
||
description: "Overlay transition: scribble bands accumulate to cover the frame with a solid backstop, the host cuts beneath, and the scribble clears"
|
||
---
|
||
|
||
import { InstallCommand } from "/snippets/install-command.jsx";
|
||
|
||
## Install
|
||
|
||
<InstallCommand command="npx hyperframes add hw-scribble-transition" item="hw-scribble-transition" />
|
||
|
||
That writes one file: `compositions/hw-scribble-transition.html`.
|
||
|
||
<iframe
|
||
className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800"
|
||
title="hw-scribble-transition preview"
|
||
loading="lazy"
|
||
srcDoc={`<!doctype html><html><head><meta charset="utf-8"><style>html,body{margin:0;height:100%;overflow:hidden;background:transparent}hyperframes-player{display:block;width:100%;height:100%}</style><script src="https://cdn.jsdelivr.net/npm/@hyperframes/player@latest/dist/hyperframes-player.global.js"><\/script></head><body><script>fetch("/public/catalog/blocks/hw-scribble-transition.json").then(function(r){return r.json()}).then(function(d){var p=document.createElement("hyperframes-player");p.setAttribute("srcdoc",d.html);p.setAttribute("controls","");p.setAttribute("autoplay","");p.setAttribute("loop","");p.setAttribute("muted","");p.setAttribute("poster","https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/hw-scribble-transition.png");document.body.appendChild(p)});<\/script></body></html>`}
|
||
/>
|
||
|
||
## Add it to your video
|
||
|
||
It runs for 2.2 seconds at 1920×1080. Paste this into your composition:
|
||
|
||
```html index.html
|
||
<div
|
||
data-composition-id="hw-scribble-transition"
|
||
data-composition-src="compositions/hw-scribble-transition.html"
|
||
data-start="0"
|
||
data-duration="2.2"
|
||
data-track-index="1"
|
||
data-width="1920"
|
||
data-height="1080"
|
||
></div>
|
||
```
|
||
|
||
Move it in time with `data-start`. Put it on a different timeline row with
|
||
`data-track-index`. See [data attributes](/concepts/data-attributes) for the rest.
|
||
|
||
## Source
|
||
|
||
<Accordion title="hw-scribble-transition.html">
|
||
|
||
```html
|
||
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
|
||
<style>
|
||
*,
|
||
*::before,
|
||
*::after {
|
||
margin: 0;
|
||
padding: 0;
|
||
box-sizing: border-box;
|
||
}
|
||
body {
|
||
background: transparent;
|
||
overflow: hidden;
|
||
}
|
||
#hw-st-root {
|
||
/* Warm marker accent, consistent with the rest of the hw family.
|
||
Override per use via CONFIG.color. */
|
||
--hw-accent: #ffb020;
|
||
|
||
position: relative;
|
||
width: 1920px;
|
||
height: 1080px;
|
||
overflow: hidden;
|
||
background: transparent;
|
||
}
|
||
#hw-st-svg {
|
||
position: absolute;
|
||
inset: 0;
|
||
width: 100%;
|
||
height: 100%;
|
||
}
|
||
#hw-st-svg path {
|
||
fill: none;
|
||
stroke: var(--hw-accent);
|
||
stroke-linecap: round;
|
||
stroke-linejoin: round;
|
||
}
|
||
/* solid backstop that guarantees full coverage at the midpoint */
|
||
#hw-st-solid {
|
||
position: absolute;
|
||
inset: 0;
|
||
background: var(--hw-accent);
|
||
opacity: 0;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div
|
||
id="hw-st-root"
|
||
data-composition-id="hw-scribble-transition"
|
||
data-start="0"
|
||
data-duration="2.2"
|
||
data-width="1920"
|
||
data-height="1080"
|
||
>
|
||
<svg id="hw-st-svg" viewBox="0 0 1920 1080" data-layout-allow-overflow></svg>
|
||
<div id="hw-st-solid"></div>
|
||
<div
|
||
id="hw-st-drv"
|
||
class="clip"
|
||
data-start="0"
|
||
data-duration="2.2"
|
||
data-track-index="0"
|
||
style="position: absolute; width: 1px; height: 1px; opacity: 0; pointer-events: none"
|
||
></div>
|
||
</div>
|
||
<script>
|
||
(function () {
|
||
window.__timelines = window.__timelines || {};
|
||
|
||
/* ---- published parameters ----
|
||
Overlay-transition (the mk-clone-wall model): fat scribble strokes
|
||
sweep across and cover the frame, a solid backstop guarantees full
|
||
coverage at the midpoint (the host hard-cuts beneath, ~0.9-1.4s
|
||
local), then everything clears. Place spanning the host's cut. */
|
||
var CONFIG = {
|
||
color: null, // css color; null = --hw-accent (warm marker)
|
||
bands: 7, // horizontal scribble bands
|
||
strokeScale: 1.0,
|
||
seed: 17,
|
||
};
|
||
|
||
var W = 1920,
|
||
H = 1080,
|
||
DUR = 2.2;
|
||
|
||
window.hwHash = function (n, seed) {
|
||
var x = Math.sin(n * 127.1 + (seed || 1) * 311.7) * 43758.5453;
|
||
return (x - Math.floor(x)) * 2 - 1;
|
||
};
|
||
|
||
var root = document.getElementById("hw-st-root");
|
||
if (CONFIG.color) root.style.setProperty("--hw-accent", CONFIG.color);
|
||
var NS = "http://www.w3.org/2000/svg";
|
||
var svg = document.getElementById("hw-st-svg");
|
||
|
||
/* fat zigzag bands, each covering a horizontal slice edge-to-edge */
|
||
var bandH = H / CONFIG.bands;
|
||
var paths = [];
|
||
for (var b = 0; b < CONFIG.bands; b++) {
|
||
var y0 = b * bandH + bandH / 2;
|
||
var d = "M -80 " + (y0 + window.hwHash(b * 17, CONFIG.seed) * 20).toFixed(1);
|
||
var zigs = 7;
|
||
for (var i = 1; i <= zigs; i++) {
|
||
var x = (W + 160) * (i / zigs) - 80;
|
||
var y =
|
||
y0 + (i % 2 ? -1 : 1) * bandH * 0.32 + window.hwHash(b * 17 + i, CONFIG.seed) * 16;
|
||
d += " L " + x.toFixed(1) + " " + y.toFixed(1);
|
||
}
|
||
var p = document.createElementNS(NS, "path");
|
||
p.setAttribute("d", d);
|
||
p.setAttribute("stroke-width", Math.ceil(bandH * 0.85 * CONFIG.strokeScale));
|
||
p.setAttribute("id", "hw-st-band-" + b);
|
||
svg.appendChild(p);
|
||
paths.push(p);
|
||
}
|
||
|
||
var tl = gsap.timeline({ paused: true });
|
||
|
||
/* 0-0.85: bands scribble on (staggered, alternating direction) */
|
||
paths.forEach(function (p, i) {
|
||
var len = p.getTotalLength();
|
||
gsap.set(p, { strokeDasharray: len, strokeDashoffset: i % 2 ? -len : len });
|
||
tl.to(p, { strokeDashoffset: 0, duration: 0.55, ease: "power2.in" }, 0.04 * i);
|
||
});
|
||
/* 0.8: solid backstop snaps in beneath the finished scribble — full
|
||
coverage guaranteed 0.85-1.35 (the host's cut window) */
|
||
tl.to("#hw-st-solid", { opacity: 1, duration: 0.12, ease: "none" }, 0.8);
|
||
|
||
/* 1.35-1.95: clear — bands scribble off the other way, backstop lifts */
|
||
tl.to("#hw-st-solid", { opacity: 0, duration: 0.15, ease: "none" }, 1.42);
|
||
paths.forEach(function (p, i) {
|
||
var len = p.getTotalLength();
|
||
tl.to(
|
||
p,
|
||
{ strokeDashoffset: i % 2 ? len : -len, duration: 0.5, ease: "power2.out" },
|
||
1.42 + 0.035 * i,
|
||
);
|
||
});
|
||
|
||
/* hard kill the moment the last band clears (learning: kill roots
|
||
when the final fade completes, not at DUR) */
|
||
tl.set(root, { visibility: "hidden" }, 2.17);
|
||
|
||
window.__timelines["hw-scribble-transition"] = tl;
|
||
})();
|
||
</script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
</Accordion>
|
||
|
||
{/* hf:generated-footer */}
|
||
|
||
Tagged `handwritten` `transition` `wipe`.
|
||
|
||
## Related topics
|
||
|
||
- [Browse the complete Catalog](/catalog)
|
||
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
||
- [Build a richer composition](/go-further)
|