ext/hyperframes
2
0
Fork 0
mirror of https://github.com/heygen-com/hyperframes.git synced 2026-09-01 19:42:03 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
sync/hyperframes-codegen-3ff80b22
hyperframes/docs/catalog/components/outline-draw.mdx
T
Miguel ÁngelandMiguel Angel Simon Sierra 1ae2067b8d feat(catalog): put the variables panel back, on payloads (#3199) 
* feat(catalog): put the variables panel back, on payloads

The panel drove its preview by loading an .html from docs/public, a type the
host does not publish, so it showed an empty frame in production and was
parked when the catalog was re-landed.

It now mounts the same JSON payload the plain player uses and re-mounts it as
values change, injecting them as window.__hfVariables into the composition head
before any of its scripts run, which is where the runtime reads overrides from.
Doing it in the markup rather than after load is what stops the composition
initialising with the wrong values first.

172 items with variables get the panel back; the playhead carries across a
change so a tweak mid-shot does not jump back to frame zero.

* fix(docs): drop the unused url form and the needless escapes

* fix(docs): the panel cannot reference a binding beside the export

* feat(catalog): make importing an SVG the obvious move

A reader arrives at this control with a shape, not with path data, and the
panel asked for the coordinates first. Import is now the primary action in a
drop target you can see is a drop target, and the raw path sits behind a
disclosure for anyone who wants it.

* feat(cli): let a fruitless catalog search report the gap

An agent that searches by meaning and finds nothing worth installing knows
something we do not: the name of a move the catalog is missing. There was no
way to tell us, so that knowledge was lost at the end of every run.

hyperframes feedback --search-miss "<query>" --wanted "<the move>" records it.
It carries no rating, so it never lands in the rating metric, and it is a
separate deliberate command rather than something catalog --query does on its
own: plain search still sends nothing, which is what the CLI promises.

--rating stops being required at the arg level, since a miss has no rating to
give. The check moved into the run body, where an absent one is now handled
rather than crashing on undefined.

* feat(cli): carry tuned variable values into the install snippet

Someone who tunes a block on its catalog page had no way to keep those values:
the install command was the same one everybody gets, and the tuning stayed on
the page.

hyperframes add <item> --vars '<json>' now prints a mount element carrying
data-variable-values, so the values land where the block is used.

They ride on the host rather than being written into the installed file. That
keeps the composition on disk byte-identical to the registry's, so a later
reinstall can still tell an edit from an update, and it lets two mounts of the
same block carry different values.

* fix(catalog): serve the item's own directory so runtime paths resolve

Some compositions assemble their asset URLs at run time —
"compositions/components/" + texture + ".png" for the texture masks, a font the
compiler pulled into _remote_media — and no scan of the markup can see a string
that does not exist until a script concatenates it. Those items either rendered
black or were dropped to a video that had never been uploaded.

Each item that needs it now has its prepared directory published, and its
payload carries a <base> pointing at it, so any relative path the composition
invents resolves. caption-texture renders its masks again, and
variable-font-flex has a preview at all for the first time: its MP4 and poster
are both 403.

Both layouts are published, because which one a composition asks for differs
per item, and a directory only earns that if it is under 2 MB. The 12 MB
texture sheet keeps the recorded video it already had.

* fix(catalog): let the variables panel actually drive the composition

Every control on the panel was inert. The values reached the composition and
nothing repainted, because the payload had already been compiled: compiling
inlines a mounted component and resolves its variables into the markup and CSS,
so by the time a reader turns a knob there is nothing left to change.

An item that declares variables now ships uncompiled, keeping the mount the
runtime loads at run time, which is the only state where data-variable-values
still means anything. The component travels inline as a data URI rather than a
sibling file, because .html is the one type the docs host will not publish. The
demo's own pinned values come off, so the reader's choices reach the mount
instead of losing to the values the demo picked to show itself off.

Measured on the rendered frame rather than the DOM: green rgb(98,207,144),
blue rgb(6,6,199), violet rgb(177,147,230), and back to green.

docs/public/catalog drops from 48 MB to 35 MB along the way, since an
uncompiled payload carries far less than an inlined one.

* feat(catalog): keep variable changes in the url

A reader who tuned a piece lost it on reload, and had nothing to send anyone.
The values now live in the query string, scoped by composition id so two links
never read each other,and only the ones that differ from the defaults are
written, so changing one knob gives a short URL rather than every variable
spelled out.

replaceState rather than pushState: dragging a slider should not leave a trail
of history entries. An unreadable value is ignored rather than thrown, so a
truncated or hand-edited link opens the piece at its defaults.

* fix(catalog): only rewrite the url when a value actually changed

* refactor(catalog): memoise the declared defaults on their content

* feat(catalog): offer an install command carrying the tuned values

The Install block is generated before anyone touches a knob, so it can only
ever print the plain command. Someone who spent a minute tuning a piece copied
it and got the defaults back.

The panel now carries its own command in the Snippet tab, with --vars holding
exactly the values that differ. An untouched piece still offers the same short
command, so nothing gets noisier for the common case.

* fix(catalog): a piece with nothing to render is a skip, not a failure

caption-blend-difference is a stylesheet and a paragraph of prose — a class you
add to your own captions, with no standalone scene to show. The generator
treated that as a build failure, so every run ended by reporting something
broken when nothing was.

It now reports the shape it is and keeps its recorded video, which is the only
honest preview such an item has. A genuine render failure still throws.

* fix(catalog): restore variables from the url on a cold load

A shared link opened at the defaults. The first render happens on the server,
where there is no window to read the query string from, and React then hydrates
against that markup and never revisits it — so the values only appeared once you
touched a control.

The URL is read again after mount, which is the first moment it exists. The
value is also escaped once now rather than twice: URLSearchParams already
decodes on the way out, and decoding a second time turned an SVG path full of
percent-escapes into something that no longer parsed, besides doubling the
length of every link.

* fix(catalog): mount the preview with the values a link carried

The frame was built from the declared defaults and the shared values were
posted to it afterwards, which is too late for anything the composition reads
once at init: a path arrived after the mark had already been drawn from the
default one, so a link looked right in the panel and wrong on screen.

* feat(catalog): the install command follows the values you tuned

Copying the Install line gave the plain command back, because that block is
generated before anyone touches a knob and had no way to know what changed. The
tuned command only existed in the panel Snippet tab, which is not where anyone
looks for it.

The line now reads the same query string the panel writes, so the two agree
without either component knowing the other exists, and a shared link carries the
right command too. replaceState fires no event, so the panel announces its own
writes.

* fix(catalog): send a text variable to the preview once it is finished

Every other control in the explorer reports a whole value on every event: a
slider at any position is a position, a swatch is a colour. A text field is
not. Typing v3 into a badge posted v first, so the preview remounted and
rendered a composition built from half a word.

The post now waits while a text field has focus and goes out when the edit is
committed, with Enter or by clicking away. The field itself is unchanged and
still tracks every keystroke.

---------

Co-authored-by: Miguel Angel Simon Sierra <miguelangelsi07@gmail.com>
2026-08-10 22:40:01 -04:00

420 lines
17 KiB
Plaintext
Raw Permalink Blame History

---
title: "Outline Draw"
description: "A rounded outline that proves a callout by drawing clockwise as a hollow conic-gradient border with a clean closure."
---
import { InstallCommand } from "/snippets/install-command.jsx";
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
<VariablesExplorer
previewSrc="/public/catalog/components/outline-draw.json"
compositionId="outline-draw"
compositionSrc="compositions/components/outline-draw.html"
variables={[{"id":"progress","type":"number","role":"timing","label":"Draw progress","description":"Final percentage of the outline that is drawn.","default":100,"min":0,"max":100,"step":1,"unit":"%"},{"id":"thickness","type":"number","role":"layout","label":"Stroke thickness","description":"Outline stroke in tenths of the host width.","default":6,"min":1,"max":20,"step":1,"unit":"0.1cqw"},{"id":"radius","type":"number","role":"layout","label":"Corner radius","description":"Corner radius in tenths of the host smaller dimension.","default":24,"min":0,"max":80,"step":1,"unit":"0.1cqmin"}]}
>
```html outline-draw.html
<!doctype html>
<!--
outline-draw: HyperFrames video primitive (effects / burst / prove)
Concept: a conic-gradient sector draws a rounded outline clockwise. Two
opaque masks, clipped to the padding box and border box, are excluded to
leave a true hollow center over whatever content is beneath the primitive.
One mechanic, one job: visually proving or certifying a framed claim.
Compiled-from evidence: OutlineDraw, "Border that draws with a composite
donut," from the CSS mask research notes.
Use when: closing a loop around proof, a selected product region, a logo
lockup, or a UI callout. Mount it over existing content. The center remains
transparent and the overlay never intercepts pointer input.
Variables:
- progress (number, 0 to 100, default 100): final drawn percentage.
- thickness (number, default 6): stroke in tenths of host cqw.
- radius (number, default 24): corner radius in tenths of host cqmin.
Envelope: fixed 0.80s IN draws the outline, elastic HOLD preserves the
completed proof, and fixed 0.40s OUT fades it. If duration is shorter than
1.20s, IN and OUT compress proportionally and HOLD becomes zero.
Sync point: draw-complete occurs at 0.80s into IN, scaled only when the
whole envelope is compressed. It never moves into the elastic HOLD.
Sound: none. A parent scene may place a static cue at draw-complete.
Mount contract: the runtime clones only this template. The root fills the
host box, owns the container query basis, has no intrinsic width or height,
and registers one paused timeline under the hardcoded outline-draw id.
-->
<html
lang="en"
data-composition-variables='[
{ "id": "progress", "type": "number", "role": "timing", "label": "Draw progress", "description": "Final percentage of the outline that is drawn.", "default": 100, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "thickness", "type": "number", "role": "layout", "label": "Stroke thickness", "description": "Outline stroke in tenths of the host width.", "default": 6, "min": 1, "max": 20, "step": 1, "unit": "0.1cqw" },
{ "id": "radius", "type": "number", "role": "layout", "label": "Corner radius", "description": "Corner radius in tenths of the host smaller dimension.", "default": 24, "min": 0, "max": 80, "step": 1, "unit": "0.1cqmin" }
]'
>
<head>
<meta charset="UTF-8" />
<title>Outline Draw</title>
</head>
<body>
<template>
<div id="root" data-composition-id="outline-draw" data-duration="4" data-fps="30">
<style>
@property --od-progress {
syntax: "<number>";
inherits: false;
initial-value: 0;
}
*,
*::before,
*::after {
box-sizing: border-box;
}
#root {
position: absolute;
inset: 0;
container-type: size;
isolation: isolate;
overflow: hidden;
pointer-events: none;
}
.od-clip {
position: absolute;
inset: 0;
overflow: hidden;
}
/* EDIT ZONE: --space-8 controls the safe inset. The public
thickness and radius variables own the remaining geometry. */
.od-outline {
--od-progress: 0;
--od-thickness: 6;
--od-radius: 24;
--od-seam-overlap: 0.5deg;
position: absolute;
inset: var(--space-8, 8cqmin);
border: calc(var(--od-thickness) * 0.1cqw) solid transparent;
border-radius: calc(var(--od-radius) * 0.1cqmin);
background: conic-gradient(
from -90deg,
var(--accent, #38bdf8) 0deg calc(var(--od-progress) * 3.6deg),
transparent calc(var(--od-progress) * 3.6deg + var(--od-seam-overlap)) 360deg
);
background-clip: border-box;
background-origin: border-box;
mask:
linear-gradient(var(--fg, #f8fafc) 0 0) padding-box,
linear-gradient(var(--fg, #f8fafc) 0 0) border-box;
mask-composite: exclude;
will-change: opacity;
}
/* INVARIANT: the 0.5deg feather overlaps the coincident conic
edges at closure so 0deg and 360deg never expose a hard seam. */
</style>
<div
id="outline-draw-clip"
class="od-clip clip"
data-start="0"
data-duration="4"
data-track-index="0"
>
<div class="od-outline" data-layout-ignore aria-hidden="true"></div>
</div>
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
<script>
(function () {
"use strict";
var root = document.getElementById("root");
var outline = root.querySelector(".od-outline");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
// INVARIANT: invalid values return to declared defaults. Valid
// zero values survive because each scalar is checked explicitly.
var progressValue = Number(vars.progress);
var thicknessValue = Number(vars.thickness);
var radiusValue = Number(vars.radius);
var progress = Number.isFinite(progressValue)
? Math.max(0, Math.min(100, progressValue))
: 100;
var thickness = Number.isFinite(thicknessValue)
? Math.max(1, Math.min(20, thicknessValue))
: 6;
var radius = Number.isFinite(radiusValue) ? Math.max(0, Math.min(80, radiusValue)) : 24;
outline.style.setProperty("--od-thickness", String(thickness));
outline.style.setProperty("--od-radius", String(radius));
// RETIME RANGE: only these fixed envelope lengths may be tuned.
// HOLD is the sole elastic phase. Never use timeScale.
var IN_BASE = 0.8;
var OUT_BASE = 0.4;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "4"));
var envelope = IN_BASE + OUT_BASE;
var scale = duration < envelope ? duration / envelope : 1;
var IN = IN_BASE * scale;
var OUT = OUT_BASE * scale;
var HOLD = Math.max(0, duration - IN - OUT);
var OUT_START = IN + HOLD;
gsap.set(outline, { "--od-progress": 0, opacity: 1 });
var tl = gsap.timeline({ paused: true });
// --ease-standard maps to the production GSAP name power2.out.
// The registered scalar is tweened directly, with no proxy clock.
tl.to(outline, { "--od-progress": progress, duration: IN, ease: "power2.out" }, 0);
tl.to(outline, { opacity: 0, duration: OUT, ease: "power2.out" }, OUT_START);
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines["outline-draw"] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</VariablesExplorer>
## Install
<InstallCommand command="npx hyperframes add outline-draw" item="outline-draw" />
That writes one file: `compositions/components/outline-draw.html`.
## Paste it into your composition
Open `compositions/components/outline-draw.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.
## 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 |
| --- | --- | --- | --- |
| `progress` | `100` | 0% to 100%, step 1% | Final percentage of the outline that is drawn. |
| `thickness` | `6` | 10.1cqw to 200.1cqw, step 10.1cqw | Outline stroke in tenths of the host width. |
| `radius` | `24` | 00.1cqmin to 800.1cqmin, step 10.1cqmin | Corner radius in tenths of the host smaller dimension. |
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="outline-draw"
data-composition-src="compositions/components/outline-draw.html"
data-variable-values='{"progress":100,"thickness":6,"radius":24}'
></div>
```
## Source
<Accordion title={`outline-draw.html`}>
```html
<!doctype html>
<!--
outline-draw: HyperFrames video primitive (effects / burst / prove)
Concept: a conic-gradient sector draws a rounded outline clockwise. Two
opaque masks, clipped to the padding box and border box, are excluded to
leave a true hollow center over whatever content is beneath the primitive.
One mechanic, one job: visually proving or certifying a framed claim.
Compiled-from evidence: OutlineDraw, "Border that draws with a composite
donut," from the CSS mask research notes.
Use when: closing a loop around proof, a selected product region, a logo
lockup, or a UI callout. Mount it over existing content. The center remains
transparent and the overlay never intercepts pointer input.
Variables:
- progress (number, 0 to 100, default 100): final drawn percentage.
- thickness (number, default 6): stroke in tenths of host cqw.
- radius (number, default 24): corner radius in tenths of host cqmin.
Envelope: fixed 0.80s IN draws the outline, elastic HOLD preserves the
completed proof, and fixed 0.40s OUT fades it. If duration is shorter than
1.20s, IN and OUT compress proportionally and HOLD becomes zero.
Sync point: draw-complete occurs at 0.80s into IN, scaled only when the
whole envelope is compressed. It never moves into the elastic HOLD.
Sound: none. A parent scene may place a static cue at draw-complete.
Mount contract: the runtime clones only this template. The root fills the
host box, owns the container query basis, has no intrinsic width or height,
and registers one paused timeline under the hardcoded outline-draw id.
-->
<html
lang="en"
data-composition-variables='[
{ "id": "progress", "type": "number", "role": "timing", "label": "Draw progress", "description": "Final percentage of the outline that is drawn.", "default": 100, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "thickness", "type": "number", "role": "layout", "label": "Stroke thickness", "description": "Outline stroke in tenths of the host width.", "default": 6, "min": 1, "max": 20, "step": 1, "unit": "0.1cqw" },
{ "id": "radius", "type": "number", "role": "layout", "label": "Corner radius", "description": "Corner radius in tenths of the host smaller dimension.", "default": 24, "min": 0, "max": 80, "step": 1, "unit": "0.1cqmin" }
]'
>
<head>
<meta charset="UTF-8" />
<title>Outline Draw</title>
</head>
<body>
<template>
<div id="root" data-composition-id="outline-draw" data-duration="4" data-fps="30">
<style>
@property --od-progress {
syntax: "<number>";
inherits: false;
initial-value: 0;
}
*,
*::before,
*::after {
box-sizing: border-box;
}
#root {
position: absolute;
inset: 0;
container-type: size;
isolation: isolate;
overflow: hidden;
pointer-events: none;
}
.od-clip {
position: absolute;
inset: 0;
overflow: hidden;
}
/* EDIT ZONE: --space-8 controls the safe inset. The public
thickness and radius variables own the remaining geometry. */
.od-outline {
--od-progress: 0;
--od-thickness: 6;
--od-radius: 24;
--od-seam-overlap: 0.5deg;
position: absolute;
inset: var(--space-8, 8cqmin);
border: calc(var(--od-thickness) * 0.1cqw) solid transparent;
border-radius: calc(var(--od-radius) * 0.1cqmin);
background: conic-gradient(
from -90deg,
var(--accent, #38bdf8) 0deg calc(var(--od-progress) * 3.6deg),
transparent calc(var(--od-progress) * 3.6deg + var(--od-seam-overlap)) 360deg
);
background-clip: border-box;
background-origin: border-box;
mask:
linear-gradient(var(--fg, #f8fafc) 0 0) padding-box,
linear-gradient(var(--fg, #f8fafc) 0 0) border-box;
mask-composite: exclude;
will-change: opacity;
}
/* INVARIANT: the 0.5deg feather overlaps the coincident conic
edges at closure so 0deg and 360deg never expose a hard seam. */
</style>
<div
id="outline-draw-clip"
class="od-clip clip"
data-start="0"
data-duration="4"
data-track-index="0"
>
<div class="od-outline" data-layout-ignore aria-hidden="true"></div>
</div>
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
<script>
(function () {
"use strict";
var root = document.getElementById("root");
var outline = root.querySelector(".od-outline");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
// INVARIANT: invalid values return to declared defaults. Valid
// zero values survive because each scalar is checked explicitly.
var progressValue = Number(vars.progress);
var thicknessValue = Number(vars.thickness);
var radiusValue = Number(vars.radius);
var progress = Number.isFinite(progressValue)
? Math.max(0, Math.min(100, progressValue))
: 100;
var thickness = Number.isFinite(thicknessValue)
? Math.max(1, Math.min(20, thicknessValue))
: 6;
var radius = Number.isFinite(radiusValue) ? Math.max(0, Math.min(80, radiusValue)) : 24;
outline.style.setProperty("--od-thickness", String(thickness));
outline.style.setProperty("--od-radius", String(radius));
// RETIME RANGE: only these fixed envelope lengths may be tuned.
// HOLD is the sole elastic phase. Never use timeScale.
var IN_BASE = 0.8;
var OUT_BASE = 0.4;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "4"));
var envelope = IN_BASE + OUT_BASE;
var scale = duration < envelope ? duration / envelope : 1;
var IN = IN_BASE * scale;
var OUT = OUT_BASE * scale;
var HOLD = Math.max(0, duration - IN - OUT);
var OUT_START = IN + HOLD;
gsap.set(outline, { "--od-progress": 0, opacity: 1 });
var tl = gsap.timeline({ paused: true });
// --ease-standard maps to the production GSAP name power2.out.
// The registered scalar is tweened directly, with no proxy clock.
tl.to(outline, { "--od-progress": progress, duration: IN, ease: "power2.out" }, 0);
tl.to(outline, { opacity: 0, duration: OUT, ease: "power2.out" }, OUT_START);
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines["outline-draw"] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</Accordion>
{/* hf:generated-footer */}
Tagged `motion-primitive` `effects` `outline` `border` `mask` `proof`.
## Related topics
- [Browse the complete Catalog](/catalog)
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
- [Build a richer composition](/go-further)
Reference in New Issue View Git Blame Copy Permalink