Project Index, animated React component
An editorial index of projects in big type. Point at a project and its picture arrives beside your pointer and follows it, leaning with your movement; move to another and the picture changes square by square in a sweeping, scattered order, like a screen redrawing. The other names fade back so the one you are on stands out.
- Pro
- Motion Effects
- Hover
A soft tick as the picture changes. 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 |
|---|---|---|---|
| projects | IndexProject[] | sample data | The projects: { name, kind, year, image?, href? }. |
| photos | { src: string; title: string }[] | — | Pictures to use when a project has none, in order. |
| title | string | "Selected work" | The heading. |
| onOpen | (p: IndexProject) => void | — | Called when a project is chosen. |
| 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
Project Index 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 Project Index works
An editorial index of projects in big type. Point at a project and its picture arrives beside your pointer and slightly scattered order, like a screen redrawing, with grain over it. The other names fade back so the one you are on stands out. Works by keyboard too: focus a row and its picture appears beside it.
The source, the install command and the build prompt come with Pro.
Project Index questions
Does it make sound, and how do I turn it off?
A soft tick as the picture changes. 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.