Orb Nav, animated React component
A minimal navigation bar: a name, plain links, a search icon and one flat button over a hairline, no container and no shadow. Its mark is a small ball of smoked crystal with glowing filaments of cyan, violet, magenta and gold inside, refracting the room and fringing with colour at its edge. Your pointer is its lamp, pointing at a link tints its light, and pressing it turns the bar into search. A larger piece stands on the page with a natural shadow. Drawn per pixel at the screen's real resolution, sharper when you zoom.
- Pro
- Navbars
- Hover
A soft glassy chime as the orb wakes into search. 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.
Collection
Fourteen pieces, blown this winter.
Props
| Prop | Type | Default | What it does |
|---|---|---|---|
| brand | string | "Lumen" | The name beside the orb. |
| items | OrbNavItem[] | sample data | The links: { id, label, accent, line? }, where accent tints the orb's light. |
| defaultActive | string | — | The id of the link marked as current. |
| cta | string | "Book a visit" | The button's label. |
| suggestions | OrbNavSuggestion[] | sample data | Suggestions offered in search: { label, hint, go? }. |
| onNavigate | (id: string) => void | — | Called with a link's id. |
| onAsk | (question: string) => void | — | Called with what was typed into search. |
| bare | boolean | false | Leave out the studio scene behind the bar, for use at the top of a real page. |
| enableSound | boolean | true | Soft synthesised sounds as you use it. They also follow the site-wide sound switch. |
| volume | number | 0.8 | 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
Orb Nav 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 Orb Nav works
A minimal navigation bar whose mark is a small ball of smoked crystal with glowing filaments inside it. The bar itself is nothing but the ball and the name, plain links (the current one underlined with a hairline), a pointer is its lamp, so its sheen follows you, pointing at a link tints the light inside it, and pressing it turns the bar into search (the ball glows brighter and every key sends a ring of light through it).
The source, the install command and the build prompt come with Pro.
Orb Nav questions
Does it make sound, and how do I turn it off?
A soft glassy chime as the orb wakes into search. 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.