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.
260 lines
9.5 KiB
Plaintext
260 lines
9.5 KiB
Plaintext
---
|
|
title: "Hand-Drawn Box Label"
|
|
description: "Wobbled rounded rectangle draws around a region with a handwritten label above or centered"
|
|
---
|
|
|
|
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-box-label 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/components/hw-box-label.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/components/hw-box-label.png");document.body.appendChild(p)});<\/script></body></html>`}
|
|
/>
|
|
|
|
## Install
|
|
|
|
<InstallCommand command="npx hyperframes add hw-box-label" item="hw-box-label" />
|
|
|
|
That writes `compositions/components/hw-box-label.html`, plus 1 supporting file under `assets/fonts/`.
|
|
|
|
## Paste it into your composition
|
|
|
|
Open `compositions/components/hw-box-label.html` and copy what is inside into your own composition.
|
|
|
|
A component has no size or duration of its own. It takes both from the composition
|
|
you paste it into.
|
|
|
|
## Source
|
|
|
|
<Accordion title={`hw-box-label.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-box-label ----------------------------------------------------
|
|
Rounded hand-drawn box + marker label (map-label style annotations).
|
|
Requires the hw-boil helpers in the host. */
|
|
.hw-box {
|
|
position: absolute;
|
|
pointer-events: none;
|
|
}
|
|
.hw-box svg {
|
|
width: 100%;
|
|
height: 100%;
|
|
overflow: visible;
|
|
}
|
|
.hw-box path {
|
|
fill: none;
|
|
stroke: var(--hw-box-ink, var(--hw-ink, #f4f2ec));
|
|
stroke-width: var(--hw-box-w, 6);
|
|
stroke-linecap: round;
|
|
stroke-linejoin: round;
|
|
}
|
|
.hw-box .hw-bx-label {
|
|
position: absolute;
|
|
width: 100%;
|
|
text-align: center;
|
|
font-family: var(--hw-font-print, "Caveat", cursive);
|
|
font-weight: 700;
|
|
font-size: 52px;
|
|
color: var(--hw-box-ink, var(--hw-ink, #f4f2ec));
|
|
white-space: nowrap;
|
|
opacity: 0;
|
|
text-shadow: 0 2px 14px rgba(0, 0, 0, 0.4);
|
|
}
|
|
/* self-preview scene */
|
|
#hw-bx-scene {
|
|
position: absolute;
|
|
inset: 0;
|
|
background: linear-gradient(140deg, #4a3560 0%, #1c1423 100%);
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<!-- Self-preview. WIRING: copy the .hw-box CSS + markup pattern, the
|
|
hwWobbleRect / hwBoxBuild / hwBoxOn / hwBoxOff helpers, AND the
|
|
hw-boil helpers. Size the wrapper over your target, then:
|
|
|
|
hwBoxBuild("#hw-my-box", { seed: 3, label: "Europe", labelPos: "above" });
|
|
hwBoxOn(tl, "#hw-my-box", 2.0);
|
|
hwBoil(tl, "#hw-my-box", { frameDrop: 3, seed: 3 });
|
|
hwBoxOff(tl, "#hw-my-box", 8.0);
|
|
-->
|
|
<div
|
|
id="hw-bx-root"
|
|
data-composition-id="hw-box-label"
|
|
data-start="0"
|
|
data-duration="4"
|
|
data-width="1920"
|
|
data-height="1080"
|
|
>
|
|
<div id="hw-bx-scene"></div>
|
|
<div
|
|
class="hw-box"
|
|
id="hw-bx-demo"
|
|
style="left: 700px; top: 420px; width: 420px; height: 230px"
|
|
>
|
|
<svg viewBox="0 0 420 230"><path id="hw-bx-demo-path"></path></svg>
|
|
<div class="hw-bx-label" id="hw-bx-demo-label"></div>
|
|
</div>
|
|
<div
|
|
id="hw-bx-drv"
|
|
class="clip"
|
|
data-start="0"
|
|
data-duration="4"
|
|
data-track-index="0"
|
|
style="position: absolute; width: 1px; height: 1px; opacity: 0; pointer-events: none"
|
|
></div>
|
|
</div>
|
|
<script>
|
|
(function () {
|
|
window.__timelines = window.__timelines || {};
|
|
|
|
/* ---- hw-boil helpers (shared family runtime — copy once per host) ---- */
|
|
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,
|
|
});
|
|
}
|
|
});
|
|
};
|
|
|
|
// ---- hw-box helpers (copy these too) ----
|
|
// Wobbled rounded-rect path in a w x h box.
|
|
window.hwWobbleRect = function (w, h, r, seed, amp) {
|
|
amp = amp === undefined ? 3.5 : amp;
|
|
function wob(n) {
|
|
return window.hwHash(n, seed) * amp;
|
|
}
|
|
var d = "M " + (r + wob(1)) + " " + wob(2);
|
|
d += " L " + (w / 2 + wob(3)) + " " + wob(4);
|
|
d += " L " + (w - r + wob(5)) + " " + wob(6);
|
|
d += " Q " + (w + wob(7)) + " " + wob(8) + " " + (w + wob(9)) + " " + (r + wob(10));
|
|
d += " L " + (w + wob(11)) + " " + (h / 2 + wob(12));
|
|
d += " L " + (w + wob(13)) + " " + (h - r + wob(14));
|
|
d +=
|
|
" Q " +
|
|
(w + wob(15)) +
|
|
" " +
|
|
(h + wob(16)) +
|
|
" " +
|
|
(w - r + wob(17)) +
|
|
" " +
|
|
(h + wob(18));
|
|
d += " L " + (w / 2 + wob(19)) + " " + (h + wob(20));
|
|
d += " L " + (r + wob(21)) + " " + (h + wob(22));
|
|
d += " Q " + wob(23) + " " + (h + wob(24)) + " " + wob(25) + " " + (h - r + wob(26));
|
|
d += " L " + wob(27) + " " + (h / 2 + wob(28));
|
|
d += " L " + wob(29) + " " + (r + wob(30));
|
|
d += " Q " + wob(31) + " " + wob(32) + " " + (r + wob(33)) + " " + wob(34);
|
|
return d;
|
|
};
|
|
window.hwBoxBuild = function (target, opts) {
|
|
opts = opts || {};
|
|
var el = document.querySelector(target);
|
|
var svg = el.querySelector("svg");
|
|
var vb = svg.getAttribute("viewBox").split(" ");
|
|
var W = parseFloat(vb[2]),
|
|
H = parseFloat(vb[3]);
|
|
el.querySelector("path").setAttribute(
|
|
"d",
|
|
window.hwWobbleRect(W, H, Math.min(26, W * 0.1), opts.seed || 1),
|
|
);
|
|
var label = el.querySelector(".hw-bx-label");
|
|
label.textContent = opts.label || "";
|
|
if ((opts.labelPos || "above") === "above") {
|
|
label.style.top = "-64px";
|
|
} else {
|
|
label.style.top = "50%";
|
|
label.style.transform = "translateY(-50%)";
|
|
}
|
|
};
|
|
window.hwBoxOn = function (tl, target, at) {
|
|
var p = document.querySelector(target + " path");
|
|
var len = p.getTotalLength();
|
|
gsap.set(p, { strokeDasharray: len, strokeDashoffset: len });
|
|
tl.to(p, { strokeDashoffset: 0, duration: 0.75, ease: "power2.inOut" }, at);
|
|
tl.to(
|
|
document.querySelector(target + " .hw-bx-label"),
|
|
{ opacity: 1, duration: 0.4, ease: "power2.out" },
|
|
at + 0.55,
|
|
);
|
|
};
|
|
window.hwBoxOff = function (tl, target, at) {
|
|
tl.to(target, { opacity: 0, duration: 0.35, ease: "power2.in" }, at);
|
|
};
|
|
|
|
// ---- self-preview ----
|
|
window.hwBoxBuild("#hw-bx-demo", { seed: 3, label: "Europe", labelPos: "above" });
|
|
var tl = gsap.timeline({ paused: true });
|
|
window.hwBoxOn(tl, "#hw-bx-demo", 0.4);
|
|
window.hwBoil(tl, "#hw-bx-demo", { amp: 1.8, rot: 0.4, frameDrop: 3, seed: 3 });
|
|
window.hwBoxOff(tl, "#hw-bx-demo", 3.4);
|
|
tl.set("#hw-bx-root", { visibility: "hidden" }, 3.98);
|
|
window.__timelines["hw-box-label"] = tl;
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
{/* hf:generated-footer */}
|
|
|
|
Tagged `handwritten` `annotation` `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)
|