Files
hyperframes/docs/catalog/components/oversized-cursor.mdx
T
Ular Kimsanov a06fdfe26e docs(catalog): put each item page's title, description and Docs text in the server HTML (#6711)
* docs(catalog): put each item page's title, description and Docs text in the server HTML

Mintlify renders snippet components in the browser only, so everything inside
CatalogDetail (title, standfirst, the Docs tab) was missing from the HTML search
engines read: 448 catalog pages served Googlebot no body text. The generator now
writes the H1 and standfirst as page markup above the component and the Docs tab
as page markup after it, shown with that tab (docs/custom.css). The component no
longer draws its own title. Pages patched structurally only; registry drift on 14
pages is left for a regeneration of its own.

* docs(catalog): keep the title's top spacing the component gave it

* fix(docs): catalog titles and descriptions keep markdown markers literal

MDX reads text inside the static <h1> and <p> as inline markdown, so @_blue_sweater_
rendered as italic blue_sweater. mdxText now writes backslash, backtick, * _ [ ] ~ as
character references too, with a unit test; the four affected pages are re-escaped.
2026-10-30 15:48:25 +00:00

476 lines
20 KiB
Plaintext

---
title: "Oversized Cursor"
description: "The look-here pointer for a video: the macOS arrow at 3.5x its normal size lands its tip on one control, clicks it on, settles just below it so the result stays in view, then exits off-screen"
mode: "frame"
---
import { CatalogDetail, CatalogSlot } from "/snippets/catalog-detail.jsx";
import { InstallCommand } from "/snippets/install-command.jsx";
<div className="hf-ve-static-head not-prose">
<h1>Oversized Cursor</h1>
<p>The look-here pointer for a video: the macOS arrow at 3.5x its normal size lands its tip on one control, clicks it on, settles just below it so the result stays in view, then exits off-screen</p>
</div>
<CatalogDetail
previewSrc="/public/catalog/components/oversized-cursor.json"
compositionId="oversized-cursor"
compositionSrc="compositions/components/oversized-cursor.html"
title="Oversized Cursor"
variables={[{"id":"cursor_variant","type":"enum","role":"style","label":"Cursor fill","default":"light","options":[{"value":"light","label":"Light (white body)"},{"value":"dark","label":"Dark (near-black body)"}]},{"id":"target_x","type":"number","role":"layout","label":"Target X","default":55,"min":15,"max":85,"step":1,"unit":"%"},{"id":"target_y","type":"number","role":"layout","label":"Target Y","default":55,"min":15,"max":85,"step":1,"unit":"%"},{"id":"click_label","type":"string","role":"content","label":"Click label","default":"Generate"},{"id":"exit","type":"enum","role":"timing","label":"Exit","description":"Optional whole-stage departure. Default none: the ignited target stays until the frame cuts.","default":"none","options":[{"value":"none","label":"None"},{"value":"fade","label":"Fade"},{"value":"up","label":"Up"}]}]}
meta={{"category":"Cursors","badge":"Stable","codeLines":388}}
attribution={{"path":"registry/components/oversized-cursor","tags":["cursor","motion-primitive","actor","pointer","interaction"]}}
hasCode
rawUrl="https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/components/oversized-cursor/oversized-cursor.html"
>
<CatalogSlot slot="code">
```html oversized-cursor.html
<!doctype html>
<!--
Oversized Cursor (actor primitive), mountable sub-composition
concept: the "look here" pointer for a video. The family macOS arrow at 3.5x
its normal size enters from off-screen, lands its tip on one control, clicks
it (the control switches on), settles just below it so the result stays in
view, then exits off-screen. Family: pointers. Profile: interaction.
use-when: kicking off a UI scene, igniting a morph/transition/typing run with a
causal click, or carrying the eye across a scene that would otherwise read as
static or stale.
mount contract: this file is a HyperFrames sub-composition, loaded by a host via
data-composition-src, never opened standalone. The runtime clones ONLY the
<template> contents into the host slot (see
skills/hyperframes-core/references/sub-compositions.md); everything outside
<template>, including this <head>, is discarded at render. The root is #root:
elastic, no data-width/data-height declared here, it fills whatever box the host
clip gives it (position:absolute; inset:0). See demo.html for the mount usage
(data-composition-src="./oversized-cursor.html" on a sized host clip).
variables:
cursor_variant (enum light|dark) pointer fill/stroke pairing, pick per scene contrast
target_x, target_y (number, percent of the HOST box) the tip's landing point
click_label (string) label on the target the cursor clicks
exit (enum none|fade|up, default none) optional whole-stage departure during
OUT; the cursor's own off-screen exit always plays (it is the mechanic)
envelope (of data-composition-duration, default 2.6s):
IN 0.00s to 1.02s (fixed) entry glide (0.5s), aim (0.2s), click tap (0.32s)
HOLD 1.02s to D-0.40s (elastic) the control switches on, cursor settles below it, holds
OUT D-0.40s to D (fixed) cursor accelerates off-screen; with exit fade|up the
whole stage (target included) also departs
sound: one click tap SFX (soft UI click) fires at the click moment, the fixed
offset into IN set by CLICK_AT below. This file never plays audio: it
only marks the cue's timing for the mix stage to pick up.
-->
<html
lang="en"
data-composition-id="oversized-cursor"
data-composition-duration="2.6"
data-composition-variables='[
{ "id": "cursor_variant", "type": "enum", "role": "style", "label": "Cursor fill", "default": "light", "options": [ { "value": "light", "label": "Light (white body)" }, { "value": "dark", "label": "Dark (near-black body)" } ] },
{ "id": "target_x", "type": "number", "role": "layout", "label": "Target X", "default": 55, "min": 15, "max": 85, "step": 1, "unit": "%" },
{ "id": "target_y", "type": "number", "role": "layout", "label": "Target Y", "default": 55, "min": 15, "max": 85, "step": 1, "unit": "%" },
{ "id": "click_label", "type": "string", "role": "content", "label": "Click label", "default": "Generate" },
{ "id": "exit", "type": "enum", "role": "timing", "label": "Exit", "description": "Optional whole-stage departure. Default none: the ignited target stays until the frame cuts.", "default": "none", "options": [ { "value": "none", "label": "None" }, { "value": "fade", "label": "Fade" }, { "value": "up", "label": "Up" } ] }
]'
>
<head>
<meta charset="UTF-8" />
<title>Oversized Cursor</title>
<!-- head is metadata for the source file only; the runtime discards it on mount -->
</head>
<body>
<template>
<style>
*,
*::before,
*::after {
box-sizing: border-box;
}
/* Root is styled by #root, never a class: the compositor scopes CSS to
[data-composition-id="oversized-cursor"] as a descendant selector, so a
rule keyed on the root's own class would never match the root itself.
Elastic and position-blind: fills whatever box the host slot gives it
(inset:0), owns its own stacking + container-query context, no
position:fixed anywhere in this file. */
#root {
position: absolute;
inset: 0;
overflow: hidden;
isolation: isolate;
container-type: size;
container-name: oc-stage;
font-family: var(--font-body, Inter, system-ui, sans-serif);
}
.oc-stage {
position: absolute;
inset: 0;
/* Transparent by design: this actor overlays whatever scene it is
dropped into. demo.html supplies its own backdrop around it. */
}
/* EDIT ZONE: target look. Safe to retheme via tokens; keep it a simple,
legible UI surface so the click reaction reads clearly. */
.oc-target {
position: absolute;
left: 50%;
top: 50%;
padding: var(--space-2, 0.6cqw) var(--space-3, 1cqw);
border-radius: var(--radius, 0.55cqw);
border: 1px solid var(--border, rgba(0, 0, 0, 0.1));
background: color-mix(
in srgb,
var(--surface, #f8fafc) calc((1 - var(--oc-ignite, 0)) * 100%),
var(--brand, #0a84ff) calc(var(--oc-ignite, 0) * 100%)
);
box-shadow:
0 1px 2px rgba(0, 0, 0, 0.08),
0 0.3cqw 0.8cqw rgba(0, 0, 0, 0.08);
--oc-ignite: 0;
z-index: 10;
}
/* The check's slot is always laid out; idle, the row shifts left by half of it
so the label sits centred, and the check slides in without a layout change. */
.oc-target-row {
display: flex;
align-items: center;
gap: 0.45cqw;
transform: translateX(calc((var(--oc-ignite, 0) - 1) * 0.725cqw));
}
.oc-target-check {
width: 1cqw;
height: 1cqw;
min-width: 14px;
min-height: 14px;
flex: none;
fill: none;
stroke: var(--fg, #ffffff);
stroke-width: 2.4;
stroke-linecap: round;
stroke-linejoin: round;
opacity: clamp(0, var(--oc-ignite, 0), 1);
transform: scale(calc(0.5 + var(--oc-ignite, 0) * 0.5));
}
.oc-target-label {
font-size: clamp(12px, 1cqw, 20px);
font-weight: 600;
line-height: 1;
white-space: nowrap;
color: color-mix(
in srgb,
var(--fg, #0f172a) calc((1 - var(--oc-ignite, 0)) * 100%),
var(--fg, #ffffff) calc(var(--oc-ignite, 0) * 100%)
);
}
/* 224px at 1920 wide: the family's 64u arrow at 3.5x, shadow scaled with it. */
.oc-cursor {
position: absolute;
left: 0;
top: 0;
width: 11.67cqw;
height: 11.67cqw;
pointer-events: none;
will-change: transform;
filter: drop-shadow(0 0.52cqw 0.73cqw rgba(0, 0, 0, 0.3));
z-index: 20;
}
.oc-cursor-svg {
display: block;
width: 100%;
height: 100%;
stroke-linejoin: round;
stroke-linecap: round;
}
/* EDIT ZONE: the two house-convention fill pairings. Pick per scene
contrast, keep it constant per film. */
.oc-cursor[data-variant="light"] .oc-cursor-svg {
fill: #ffffff;
stroke: #141414;
stroke-width: 1.4;
}
.oc-cursor[data-variant="dark"] .oc-cursor-svg {
fill: #1c1c1c;
stroke: #ffffff;
stroke-width: 1.4;
}
</style>
<div id="root" data-composition-id="oversized-cursor" data-duration="2.6">
<div class="oc-stage">
<div class="oc-target" id="oc-target">
<div class="oc-target-row">
<svg class="oc-target-check" viewBox="0 0 24 24" aria-hidden="true">
<path d="M5 13l4 4L19 7" />
</svg>
<span class="oc-target-label" id="oc-target-label"></span>
</div>
</div>
<div class="oc-cursor" id="oc-cursor" data-variant="light" aria-hidden="true">
<svg class="oc-cursor-svg" viewBox="0 0 24 24" aria-hidden="true">
<path d="M5 3 L5 19 L9 15 L12 22 L15 20.5 L11.5 14 L18 14 Z" />
</svg>
</div>
</div>
</div>
<script>
(function () {
"use strict";
// NOTE: once mounted, document.documentElement is the HOST page's
// root element, not this file's own (the mount contract discards
// this file's head and html elements after the loader reads declared
// variables/duration once, before cloning). html.getAttribute(...)
// below therefore resolves to null under mount, and every read
// falls through to its inline default (55 / 55 / "Generate" /
// "light"), which match this file's own declared defaults above.
var html = document.documentElement;
var root = document.getElementById("root");
var cursor = document.getElementById("oc-cursor");
var target = document.getElementById("oc-target");
var targetLabel = document.getElementById("oc-target-label");
// Declared defaults, then the render/preview engine's override object.
var DEFAULTS = {};
try {
JSON.parse(html.getAttribute("data-composition-variables") || "[]").forEach(
function (variable) {
DEFAULTS[variable.id] = variable.default;
},
);
} catch (error) {
/* malformed declaration falls back to hardcoded defaults below */
}
// Under mount, the runtime resolves this file's own declared
// variables merged with the host clip's per-instance
// data-variable-values through a scoped window.__hyperframes,
// shadowed in just for this file's script. window.__hfVariables
// stays in the merge too, as a raw fallback for the (non-mount)
// case where this file is driven by an older render/preview path.
var scopedVariables = {};
try {
if (window.__hyperframes && typeof window.__hyperframes.getVariables === "function") {
scopedVariables = window.__hyperframes.getVariables() || {};
}
} catch (error) {
/* no scoped variables API in this context, fall through */
}
var vars = Object.assign({}, DEFAULTS, window.__hfVariables || {}, scopedVariables);
function clampPercent(value, fallback) {
var n = Number(value);
if (!isFinite(n)) n = fallback;
return Math.max(0, Math.min(100, n));
}
// Hardcoded per the mount contract: deriving the id from the document
// returns null once the compositor rewrites the wrapper's attributes,
// which registers the timeline under "null" and breaks seek binding.
var compositionId = "oversized-cursor";
var duration = Math.max(
0.001,
parseFloat(
root.dataset.duration || html.getAttribute("data-composition-duration") || "2.6",
),
);
var variant = vars.cursor_variant === "dark" ? "dark" : "light";
var targetX = clampPercent(vars.target_x, 55);
var targetY = clampPercent(vars.target_y, 55);
var clickLabel = String(vars.click_label || "Generate");
var exit = vars.exit === "fade" || vars.exit === "up" ? vars.exit : "none";
var stage = root.querySelector(".oc-stage");
cursor.setAttribute("data-variant", variant);
targetLabel.textContent = clickLabel;
target.style.left = targetX + "%";
target.style.top = targetY + "%";
// Motion runs on transforms only (x/y px), never left/top: layout
// props snap to integer device pixels under the seek-by-frame
// capture engine and stutter on slow/eased motion. Stage size is
// read once, synchronously, at load (deterministic: fixed viewport
// per render, no resize mid-render) to convert the percent-based
// target/off-screen positions (percent of the HOST box, not a fixed
// 1920 stage) into the px x/y GSAP needs.
var stageW = root.clientWidth || 1920;
var stageH = root.clientHeight || 1080;
function xAt(percent) {
return (percent / 100) * stageW;
}
function yAt(percent) {
return (percent / 100) * stageH;
}
// Tip-targeting: the family arrow's tip sits at (5/24, 3/24) of its box.
// Anchoring the box by that offset makes every x/y below place the TIP.
gsap.set(cursor, { xPercent: -20.83, yPercent: -12.5 });
gsap.set(target, { xPercent: -50, yPercent: -50, scale: 1 });
// entry and exit keep fixed durations; both shrink proportionally only
// when the composition is too short to fit them.
var IN_BASE = 1.02; // 0.5s glide + 0.2s aim + 0.1s press + 0.22s release
var OUT_BASE = 0.4;
var totalBase = IN_BASE + OUT_BASE;
var IN = IN_BASE;
var OUT = OUT_BASE;
if (duration < totalBase) {
var shrink = duration / totalBase;
IN = IN_BASE * shrink;
OUT = OUT_BASE * shrink;
}
var HOLD = Math.max(0, duration - (IN + OUT));
var OUT_AT = IN + HOLD;
var shrinkFactor = IN / IN_BASE;
var glideDur = 0.5 * shrinkFactor;
var clickInDur = 0.1 * shrinkFactor;
var clickOutDur = 0.22 * shrinkFactor;
// the click lands at a fixed offset into the entry, never in the stretchable hold.
var CLICK_AT = (0.5 + 0.2) * shrinkFactor;
var TIP_ORIGIN = "20.83% 12.5%";
var offX = xAt(48);
var offY = yAt(116); // resting pose IS off-screen, below the stage
var tl = gsap.timeline({ paused: true });
// ---- IN: off-screen entry, one continuous vector, aim, then the tap ----
tl.set(cursor, { scale: 1 });
tl.set(target, { "--oc-ignite": 0 });
tl.fromTo(
cursor,
{ x: offX, y: offY },
{ x: xAt(targetX), y: yAt(targetY), duration: glideDur, ease: "power3.out" },
0,
);
tl.to(
cursor,
{ scale: 0.9, duration: clickInDur, ease: "power2.in", transformOrigin: TIP_ORIGIN },
CLICK_AT,
);
tl.to(
cursor,
{ scale: 1, duration: clickOutDur, ease: "power2.out", transformOrigin: TIP_ORIGIN },
CLICK_AT + clickInDur,
);
// ---- the click switches the target on, same frame as the release ----
tl.to(target, { scale: 0.96, duration: clickInDur, ease: "power2.in" }, CLICK_AT);
tl.to(
target,
{ scale: 1, duration: clickOutDur, ease: "power2.out" },
CLICK_AT + clickInDur,
);
tl.to(
target,
{ "--oc-ignite": 1, duration: 0.3, ease: "power2.out" },
CLICK_AT + clickInDur,
);
// ---- HOLD (elastic): settle just below the target, still pointing at it ----
var driftDur = Math.min(0.4, HOLD);
if (driftDur > 0.05) {
var cq = stageW / 100;
tl.to(
cursor,
{
x: xAt(targetX) + 2.5 * cq,
y: yAt(targetY) + 2.1 * cq,
duration: driftDur,
ease: "power2.inOut",
},
IN,
);
}
// ---- OUT: leave the frame, physically, never a fade-in-place ----
tl.to(cursor, { y: yAt(120), duration: OUT, ease: "power2.in" }, OUT_AT);
// Optional whole-stage departure on top of the cursor's own exit;
// exit none leaves the ignited target until the frame cuts.
if (exit === "fade") {
tl.to(stage, { opacity: 0, duration: OUT, ease: "power2.in" }, OUT_AT);
} else if (exit === "up") {
tl.to(stage, { opacity: 0, y: "-4cqh", duration: OUT, ease: "power2.in" }, OUT_AT);
}
tl.seek(0);
window.__timelines = window.__timelines || {};
window.__timelines[compositionId] = tl;
})();
</script>
</template>
</body>
</html>
```
</CatalogSlot>
<CatalogSlot slot="install">
<InstallCommand command="npx hyperframes add oversized-cursor" item="oversized-cursor" />
That writes one file: `compositions/components/oversized-cursor.html`.
</CatalogSlot>
</CatalogDetail>
<div data-static-slot="docs" className="prose prose-gray dark:prose-invert">
## Paste it into your composition
Open `compositions/components/oversized-cursor.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 |
| --- | --- | --- | --- |
| `cursor_variant` | `light` | `light`, `dark` | |
| `target_x` | `55` | 15% to 85%, step 1% | |
| `target_y` | `55` | 15% to 85%, step 1% | |
| `click_label` | `Generate` | string | |
| `exit` | `none` | `none`, `fade`, `up` | Optional whole-stage departure. Default none: the ignited target stays until the frame cuts. |
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="oversized-cursor"
data-composition-src="compositions/components/oversized-cursor.html"
data-variable-values='{"cursor_variant":"light","target_x":55,"target_y":55,"click_label":"Generate","exit":"none"}'
></div>
```
{/* hf:generated-footer */}
Tagged `cursor` `motion-primitive` `actor` `pointer` `interaction`.
## Related topics
- [Browse the complete Catalog](/catalog)
- [Add assets and Catalog items in the browser editor](/studio/assets-and-blocks)
- [Put blocks together into one video](/concepts/compositions)
</div>