Search Modal, animated React component
A search field that opens into results, with photos for projects and faces for people. Matching letters light up, the best match gets a card of its own, and a highlight glides between rows as you use the arrow keys.
- Pro
- Inputs & Controls
Soft ticks as the highlight moves and a chime when you open a result. 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.
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| items | SearchItem[] | sample data | What can be found: { id, kind, title, meta, image?, tint? }. |
| hints | string[] | ["Lofoten", "Patagonia brief", "Ines", "pricing"] | Phrases that roll through the empty field. |
| onOpen | (item: SearchItem) => void | — | Called with the chosen item. |
| 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
Search Modal 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 Search Modal works
A search field that drops open into a results card. Focus it (or press Command or Control K anywhere) and the card pours down with a sliding scope control whose counts update live, your recent things as soft cards and suggestions. Type and the results reshuffle smoothly: a featured top result with a big thumbnail, then grouped rows with the
The source, the install command and the build prompt come with Pro.
Search Modal questions
Does it make sound, and how do I turn it off?
Soft ticks as the highlight moves and a chime when you open a result. 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.