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.
315 lines
11 KiB
Plaintext
315 lines
11 KiB
Plaintext
---
|
||
title: "Handwritten Title"
|
||
description: "Handwritten display text with a scalar-driven word-by-word highlight sweep and a seeded squiggle underline sized to the text; boils"
|
||
---
|
||
|
||
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-title 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-title.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-title.png");document.body.appendChild(p)});<\/script></body></html>`}
|
||
/>
|
||
|
||
## Install
|
||
|
||
<InstallCommand command="npx hyperframes add hw-title" item="hw-title" />
|
||
|
||
That writes `compositions/hw-title.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-title"
|
||
data-composition-src="compositions/hw-title.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-title.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-t-root {
|
||
/* ---- hw tokens ---- */
|
||
--hw-font-print: "Caveat", cursive;
|
||
--hw-font-script: "Caveat", cursive;
|
||
--hw-ink: #f4f2ec;
|
||
--hw-ink-dark: #26241f;
|
||
--hw-accent-warm: #ffb020;
|
||
|
||
position: relative;
|
||
width: 1920px;
|
||
height: 1080px;
|
||
overflow: hidden;
|
||
background: transparent; /* overlays footage or a board */
|
||
font-family: var(--hw-font-print, "Caveat", cursive);
|
||
}
|
||
#hw-t-wrap {
|
||
position: absolute;
|
||
pointer-events: none;
|
||
}
|
||
#hw-t-line {
|
||
font-weight: 700;
|
||
line-height: 1.1;
|
||
white-space: nowrap;
|
||
text-shadow: 0 2px 18px rgba(0, 0, 0, 0.4);
|
||
}
|
||
#hw-t-line .w {
|
||
display: inline;
|
||
}
|
||
#hw-t-under {
|
||
overflow: visible;
|
||
display: block;
|
||
}
|
||
#hw-t-under path {
|
||
fill: none;
|
||
stroke: var(--hw-accent-warm);
|
||
stroke-width: 7;
|
||
stroke-linecap: round;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div
|
||
id="hw-t-root"
|
||
data-composition-id="hw-title"
|
||
data-start="0"
|
||
data-duration="6"
|
||
data-width="1920"
|
||
data-height="1080"
|
||
>
|
||
<div id="hw-t-wrap">
|
||
<div id="hw-t-line"></div>
|
||
<svg id="hw-t-under" width="10" height="34"><path id="hw-t-under-path"></path></svg>
|
||
</div>
|
||
<div
|
||
id="hw-t-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 ----
|
||
Handwritten title with the highlight-sweep scalar (the shared
|
||
mk-callout-highlight mechanic) + squiggle underline + the boil.
|
||
Demonstrates the dispatcher composing sweep + boil on one
|
||
timeline (learning: one onUpdate — everything through hwOnUpdate). */
|
||
var CONFIG = {
|
||
text: "shine like the star you are",
|
||
fontSize: 120,
|
||
scheme: "chalk", // "chalk" (white, over footage) | "ink" (dark, boards)
|
||
sweep: { enabled: true, start: 0.8, end: 3.2 },
|
||
underline: { enabled: true, wobble: 6 },
|
||
boil: { enabled: true, amp: 1.4, rot: 0.3, frameDrop: 3 },
|
||
seed: 8,
|
||
x: null, // null = centered
|
||
y: null,
|
||
animationIn: true,
|
||
animationOut: true,
|
||
};
|
||
|
||
var DUR = 6;
|
||
function clamp(v, lo, hi) {
|
||
return Math.min(hi, Math.max(lo, v));
|
||
}
|
||
var IN = clamp(DUR * 0.08, 0.3, 0.8);
|
||
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,
|
||
});
|
||
}
|
||
});
|
||
};
|
||
|
||
var FULL = CONFIG.scheme === "ink" ? "#26241f" : "#f4f2ec";
|
||
var FAINT = CONFIG.scheme === "ink" ? "rgba(38,36,31,0.3)" : "rgba(244,242,236,0.32)";
|
||
|
||
var wrap = document.getElementById("hw-t-wrap");
|
||
var line = document.getElementById("hw-t-line");
|
||
line.style.fontSize = CONFIG.fontSize + "px";
|
||
|
||
/* word spans */
|
||
var wordEls = [];
|
||
CONFIG.text.split(/\s+/).forEach(function (w, i) {
|
||
if (i > 0) line.appendChild(document.createTextNode(" "));
|
||
var span = document.createElement("span");
|
||
span.className = "w";
|
||
span.textContent = w;
|
||
span.style.color = CONFIG.sweep.enabled ? FAINT : FULL;
|
||
line.appendChild(span);
|
||
wordEls.push(span);
|
||
});
|
||
|
||
/* measure + position; build squiggle underline to match width */
|
||
var rect = line.getBoundingClientRect();
|
||
wrap.style.left =
|
||
(CONFIG.x === null ? Math.round((1920 - rect.width) / 2) : CONFIG.x) + "px";
|
||
wrap.style.top =
|
||
(CONFIG.y === null ? Math.round((1080 - rect.height) / 2) - 20 : CONFIG.y) + "px";
|
||
|
||
var underPath = document.getElementById("hw-t-under-path");
|
||
if (CONFIG.underline.enabled) {
|
||
var uw = Math.round(rect.width);
|
||
var svg = document.getElementById("hw-t-under");
|
||
svg.setAttribute("width", uw);
|
||
svg.setAttribute("viewBox", "0 0 " + uw + " 34");
|
||
var segs = Math.max(6, Math.round(uw / 90));
|
||
var d = "M 2 " + (16 + window.hwHash(0, CONFIG.seed) * 4).toFixed(1);
|
||
for (var i = 1; i <= segs; i++) {
|
||
var x = (uw / segs) * i;
|
||
var y = 16 + window.hwHash(i * 5 + 1, CONFIG.seed) * CONFIG.underline.wobble;
|
||
var cxp = x - uw / segs / 2 + window.hwHash(i * 5 + 2, CONFIG.seed) * 10;
|
||
var cyp = 16 + (i % 2 ? -1 : 1) * (8 + window.hwHash(i * 5 + 3, CONFIG.seed) * 4);
|
||
d +=
|
||
" Q " +
|
||
cxp.toFixed(1) +
|
||
" " +
|
||
cyp.toFixed(1) +
|
||
" " +
|
||
x.toFixed(1) +
|
||
" " +
|
||
y.toFixed(1);
|
||
}
|
||
underPath.setAttribute("d", d);
|
||
} else {
|
||
document.getElementById("hw-t-under").style.display = "none";
|
||
}
|
||
|
||
var tl = gsap.timeline({ paused: true });
|
||
|
||
if (CONFIG.animationIn) {
|
||
gsap.set(wrap, { opacity: 0 });
|
||
tl.to(wrap, { opacity: 1, duration: IN, ease: "power2.out" }, 0.1);
|
||
}
|
||
|
||
/* the sweep scalar — registered through the dispatcher so it
|
||
coexists with the boil on the same timeline */
|
||
if (CONFIG.sweep.enabled) {
|
||
var mix = gsap.utils.interpolate(FAINT, FULL);
|
||
var st = { p: 0 };
|
||
window.hwOnUpdate(tl, function () {
|
||
var k = st.p * wordEls.length;
|
||
for (var i = 0; i < wordEls.length; i++) {
|
||
var f = Math.max(0, Math.min(1, k - i));
|
||
wordEls[i].style.color = mix(f);
|
||
}
|
||
});
|
||
tl.to(
|
||
st,
|
||
{ p: 1, duration: CONFIG.sweep.end - CONFIG.sweep.start, ease: "none" },
|
||
CONFIG.sweep.start,
|
||
);
|
||
}
|
||
|
||
/* underline draws as the sweep lands */
|
||
if (CONFIG.underline.enabled) {
|
||
var len = underPath.getTotalLength();
|
||
gsap.set(underPath, { strokeDasharray: len, strokeDashoffset: len });
|
||
var uAt = CONFIG.sweep.enabled ? CONFIG.sweep.end - 0.2 : 0.8;
|
||
tl.to(underPath, { strokeDashoffset: 0, duration: 0.7, ease: "power2.inOut" }, uAt);
|
||
}
|
||
|
||
if (CONFIG.boil.enabled) {
|
||
window.hwBoil(tl, "#hw-t-wrap", {
|
||
amp: CONFIG.boil.amp,
|
||
rot: CONFIG.boil.rot,
|
||
frameDrop: CONFIG.boil.frameDrop,
|
||
seed: CONFIG.seed,
|
||
});
|
||
}
|
||
|
||
if (CONFIG.animationOut) {
|
||
tl.to(wrap, { opacity: 0, duration: OUT, ease: "power2.in" }, DUR - OUT - 0.05);
|
||
}
|
||
tl.set("#hw-t-root", { visibility: "hidden" }, DUR - 0.02);
|
||
|
||
window.__timelines["hw-title"] = tl;
|
||
})();
|
||
</script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
</Accordion>
|
||
|
||
{/* hf:generated-footer */}
|
||
|
||
Tagged `handwritten` `typography` `title-card` `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)
|