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-0975ac7d
hyperframes/docs/catalog/components/iris-reveal.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

1033 lines
43 KiB
Plaintext
Raw Permalink Blame History

---
title: "Iris Reveal"
description: "A circle clip-path opens from an authored origin revealing state B over state A in one confident pass, then holds on B. Classic register dims and desaturates the before state so the after state lands in full color; a thin accent rim rides the iris edge. Callers fill the named before/after slot panels; token-styled defaults render when a slot is left empty."
---
import { InstallCommand } from "/snippets/install-command.jsx";
import { VariablesExplorer } from "/snippets/variables-explorer.jsx";
<VariablesExplorer
previewSrc="/public/catalog/components/iris-reveal.json"
compositionId="iris-reveal"
compositionSrc="compositions/components/iris-reveal.html"
variables={[{"id":"iris_x","type":"number","role":"layout","label":"Iris origin X","description":"Horizontal iris origin as a percent of the frame width.","default":50,"min":0,"max":100,"step":1,"unit":"%"},{"id":"iris_y","type":"number","role":"layout","label":"Iris origin Y","description":"Vertical iris origin as a percent of the frame height.","default":50,"min":0,"max":100,"step":1,"unit":"%"},{"id":"open_at","type":"number","role":"timing","label":"Open start","description":"Seconds after mount start when the iris begins opening.","default":0.35,"min":0,"max":8,"step":0.05,"unit":"s"},{"id":"register","type":"enum","role":"style","label":"Register","description":"Color dims and desaturates the before state so the after state lands in full color. Plain leaves both untouched.","default":"color","options":[{"value":"color","label":"Color"},{"value":"plain","label":"Plain"}]},{"id":"accent","type":"enum","role":"style","label":"Accent","description":"Iris rim ring and default after art tint.","default":"green","options":[{"value":"green","label":"Green"},{"value":"blue","label":"Blue"},{"value":"violet","label":"Violet"}]},{"id":"exit","type":"enum","role":"timing","label":"Exit","description":"Outgoing transition. None holds the final revealed frame.","default":"none","options":[{"value":"none","label":"None"},{"value":"fade","label":"Fade"},{"value":"up","label":"Up"}]}]}
>
```html iris-reveal.html
<!doctype html>
<!--
iris-reveal: HyperFrames video primitive (transitions / bridge)
Concept: a circle clip-path opens from an authored origin (iris_x/iris_y
percent) revealing state B over state A. Classic register: A grayscale and
dimmed, B full color. One confident pass, then a still hold on B. Two
full-bleed content slots (the before-after-wipe convention) with
token-styled defaults; callers supply the two states, the primitive
supplies the iris.
Wave K, unit K2. Clip-path only (no dashes, no masks); both endpoints of
the opening tween are authored (fromTo via a seeded proxy), so seeks are
deterministic in both directions.
Slots (see README.md for a worked example):
- [data-slot="before"]: state A, the base layer. Replace the children of
this element in your installed copy. Default: a muted token wireframe.
- [data-slot="after"]: state B, revealed by the iris. Same mechanism.
Default: a brand-tinted version of the wireframe.
Direct img/video children of a slot are sized to cover the panel.
Variables (declared in data-composition-variables below):
- iris_x (number, default 50, 0 to 100%): iris origin, percent of width.
- iris_y (number, default 50, 0 to 100%): iris origin, percent of height.
- open_at (number, seconds, default 0.35): when the iris starts opening,
relative to mount start. Clamped so the pass completes inside IN.
- register (color | plain, default color): color dims and desaturates
state A so B lands in full color; plain leaves both states untouched.
- accent (green | blue | violet, default green): iris rim ring and the
default after art tint. green maps to --brand, blue to --accent,
violet to --accent-2.
- exit (none | fade | up, default none): outgoing transition. none holds
the final frame (frame roots own transitions; holds end films).
The iris rim is a thin accent circle (SVG stroke, fixed width) that rides
the exact same radius proxy as the clip-path, so rim and clip edge are
locked on every frame. It fades in as the pass starts and dissolves just
before the iris clears the frame corners.
Envelope (fixed IN/OUT, elastic HOLD only, never gsap.timeScale()):
IN = open_at + 1.10s iris pass (stage settles during the first 0.32s)
HOLD = elastic = max(0, D - (IN + OUT)); deliberately still on B
OUT = 0.50s when exit is fade or up, 0 when exit is none
If D < IN + OUT, IN and OUT scale down together so IN + OUT == D.
Sync point: iris-open land at open_at + 1.10s inside IN (1.45s at
defaults). It never moves into elastic HOLD.
Sound cue: dispatches a bubbling `hf:sfx` CustomEvent with id
"iris-land-soft" at iris land. This primitive never plays audio.
Determinism: the full radius and the iris center are measured in px once
at mount (the K-wave law for cq-unit transform traps); the radius proxy is
the single owner of clip and rim progress, re-written on every seek via
onUpdate. Quiet register by default (L2); no percussive variants.
Mount contract: MOUNTABLE SUB-COMPOSITION. The runtime clones only
<template> contents; #root fills the host box (inset:0, container-type:
size), has no data-width/data-height, and registers one paused timeline
under the literal "iris-reveal" key (mount flattening strips
data-composition-id from the live root). Variables come from
window.__hyperframes.getVariables().
-->
<html
lang="en"
data-composition-id="iris-reveal"
data-composition-duration="3.5"
data-composition-variables='[
{ "id": "iris_x", "type": "number", "role": "layout", "label": "Iris origin X", "description": "Horizontal iris origin as a percent of the frame width.", "default": 50, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "iris_y", "type": "number", "role": "layout", "label": "Iris origin Y", "description": "Vertical iris origin as a percent of the frame height.", "default": 50, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "open_at", "type": "number", "role": "timing", "label": "Open start", "description": "Seconds after mount start when the iris begins opening.", "default": 0.35, "min": 0, "max": 8, "step": 0.05, "unit": "s" },
{ "id": "register", "type": "enum", "role": "style", "label": "Register", "description": "Color dims and desaturates the before state so the after state lands in full color. Plain leaves both untouched.", "default": "color", "options": [{ "value": "color", "label": "Color" }, { "value": "plain", "label": "Plain" }] },
{ "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Iris rim ring and default after art tint.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
{ "id": "exit", "type": "enum", "role": "timing", "label": "Exit", "description": "Outgoing transition. None holds the final revealed frame.", "default": "none", "options": [{ "value": "none", "label": "None" }, { "value": "fade", "label": "Fade" }, { "value": "up", "label": "Up" }] }
]'
>
<head>
<meta charset="UTF-8" />
<title>Iris Reveal</title>
</head>
<body>
<template>
<div id="root" data-composition-id="iris-reveal" data-duration="3.5" data-fps="30">
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
/* Root fills the host-owned box. Internal measurements use cqw/cqh
and every painted color comes from a contract token. */
#root {
position: absolute;
inset: 0;
container-type: size;
isolation: isolate;
overflow: hidden;
background: var(--bg, #07111f);
color: var(--fg, #f8fafc);
font-family: var(--font-body, Inter, system-ui, sans-serif);
}
.ir-clip,
.ir-stage,
.ir-panel,
.ir-slot,
.ir-rim {
position: absolute;
inset: 0;
width: 100%;
height: 100%;
}
.ir-clip {
overflow: hidden;
}
.ir-stage {
opacity: 0;
}
.ir-panel {
overflow: hidden;
}
/* The after layer is revealed by one circle clip-path. --ir-r (px)
is written by the radius proxy, the single owner of iris
progress; --ir-cx/--ir-cy are set once at mount. */
.ir-after {
z-index: 2;
clip-path: circle(calc(var(--ir-r, 0) * 1px) at var(--ir-cx, 50%) var(--ir-cy, 50%));
}
/* Classic register: state A reads dimmed and desaturated so state B
lands in full color. Static CSS, never tweened. */
#root[data-register="color"] .ir-before .ir-slot {
filter: grayscale(1) brightness(0.76);
}
/* Caller-supplied media covers its panel edge to edge. */
.ir-slot > img,
.ir-slot > video {
position: absolute;
inset: 0;
width: 100%;
height: 100%;
object-fit: cover;
}
/* The rim ring rides the same radius proxy as the clip edge. Fixed
stroke width in px (set at mount), fill none, no dashes. */
.ir-rim {
z-index: 3;
overflow: visible;
pointer-events: none;
}
.ir-rim circle {
fill: none;
stroke: var(--ir-accent, #22c55e);
}
/* Token-styled default slot content: a wireframe card that reads
muted on the before layer and brand-tinted on the after layer.
Callers replacing slot children never see any of this. */
.ir-default {
position: absolute;
inset: 0;
display: grid;
place-items: center;
}
.ir-before .ir-default {
background:
linear-gradient(
color-mix(in srgb, var(--border, #334155) 34%, transparent) 0.12cqw,
transparent 0.12cqw
)
0 0 / 5cqw 5cqw,
linear-gradient(
90deg,
color-mix(in srgb, var(--border, #334155) 34%, transparent) 0.12cqw,
transparent 0.12cqw
)
0 0 / 5cqw 5cqw,
var(--surface, #172033);
}
.ir-after .ir-default {
background: linear-gradient(
135deg,
color-mix(in srgb, var(--brand, #22c55e) 32%, var(--surface, #172033)) 0%,
var(--surface, #172033) 58%,
color-mix(in srgb, var(--ir-accent, #22c55e) 22%, var(--surface, #172033)) 100%
);
}
.ir-card {
width: 56cqw;
height: 56cqh;
padding: var(--space-3, 4cqh) var(--space-3, 4cqw);
border: 0.16cqw solid var(--border, #334155);
border-radius: var(--radius, 2.4cqmin);
background: color-mix(in srgb, var(--surface, #172033) 88%, var(--bg, #07111f));
box-shadow: 0 2cqh 5cqw color-mix(in srgb, var(--bg, #07111f) 45%, transparent);
}
.ir-after .ir-card {
border-color: color-mix(in srgb, var(--ir-accent, #22c55e) 52%, var(--border, #334155));
background: color-mix(in srgb, var(--surface, #172033) 86%, var(--brand, #22c55e));
}
.ir-bar {
width: 34%;
height: 4.4cqh;
margin-bottom: var(--space-3, 4cqh);
border-radius: 1.2cqh;
background: var(--muted, #94a3b8);
opacity: 0.5;
}
.ir-after .ir-bar {
background: var(--ir-accent, #22c55e);
opacity: 0.92;
}
.ir-line {
height: 2.4cqh;
margin-bottom: var(--space-2, 2.6cqh);
border-radius: 1.2cqh;
background: var(--muted, #94a3b8);
opacity: 0.4;
}
.ir-line:nth-of-type(2) {
width: 92%;
}
.ir-line:nth-of-type(3) {
width: 68%;
}
.ir-line:nth-of-type(4) {
width: 44%;
}
.ir-after .ir-line {
background: color-mix(in srgb, var(--brand, #22c55e) 70%, var(--fg, #f8fafc));
opacity: 0.75;
}
</style>
<div
id="iris-reveal-clip"
class="ir-clip clip"
data-start="0"
data-duration="3.5"
data-track-index="0"
>
<div class="ir-stage">
<section class="ir-panel ir-before" aria-label="Before panel">
<div class="ir-slot" data-slot="before">
<!-- SLOT "before": replace the children of this element with
your own content (img, video, or HTML). -->
<div class="ir-default" aria-hidden="true">
<div class="ir-card">
<div class="ir-bar"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
</div>
</div>
</div>
</section>
<section class="ir-panel ir-after" aria-label="After panel">
<div class="ir-slot" data-slot="after">
<!-- SLOT "after": replace the children of this element with
your own content (img, video, or HTML). -->
<div class="ir-default" aria-hidden="true">
<div class="ir-card">
<div class="ir-bar"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
</div>
</div>
</div>
</section>
<svg class="ir-rim" aria-hidden="true">
<circle class="ir-rim-circle" cx="0" cy="0" r="0"></circle>
</svg>
</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");
// Literal id: mount flattening strips data-composition-id from the
// live root before this timeline registers.
var compositionId = "iris-reveal";
var stage = root.querySelector(".ir-stage");
var after = root.querySelector(".ir-after");
var rim = root.querySelector(".ir-rim");
var rimCircle = root.querySelector(".ir-rim-circle");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
function clampNumber(raw, fallback, min, max) {
var value = raw == null ? fallback : Number(raw);
if (!Number.isFinite(value)) return fallback;
return Math.max(min, Math.min(max, value));
}
// INVARIANT: iris origin always clamps into the declared 0-100 range.
var irisX = clampNumber(vars.iris_x, 50, 0, 100);
var irisY = clampNumber(vars.iris_y, 50, 0, 100);
var openAt = clampNumber(vars.open_at, 0.35, 0, 8);
var register = vars.register === "plain" ? "plain" : "color";
// Each enum choice routes to a DIFFERENT contract token so the
// variable stays meaningful under a theme.
var accentColors = {
green: "var(--brand, #22c55e)",
blue: "var(--accent, #38bdf8)",
violet: "var(--accent-2, #c5a3ff)",
};
var accent = Object.prototype.hasOwnProperty.call(accentColors, vars.accent)
? vars.accent
: "green";
// The bundler mirrors composition variables as scoped CSS custom
// props, so this unit's own accent variable can shadow the
// contract --accent token inside the subtree ("blue" is a valid
// CSS color and would render pure blue). When the shadow is
// present, fall back to the literal contract value.
var computedAccent = getComputedStyle(root).getPropertyValue("--accent").trim();
if (
computedAccent === "green" ||
computedAccent === "blue" ||
computedAccent === "violet"
) {
accentColors.blue = "#38bdf8";
}
// INVARIANT: only none | fade | up reaches the timeline.
var exit = vars.exit === "fade" || vars.exit === "up" ? vars.exit : "none";
root.dataset.register = register;
root.style.setProperty("--ir-accent", accentColors[accent]);
root.style.setProperty("--ir-cx", irisX + "%");
root.style.setProperty("--ir-cy", irisY + "%");
// Geometry measured in px ONCE at mount (cq units inside tweened
// values are a seek trap). The full radius clears the farthest
// frame corner with a small margin so the landed frame has no
// visible clip edge.
var width = root.clientWidth || 1920;
var height = root.clientHeight || 1080;
var centerX = (irisX / 100) * width;
var centerY = (irisY / 100) * height;
var fullRadius =
Math.hypot(Math.max(centerX, width - centerX), Math.max(centerY, height - centerY)) *
1.02 +
2;
rim.setAttribute("viewBox", "0 0 " + width + " " + height);
rimCircle.setAttribute("cx", String(centerX));
rimCircle.setAttribute("cy", String(centerY));
rimCircle.setAttribute("stroke-width", String(Math.max(2, width * 0.0021)));
// RETIME RANGE: fixed IN and OUT scale together only when D is too
// short. HOLD is the sole elastic phase. Never use timeScale().
var STAGE_IN_BASE = 0.32;
var OPEN_DURATION_BASE = 1.1;
var IN_BASE = openAt + OPEN_DURATION_BASE;
var OUT_BASE = exit === "none" ? 0 : 0.5;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "3.5"));
var totalBase = IN_BASE + OUT_BASE;
var scale = duration < totalBase ? duration / totalBase : 1;
var IN = IN_BASE * scale;
var OUT = OUT_BASE * scale;
var STAGE_IN = Math.min(STAGE_IN_BASE * scale, IN);
var OPEN_AT = openAt * scale;
var OPEN_DURATION = OPEN_DURATION_BASE * scale;
var OPEN_END = IN;
var HOLD = Math.max(0, duration - (IN + OUT));
var OUT_START = IN + HOLD;
function fireSfx(id, t) {
root.dispatchEvent(
new CustomEvent("hf:sfx", { detail: { id: id, t: t }, bubbles: true }),
);
}
// ONE radius proxy owns both the clip-path and the rim ring, so
// the two edges are locked on every frame. Seeded before the
// timeline builds so tl.seek(0) shows the closed iris.
var radius = { value: 0 };
function writeIris() {
after.style.setProperty("--ir-r", String(radius.value));
rimCircle.setAttribute("r", String(Math.max(0, radius.value)));
}
writeIris();
// Explicit both-endpoints state makes tl.seek(0) deterministic.
gsap.set(stage, { opacity: 0, y: 0 });
gsap.set(rim, { autoAlpha: 0 });
var tl = gsap.timeline({ paused: true });
// IN: stage settle, then ONE confident iris pass (quiet register,
// L2). The rim fades in as the pass starts and dissolves just
// before the iris clears the frame corners.
tl.to(stage, { opacity: 1, duration: STAGE_IN, ease: "power2.out" }, 0);
tl.fromTo(
radius,
{ value: 0 },
{
value: fullRadius,
duration: OPEN_DURATION,
ease: "power2.inOut",
onUpdate: writeIris,
},
OPEN_AT,
);
tl.fromTo(
rim,
{ autoAlpha: 0 },
{
autoAlpha: 1,
duration: Math.min(0.18 * scale, OPEN_DURATION),
ease: "power1.out",
immediateRender: false,
},
OPEN_AT,
);
tl.to(
rim,
{ autoAlpha: 0, duration: 0.24 * scale, ease: "power1.in" },
Math.max(OPEN_AT, OPEN_END - 0.24 * scale),
);
tl.call(
function () {
fireSfx("iris-land-soft", OPEN_END);
},
[],
OPEN_END,
);
// HOLD: deliberately still on the revealed state B.
// OUT: only when the exit variable asks for one; exit none holds
// the final revealed frame (frame roots own transitions).
if (exit !== "none") {
tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
if (exit === "up") {
tl.to(stage, { y: "-6cqh", duration: OUT, ease: "power2.in" }, OUT_START);
}
}
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines[compositionId] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</VariablesExplorer>
## Install
<InstallCommand command="npx hyperframes add iris-reveal" item="iris-reveal" />
That writes one file: `compositions/components/iris-reveal.html`.
## Paste it into your composition
Open `compositions/components/iris-reveal.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 |
| --- | --- | --- | --- |
| `iris_x` | `50` | 0% to 100%, step 1% | Horizontal iris origin as a percent of the frame width. |
| `iris_y` | `50` | 0% to 100%, step 1% | Vertical iris origin as a percent of the frame height. |
| `open_at` | `0.35` | 0s to 8s, step 0.05s | Seconds after mount start when the iris begins opening. |
| `register` | `color` | `color`, `plain` | Color dims and desaturates the before state so the after state lands in full color. Plain leaves both untouched. |
| `accent` | `green` | `green`, `blue`, `violet` | Iris rim ring and default after art tint. |
| `exit` | `none` | `none`, `fade`, `up` | Outgoing transition. None holds the final revealed frame. |
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="iris-reveal"
data-composition-src="compositions/components/iris-reveal.html"
data-variable-values='{"iris_x":50,"iris_y":50,"open_at":0.35,"register":"color","accent":"green","exit":"none"}'
></div>
```
## Source
<Accordion title={`iris-reveal.html`}>
```html
<!doctype html>
<!--
iris-reveal: HyperFrames video primitive (transitions / bridge)
Concept: a circle clip-path opens from an authored origin (iris_x/iris_y
percent) revealing state B over state A. Classic register: A grayscale and
dimmed, B full color. One confident pass, then a still hold on B. Two
full-bleed content slots (the before-after-wipe convention) with
token-styled defaults; callers supply the two states, the primitive
supplies the iris.
Wave K, unit K2. Clip-path only (no dashes, no masks); both endpoints of
the opening tween are authored (fromTo via a seeded proxy), so seeks are
deterministic in both directions.
Slots (see README.md for a worked example):
- [data-slot="before"]: state A, the base layer. Replace the children of
this element in your installed copy. Default: a muted token wireframe.
- [data-slot="after"]: state B, revealed by the iris. Same mechanism.
Default: a brand-tinted version of the wireframe.
Direct img/video children of a slot are sized to cover the panel.
Variables (declared in data-composition-variables below):
- iris_x (number, default 50, 0 to 100%): iris origin, percent of width.
- iris_y (number, default 50, 0 to 100%): iris origin, percent of height.
- open_at (number, seconds, default 0.35): when the iris starts opening,
relative to mount start. Clamped so the pass completes inside IN.
- register (color | plain, default color): color dims and desaturates
state A so B lands in full color; plain leaves both states untouched.
- accent (green | blue | violet, default green): iris rim ring and the
default after art tint. green maps to --brand, blue to --accent,
violet to --accent-2.
- exit (none | fade | up, default none): outgoing transition. none holds
the final frame (frame roots own transitions; holds end films).
The iris rim is a thin accent circle (SVG stroke, fixed width) that rides
the exact same radius proxy as the clip-path, so rim and clip edge are
locked on every frame. It fades in as the pass starts and dissolves just
before the iris clears the frame corners.
Envelope (fixed IN/OUT, elastic HOLD only, never gsap.timeScale()):
IN = open_at + 1.10s iris pass (stage settles during the first 0.32s)
HOLD = elastic = max(0, D - (IN + OUT)); deliberately still on B
OUT = 0.50s when exit is fade or up, 0 when exit is none
If D < IN + OUT, IN and OUT scale down together so IN + OUT == D.
Sync point: iris-open land at open_at + 1.10s inside IN (1.45s at
defaults). It never moves into elastic HOLD.
Sound cue: dispatches a bubbling `hf:sfx` CustomEvent with id
"iris-land-soft" at iris land. This primitive never plays audio.
Determinism: the full radius and the iris center are measured in px once
at mount (the K-wave law for cq-unit transform traps); the radius proxy is
the single owner of clip and rim progress, re-written on every seek via
onUpdate. Quiet register by default (L2); no percussive variants.
Mount contract: MOUNTABLE SUB-COMPOSITION. The runtime clones only
<template> contents; #root fills the host box (inset:0, container-type:
size), has no data-width/data-height, and registers one paused timeline
under the literal "iris-reveal" key (mount flattening strips
data-composition-id from the live root). Variables come from
window.__hyperframes.getVariables().
-->
<html
lang="en"
data-composition-id="iris-reveal"
data-composition-duration="3.5"
data-composition-variables='[
{ "id": "iris_x", "type": "number", "role": "layout", "label": "Iris origin X", "description": "Horizontal iris origin as a percent of the frame width.", "default": 50, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "iris_y", "type": "number", "role": "layout", "label": "Iris origin Y", "description": "Vertical iris origin as a percent of the frame height.", "default": 50, "min": 0, "max": 100, "step": 1, "unit": "%" },
{ "id": "open_at", "type": "number", "role": "timing", "label": "Open start", "description": "Seconds after mount start when the iris begins opening.", "default": 0.35, "min": 0, "max": 8, "step": 0.05, "unit": "s" },
{ "id": "register", "type": "enum", "role": "style", "label": "Register", "description": "Color dims and desaturates the before state so the after state lands in full color. Plain leaves both untouched.", "default": "color", "options": [{ "value": "color", "label": "Color" }, { "value": "plain", "label": "Plain" }] },
{ "id": "accent", "type": "enum", "role": "style", "label": "Accent", "description": "Iris rim ring and default after art tint.", "default": "green", "options": [{ "value": "green", "label": "Green" }, { "value": "blue", "label": "Blue" }, { "value": "violet", "label": "Violet" }] },
{ "id": "exit", "type": "enum", "role": "timing", "label": "Exit", "description": "Outgoing transition. None holds the final revealed frame.", "default": "none", "options": [{ "value": "none", "label": "None" }, { "value": "fade", "label": "Fade" }, { "value": "up", "label": "Up" }] }
]'
>
<head>
<meta charset="UTF-8" />
<title>Iris Reveal</title>
</head>
<body>
<template>
<div id="root" data-composition-id="iris-reveal" data-duration="3.5" data-fps="30">
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
/* Root fills the host-owned box. Internal measurements use cqw/cqh
and every painted color comes from a contract token. */
#root {
position: absolute;
inset: 0;
container-type: size;
isolation: isolate;
overflow: hidden;
background: var(--bg, #07111f);
color: var(--fg, #f8fafc);
font-family: var(--font-body, Inter, system-ui, sans-serif);
}
.ir-clip,
.ir-stage,
.ir-panel,
.ir-slot,
.ir-rim {
position: absolute;
inset: 0;
width: 100%;
height: 100%;
}
.ir-clip {
overflow: hidden;
}
.ir-stage {
opacity: 0;
}
.ir-panel {
overflow: hidden;
}
/* The after layer is revealed by one circle clip-path. --ir-r (px)
is written by the radius proxy, the single owner of iris
progress; --ir-cx/--ir-cy are set once at mount. */
.ir-after {
z-index: 2;
clip-path: circle(calc(var(--ir-r, 0) * 1px) at var(--ir-cx, 50%) var(--ir-cy, 50%));
}
/* Classic register: state A reads dimmed and desaturated so state B
lands in full color. Static CSS, never tweened. */
#root[data-register="color"] .ir-before .ir-slot {
filter: grayscale(1) brightness(0.76);
}
/* Caller-supplied media covers its panel edge to edge. */
.ir-slot > img,
.ir-slot > video {
position: absolute;
inset: 0;
width: 100%;
height: 100%;
object-fit: cover;
}
/* The rim ring rides the same radius proxy as the clip edge. Fixed
stroke width in px (set at mount), fill none, no dashes. */
.ir-rim {
z-index: 3;
overflow: visible;
pointer-events: none;
}
.ir-rim circle {
fill: none;
stroke: var(--ir-accent, #22c55e);
}
/* Token-styled default slot content: a wireframe card that reads
muted on the before layer and brand-tinted on the after layer.
Callers replacing slot children never see any of this. */
.ir-default {
position: absolute;
inset: 0;
display: grid;
place-items: center;
}
.ir-before .ir-default {
background:
linear-gradient(
color-mix(in srgb, var(--border, #334155) 34%, transparent) 0.12cqw,
transparent 0.12cqw
)
0 0 / 5cqw 5cqw,
linear-gradient(
90deg,
color-mix(in srgb, var(--border, #334155) 34%, transparent) 0.12cqw,
transparent 0.12cqw
)
0 0 / 5cqw 5cqw,
var(--surface, #172033);
}
.ir-after .ir-default {
background: linear-gradient(
135deg,
color-mix(in srgb, var(--brand, #22c55e) 32%, var(--surface, #172033)) 0%,
var(--surface, #172033) 58%,
color-mix(in srgb, var(--ir-accent, #22c55e) 22%, var(--surface, #172033)) 100%
);
}
.ir-card {
width: 56cqw;
height: 56cqh;
padding: var(--space-3, 4cqh) var(--space-3, 4cqw);
border: 0.16cqw solid var(--border, #334155);
border-radius: var(--radius, 2.4cqmin);
background: color-mix(in srgb, var(--surface, #172033) 88%, var(--bg, #07111f));
box-shadow: 0 2cqh 5cqw color-mix(in srgb, var(--bg, #07111f) 45%, transparent);
}
.ir-after .ir-card {
border-color: color-mix(in srgb, var(--ir-accent, #22c55e) 52%, var(--border, #334155));
background: color-mix(in srgb, var(--surface, #172033) 86%, var(--brand, #22c55e));
}
.ir-bar {
width: 34%;
height: 4.4cqh;
margin-bottom: var(--space-3, 4cqh);
border-radius: 1.2cqh;
background: var(--muted, #94a3b8);
opacity: 0.5;
}
.ir-after .ir-bar {
background: var(--ir-accent, #22c55e);
opacity: 0.92;
}
.ir-line {
height: 2.4cqh;
margin-bottom: var(--space-2, 2.6cqh);
border-radius: 1.2cqh;
background: var(--muted, #94a3b8);
opacity: 0.4;
}
.ir-line:nth-of-type(2) {
width: 92%;
}
.ir-line:nth-of-type(3) {
width: 68%;
}
.ir-line:nth-of-type(4) {
width: 44%;
}
.ir-after .ir-line {
background: color-mix(in srgb, var(--brand, #22c55e) 70%, var(--fg, #f8fafc));
opacity: 0.75;
}
</style>
<div
id="iris-reveal-clip"
class="ir-clip clip"
data-start="0"
data-duration="3.5"
data-track-index="0"
>
<div class="ir-stage">
<section class="ir-panel ir-before" aria-label="Before panel">
<div class="ir-slot" data-slot="before">
<!-- SLOT "before": replace the children of this element with
your own content (img, video, or HTML). -->
<div class="ir-default" aria-hidden="true">
<div class="ir-card">
<div class="ir-bar"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
</div>
</div>
</div>
</section>
<section class="ir-panel ir-after" aria-label="After panel">
<div class="ir-slot" data-slot="after">
<!-- SLOT "after": replace the children of this element with
your own content (img, video, or HTML). -->
<div class="ir-default" aria-hidden="true">
<div class="ir-card">
<div class="ir-bar"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
<div class="ir-line"></div>
</div>
</div>
</div>
</section>
<svg class="ir-rim" aria-hidden="true">
<circle class="ir-rim-circle" cx="0" cy="0" r="0"></circle>
</svg>
</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");
// Literal id: mount flattening strips data-composition-id from the
// live root before this timeline registers.
var compositionId = "iris-reveal";
var stage = root.querySelector(".ir-stage");
var after = root.querySelector(".ir-after");
var rim = root.querySelector(".ir-rim");
var rimCircle = root.querySelector(".ir-rim-circle");
var vars =
window.__hyperframes && window.__hyperframes.getVariables
? window.__hyperframes.getVariables()
: {};
function clampNumber(raw, fallback, min, max) {
var value = raw == null ? fallback : Number(raw);
if (!Number.isFinite(value)) return fallback;
return Math.max(min, Math.min(max, value));
}
// INVARIANT: iris origin always clamps into the declared 0-100 range.
var irisX = clampNumber(vars.iris_x, 50, 0, 100);
var irisY = clampNumber(vars.iris_y, 50, 0, 100);
var openAt = clampNumber(vars.open_at, 0.35, 0, 8);
var register = vars.register === "plain" ? "plain" : "color";
// Each enum choice routes to a DIFFERENT contract token so the
// variable stays meaningful under a theme.
var accentColors = {
green: "var(--brand, #22c55e)",
blue: "var(--accent, #38bdf8)",
violet: "var(--accent-2, #c5a3ff)",
};
var accent = Object.prototype.hasOwnProperty.call(accentColors, vars.accent)
? vars.accent
: "green";
// The bundler mirrors composition variables as scoped CSS custom
// props, so this unit's own accent variable can shadow the
// contract --accent token inside the subtree ("blue" is a valid
// CSS color and would render pure blue). When the shadow is
// present, fall back to the literal contract value.
var computedAccent = getComputedStyle(root).getPropertyValue("--accent").trim();
if (
computedAccent === "green" ||
computedAccent === "blue" ||
computedAccent === "violet"
) {
accentColors.blue = "#38bdf8";
}
// INVARIANT: only none | fade | up reaches the timeline.
var exit = vars.exit === "fade" || vars.exit === "up" ? vars.exit : "none";
root.dataset.register = register;
root.style.setProperty("--ir-accent", accentColors[accent]);
root.style.setProperty("--ir-cx", irisX + "%");
root.style.setProperty("--ir-cy", irisY + "%");
// Geometry measured in px ONCE at mount (cq units inside tweened
// values are a seek trap). The full radius clears the farthest
// frame corner with a small margin so the landed frame has no
// visible clip edge.
var width = root.clientWidth || 1920;
var height = root.clientHeight || 1080;
var centerX = (irisX / 100) * width;
var centerY = (irisY / 100) * height;
var fullRadius =
Math.hypot(Math.max(centerX, width - centerX), Math.max(centerY, height - centerY)) *
1.02 +
2;
rim.setAttribute("viewBox", "0 0 " + width + " " + height);
rimCircle.setAttribute("cx", String(centerX));
rimCircle.setAttribute("cy", String(centerY));
rimCircle.setAttribute("stroke-width", String(Math.max(2, width * 0.0021)));
// RETIME RANGE: fixed IN and OUT scale together only when D is too
// short. HOLD is the sole elastic phase. Never use timeScale().
var STAGE_IN_BASE = 0.32;
var OPEN_DURATION_BASE = 1.1;
var IN_BASE = openAt + OPEN_DURATION_BASE;
var OUT_BASE = exit === "none" ? 0 : 0.5;
var duration = Math.max(0.001, parseFloat(root.dataset.duration || "3.5"));
var totalBase = IN_BASE + OUT_BASE;
var scale = duration < totalBase ? duration / totalBase : 1;
var IN = IN_BASE * scale;
var OUT = OUT_BASE * scale;
var STAGE_IN = Math.min(STAGE_IN_BASE * scale, IN);
var OPEN_AT = openAt * scale;
var OPEN_DURATION = OPEN_DURATION_BASE * scale;
var OPEN_END = IN;
var HOLD = Math.max(0, duration - (IN + OUT));
var OUT_START = IN + HOLD;
function fireSfx(id, t) {
root.dispatchEvent(
new CustomEvent("hf:sfx", { detail: { id: id, t: t }, bubbles: true }),
);
}
// ONE radius proxy owns both the clip-path and the rim ring, so
// the two edges are locked on every frame. Seeded before the
// timeline builds so tl.seek(0) shows the closed iris.
var radius = { value: 0 };
function writeIris() {
after.style.setProperty("--ir-r", String(radius.value));
rimCircle.setAttribute("r", String(Math.max(0, radius.value)));
}
writeIris();
// Explicit both-endpoints state makes tl.seek(0) deterministic.
gsap.set(stage, { opacity: 0, y: 0 });
gsap.set(rim, { autoAlpha: 0 });
var tl = gsap.timeline({ paused: true });
// IN: stage settle, then ONE confident iris pass (quiet register,
// L2). The rim fades in as the pass starts and dissolves just
// before the iris clears the frame corners.
tl.to(stage, { opacity: 1, duration: STAGE_IN, ease: "power2.out" }, 0);
tl.fromTo(
radius,
{ value: 0 },
{
value: fullRadius,
duration: OPEN_DURATION,
ease: "power2.inOut",
onUpdate: writeIris,
},
OPEN_AT,
);
tl.fromTo(
rim,
{ autoAlpha: 0 },
{
autoAlpha: 1,
duration: Math.min(0.18 * scale, OPEN_DURATION),
ease: "power1.out",
immediateRender: false,
},
OPEN_AT,
);
tl.to(
rim,
{ autoAlpha: 0, duration: 0.24 * scale, ease: "power1.in" },
Math.max(OPEN_AT, OPEN_END - 0.24 * scale),
);
tl.call(
function () {
fireSfx("iris-land-soft", OPEN_END);
},
[],
OPEN_END,
);
// HOLD: deliberately still on the revealed state B.
// OUT: only when the exit variable asks for one; exit none holds
// the final revealed frame (frame roots own transitions).
if (exit !== "none") {
tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_START);
if (exit === "up") {
tl.to(stage, { y: "-6cqh", duration: OUT, ease: "power2.in" }, OUT_START);
}
}
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines[compositionId] = tl;
})();
</script>
</div>
</template>
</body>
</html>
```
</Accordion>
{/* hf:generated-footer */}
Tagged `transition` `iris` `circle-reveal` `clip-path` `bridge` `slots`.
## 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