Annotate Text, animated React component
A paragraph that someone marks up as you watch: a highlighter sweeps one phrase, a red pen rings a word and strikes out another, a blue pen underlines twice and a green one boxes off the last phrase, each stroke drawn at the speed of a hand with the wobble and overshoot of real ink.
- Pro
- Motion Effects
- Scroll
The faint scratch of a pen and the swish of a highlighter with each stroke. Sound is off on this site until you switch it on.
Play with it
Move the controls and watch it change. Copy code gives you a snippet with only the props you changed.
Most software asks for your attention. Good software earns it: it is quiet, it remembers where you left off, and it answers the question you were about to ask. Nothing about it is clever for its own sake. It simply works, every single time, and then it gets out of the way.
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| segments | AnnotateSegment[] | sample data | The paragraph as pieces: { text, mark?, color? }. Pieces without a mark are plain text. |
| stagger | number | 0.75 | Seconds between one mark and the next. |
| enableSound | boolean | true | Soft synthesised sounds as you use it. They also follow the site-wide sound switch. |
| volume | number | 0.6 | Sound level, 0 to 1. |
| autoplay | boolean | false | Plays a short demo by itself until the visitor touches it. Never runs under reduced motion. |
| className | string | "" | Extra classes for the outer element. |
Add it to your project
- 1
Set up your project once
You need a Next.js project with Tailwind CSS and the
@/import alias. In its root folder, run this once. It createscomponents.jsonand thecn()helper insrc/lib/utils.ts:npx shadcn@latest init -d
Starting from nothing? The Quick Start walks through the whole thing.
- 2
Connect the registry with your API key
Annotate Text is a Pro item, so the CLI has to send your API key. Do this once per project:
- Create a key at nexus-ui.com/dashboard/api-key. Copy it straight away: it starts with
nxs_and is shown only once. - In your project root, next to
package.json, create a file named.env.localwith this line, using your own key:NEXUS_API_KEY=nxs_your_key_here
- Open
components.jsonand add this entry inside the outermost braces, next to"aliases". Leave{name}and${NEXUS_API_KEY}exactly as written; the CLI fills them in:"registries": { "@nexus-labs": { "url": "https://www.nexus-ui.com/api/registry/{name}", "headers": { "Authorization": "Bearer ${NEXUS_API_KEY}" } } }
- Create a key at nexus-ui.com/dashboard/api-key. Copy it straight away: it starts with
How Annotate Text works
A paragraph that someone marks up as you watch. A highlighter sweeps across one phrase, a red pen rings a word and strikes out another, a blue pen underlines twice and a green one boxes off the last phrase, each stroke drawn Replay draws it again. Marks follow the text when it reflows.
The source, the install command and the build prompt come with Pro.
Annotate Text questions
Does it make sound, and how do I turn it off?
The faint scratch of a pen and the swish of a highlighter with each stroke. Sounds are synthesised with the Web Audio API, so there are no audio files, and they only play after a click or key press. Pass `enableSound={false}` to silence this component, or call `setSoundsEnabled(false)` from `@/lib/ui-sounds` to switch every sound off at once. The CLI installs `@/lib/ui-sounds` with the component.