Ink Autosave, animated React component
A note that shows its save state as ink. What is saved is dry black ink; what you have typed since is wet blue at the end of the rule. Pause and it dries left to right. Go offline and it dries grey with a drop hanging off the nib, which falls in when you reconnect.
- Pro
- Inputs & Controls
- Spring
Play with it
Move the controls and watch it change. Copy code gives you a snippet with only the props you changed.
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| autoplay | boolean | false | Writes a line by itself and goes offline and back, until the visitor touches the note. Never runs under reduced motion and pauses while the card is off screen. |
| save | (text: string) => Promise<void> | — | Called about a second after typing pauses. Resolve it when the text is stored; the ink dries when it does. Left out, the note pretends to save for under half a second. |
| initial | string | a sample note | Starting text of the note. |
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
Ink Autosave 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