Files
hyperframes/docs/primitives/marker-highlight.mdx
T
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

45 lines
1.5 KiB
Plaintext

---
title: "Marker Highlight"
description: "A short display line settles in, then one SVG marker stroke draws over the first matched word or phrase."
---
import { PrimitivePlayer } from "/snippets/PrimitivePlayer.jsx";
<span className="hf-primitive-eyebrow">Annotation</span>
<PrimitivePlayer name="marker-highlight" width={1920} height={1080} />
## Variables
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `text` | `string` | `Ship it with confidence` | Full line of display text. |
| `emphasis_word` | `string` | `confidence` | First case-insensitive substring match in text receives the marker. Empty or unmatched draws no marker. |
| `style` | `enum` | `highlight` | Shape of the hand-drawn marker stroke. |
| `draw_at` | `number` | `0.9` | Second (from mount start) the marker starts drawing. Clamped so the stroke completes before any exit. |
| `accent` | `enum` | `green` | Marker ink color from the contract token map. |
| `exit` | `enum` | `none` | Optional departure. Default none: the lockup holds until the frame cuts. |
## When to use it
One specific word or short phrase in a single line needs a timed highlight, circle, underline, or scribble.
## When to avoid it
Avoid it when the emphasized phrase must wrap, because the header requires the match to stay on one line.
## Pairs with
- [kinetic-type-swap](/primitives/kinetic-type-swap)
- [receipt-card](/primitives/receipt-card)
## Install
<CodeGroup>
```bash Terminal
npx hyperframes add marker-highlight
```
</CodeGroup>