mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-01 19:42:03 +00:00
Miguel Ángel
d7688f9943
* fix(docs): load the player from latest, not a pinned minor The catalog pages pinned the player CDN URL to a minor line, and that pin sat one line behind after the last release. Every page kept rendering, on the older build, so nothing surfaced it: the only symptom was that a fix published to npm never appeared on the docs. The generator derived its pin from the player's package.json, which is correct only if every page is regenerated on the release that moves it. That is the step that did not happen, and it has to happen across 175 generated pages plus three hand-written files for the pin to be true. A version carried in step across 178 places will be stale, and stale here is silent. Ask for latest instead and there is nothing to carry. This costs the ability to hold the docs back from a bad player release. Paid deliberately: the pin did not buy that either, it only delayed the good releases too. A test asserts no pinned version comes back, and fails if it stops finding the references at all, so it cannot pass by matching nothing. * refactor(scripts): list tracked files instead of walking the tree The pin guard hand-rolled a recursive directory walk with its own skip list and size cap, which the audit flagged: helpers living in a test file earn no coverage, so their complexity lands straight on the CRAP score. git already knows which files to read, and ignores node_modules and build output for us, so one call replaces the walker and both findings go away.
251 lines
8.4 KiB
Plaintext
251 lines
8.4 KiB
Plaintext
---
|
||
title: "Text Along a Path"
|
||
description: "Handwriting flowing along any SVG path with a per-character reveal; the path is the only geometry input"
|
||
---
|
||
|
||
import { InstallCommand } from "/snippets/install-command.jsx";
|
||
|
||
<iframe
|
||
className="w-full aspect-video rounded-xl border-0 bg-zinc-100 dark:bg-zinc-800"
|
||
title="hw-path-text 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-path-text.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-path-text.png");document.body.appendChild(p)});<\/script></body></html>`}
|
||
/>
|
||
|
||
## Install
|
||
|
||
<InstallCommand command="npx hyperframes add hw-path-text" item="hw-path-text" />
|
||
|
||
That writes `compositions/hw-path-text.html`, plus 1 supporting file under `assets/fonts/`.
|
||
|
||
## Add it to your video
|
||
|
||
It runs for 6 seconds at 1920×1080. Paste this into your composition:
|
||
|
||
```html index.html
|
||
<div
|
||
data-composition-id="hw-path-text"
|
||
data-composition-src="compositions/hw-path-text.html"
|
||
data-start="0"
|
||
data-duration="6"
|
||
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-path-text.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>
|
||
@font-face {
|
||
font-family: "Caveat";
|
||
src: url("assets/fonts/Caveat-700-latin.woff2") format("woff2");
|
||
font-weight: 700;
|
||
font-display: block;
|
||
}
|
||
*,
|
||
*::before,
|
||
*::after {
|
||
margin: 0;
|
||
padding: 0;
|
||
box-sizing: border-box;
|
||
}
|
||
body {
|
||
background: transparent;
|
||
overflow: hidden;
|
||
}
|
||
#hw-pt-root {
|
||
--hw-font-print: "Caveat", cursive;
|
||
--hw-font-script: "Caveat", cursive;
|
||
--hw-ink: #f4f2ec;
|
||
|
||
position: relative;
|
||
width: 1920px;
|
||
height: 1080px;
|
||
overflow: hidden;
|
||
background: transparent;
|
||
font-family: var(--hw-font-print, "Caveat", cursive);
|
||
}
|
||
#hw-pt-svg {
|
||
position: absolute;
|
||
inset: 0;
|
||
width: 100%;
|
||
height: 100%;
|
||
overflow: visible;
|
||
}
|
||
/* The textPath carrier is geometry only — without fill:none it inherits
|
||
SVG's default black fill and renders as a solid blob under the text. */
|
||
#hw-pt-path {
|
||
fill: none;
|
||
}
|
||
#hw-pt-guide {
|
||
fill: none;
|
||
stroke: rgba(244, 242, 236, 0.22);
|
||
stroke-width: 3;
|
||
stroke-dasharray: 2 14;
|
||
stroke-linecap: round;
|
||
}
|
||
#hw-pt-svg text {
|
||
font-family: var(--hw-font-print, "Caveat", cursive);
|
||
font-weight: 700;
|
||
fill: var(--hw-ink);
|
||
}
|
||
#hw-pt-svg tspan {
|
||
opacity: 0;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div
|
||
id="hw-pt-root"
|
||
data-composition-id="hw-path-text"
|
||
data-start="0"
|
||
data-duration="6"
|
||
data-width="1920"
|
||
data-height="1080"
|
||
>
|
||
<svg id="hw-pt-svg" viewBox="0 0 1920 1080">
|
||
<path id="hw-pt-path" d=""></path>
|
||
<path id="hw-pt-guide" d=""></path>
|
||
<text id="hw-pt-text" font-size="92">
|
||
<textPath id="hw-pt-tp" href="#hw-pt-path" startOffset="4%"></textPath>
|
||
</text>
|
||
</svg>
|
||
<div
|
||
id="hw-pt-drv"
|
||
class="clip"
|
||
data-start="0"
|
||
data-duration="6"
|
||
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 ----
|
||
Handwriting along any path — custom path text, natively via
|
||
SVG textPath (no Fusion overlay). CONFIG.d is the whole design. */
|
||
var CONFIG = {
|
||
text: "come on this wild journey with me...",
|
||
d: "M 220 700 C 520 480, 900 820, 1230 560 S 1700 380, 1780 420",
|
||
fontSize: 92,
|
||
showGuide: true, // faint dotted guide under the writing
|
||
typeCharDelay: 0.05,
|
||
seed: 12,
|
||
boil: { enabled: true, amp: 1.4, rot: 0.3, frameDrop: 3 },
|
||
animationOut: true,
|
||
};
|
||
|
||
var DUR = 6;
|
||
function clamp(v, lo, hi) {
|
||
return Math.min(hi, Math.max(lo, v));
|
||
}
|
||
var OUT = clamp(DUR * 0.06, 0.25, 0.6);
|
||
|
||
/* hw family runtime */
|
||
window.hwOnUpdate = function (tl, fn) {
|
||
if (!tl.__hwRenders) {
|
||
tl.__hwRenders = [];
|
||
tl.eventCallback("onUpdate", function () {
|
||
for (var i = 0; i < tl.__hwRenders.length; i++) tl.__hwRenders[i]();
|
||
});
|
||
}
|
||
tl.__hwRenders.push(fn);
|
||
fn();
|
||
};
|
||
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;
|
||
};
|
||
window.hwBoil = function (tl, target, opts) {
|
||
opts = opts || {};
|
||
var amp = opts.amp !== undefined ? opts.amp : 1.6;
|
||
var rot = opts.rot !== undefined ? opts.rot : 0.5;
|
||
var fps = opts.fps || 30;
|
||
var drop = opts.frameDrop || 3;
|
||
var seed = opts.seed || 1;
|
||
var els = gsap.utils.toArray(target);
|
||
window.hwOnUpdate(tl, function () {
|
||
var step = Math.floor((tl.time() * fps) / drop);
|
||
for (var i = 0; i < els.length; i++) {
|
||
gsap.set(els[i], {
|
||
x: window.hwHash(step * 3 + i * 97, seed) * amp,
|
||
y: window.hwHash(step * 3 + 1 + i * 97, seed) * amp,
|
||
rotation: (opts.baseRot || 0) + window.hwHash(step * 3 + 2 + i * 97, seed) * rot,
|
||
});
|
||
}
|
||
});
|
||
};
|
||
|
||
document.getElementById("hw-pt-path").setAttribute("d", CONFIG.d);
|
||
if (CONFIG.showGuide) document.getElementById("hw-pt-guide").setAttribute("d", CONFIG.d);
|
||
document.getElementById("hw-pt-text").setAttribute("font-size", CONFIG.fontSize);
|
||
|
||
/* per-char tspans along the path */
|
||
var NS = "http://www.w3.org/2000/svg";
|
||
var tp = document.getElementById("hw-pt-tp");
|
||
Array.from(CONFIG.text).forEach(function (ch) {
|
||
var t = document.createElementNS(NS, "tspan");
|
||
t.textContent = ch;
|
||
tp.appendChild(t);
|
||
});
|
||
|
||
var tl = gsap.timeline({ paused: true });
|
||
|
||
/* guide draws first, then the handwriting types along it */
|
||
var guide = document.getElementById("hw-pt-guide");
|
||
if (CONFIG.showGuide) {
|
||
var glen = guide.getTotalLength();
|
||
gsap.set(guide, { strokeDasharray: "2 14", strokeDashoffset: glen });
|
||
tl.to(guide, { strokeDashoffset: 0, duration: 0.9, ease: "power2.inOut" }, 0.2);
|
||
}
|
||
var chars = tp.querySelectorAll("tspan");
|
||
var delay = Math.min(CONFIG.typeCharDelay, 2.6 / Math.max(1, chars.length));
|
||
tl.to(chars, { opacity: 1, duration: 0.03, stagger: delay, ease: "none" }, 0.7);
|
||
|
||
if (CONFIG.boil.enabled) {
|
||
window.hwBoil(tl, "#hw-pt-svg", {
|
||
amp: CONFIG.boil.amp,
|
||
rot: CONFIG.boil.rot,
|
||
frameDrop: CONFIG.boil.frameDrop,
|
||
seed: CONFIG.seed,
|
||
});
|
||
}
|
||
|
||
if (CONFIG.animationOut) {
|
||
tl.to("#hw-pt-svg", { opacity: 0, duration: OUT, ease: "power2.in" }, DUR - OUT - 0.05);
|
||
}
|
||
tl.set("#hw-pt-root", { visibility: "hidden" }, DUR - 0.02);
|
||
|
||
window.__timelines["hw-path-text"] = tl;
|
||
})();
|
||
</script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
</Accordion>
|
||
|
||
{/* hf:generated-footer */}
|
||
|
||
Tagged `handwritten` `typography` `path` `overlay`.
|
||
|
||
## Related topics
|
||
|
||
- [Browse the complete Catalog](/catalog)
|
||
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
||
- [Build a richer composition](/go-further)
|