Files
heygen-com__hyperframes/docs/primitives/whiteboard-ink.mdx
Miguel Angel Simon Sierra bb912587b9 feat(primitives): add 25 video primitives, live docs pages, and the catalog retrieval eval
Adds the 25 video primitive compositions and their generated Mintlify pages.
Each page embeds a live <hyperframes-player> preview with editable composition
variables rather than a rendered MP4.

Adds the catalog-browsing eval under evals/catalog-retrieval: a 424-entry shelf
built from HEAD, nine retrieval conditions (no-catalog control, full read,
lexical, semantic, and hybrid across several values of k), a brief generator
that constructs each brief from a known target, a blind three-pass gold
validation committee, and a mechanical scorer that keeps mountable and fit as
two separate numbers.

The eval vendors its own shelf, primitive sources, and preview list instead of
reading them from an ignored working directory, so the shelf regenerates byte
for byte from a clean checkout. Derived artifacts stay out: the embedding cache
and the run checkpoints are regenerated rather than committed, so no run can
score against a stale copy of either.

Lint ignores now cover vendored minified player bundles by pattern instead of
one path at a time.
2026-07-31 12:27:41 +02:00

44 lines
1.4 KiB
Plaintext

---
title: "Whiteboard Ink"
description: "SVG paths draw one stroke at a time while a pen nib follows each active path tip and hops between strokes."
---
import { PrimitivePlayer } from "/snippets/PrimitivePlayer.jsx";
<span className="hf-primitive-eyebrow">Annotation</span>
<PrimitivePlayer name="whiteboard-ink" width={1920} height={1080} />
## Variables
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `sketch` | `enum` | `bulb` | Authored preset sketch to draw. Ignored when the strokes slot holds custom paths. |
| `caption` | `string` | `Draw the idea` | Short line shown after the sketch completes. |
| `pen` | `enum` | `show` | Show or hide the pen nib actor. |
| `accent` | `enum` | `green` | Color used by strokes marked data-ink=accent (one highlight stroke in each preset). |
| `exit` | `enum` | `none` | How the completed lockup leaves. none holds the final frame. |
## When to use it
A preset or caller-supplied SVG sketch needs sequential ink drawing with a traveling pen actor and a caption after completion.
## When to avoid it
Avoid supplying non-path slot content, because only path elements inside the strokes group become the drawing.
## Pairs with
- [marker-highlight](/primitives/marker-highlight)
- [plan-room-audit](/primitives/plan-room-audit)
## Install
<CodeGroup>
```bash Terminal
npx hyperframes add whiteboard-ink
```
</CodeGroup>