# Global Search (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-global-search` · version 1.0.0 · component · pro (All-Access)
- category: Navigation
- build: Base UI (one set of files; its dependencies follow the build)
- install (this build): `npx shadcn@latest add @beautiful-ui-pro/lumen-global-search`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui-pro/lumen-command, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-global-search
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

One place to jump to a page, run an action or find a record: fixed items matched as you type, async record search that's debounced and cancels stale calls, recent picks, grouped results with the matched text lit, loading and empty states in words, ⌘K from anywhere and a full-screen palette on phones.

## Build it
- Stack: React 19 (`ref` is a plain prop), TypeScript, Tailwind CSS v4 utilities, a shadcn-initialised project with the `@/*` alias.
- Packages: none beyond React.
- Files: `components/ui/lumen/controls/global-search.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-command`, `lumen-foundation`.
- Builds: one set of files for both, but its dependencies come in Base UI and Radix builds. Install the one that matches the project (see Install): a free item's bare URL installs the Base UI build of it and its dependencies.
- Exports to keep: `GlobalSearch`, and every exported type.
- CSS: the install merges this item's rules (the registry `css` field) into your global stylesheet, in `@layer components`, and adds the lumen foundation (tokens, keyframes, motion levels) once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Tokens: retheme with the `--lumen-*` custom properties (`--lumen-accent`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-focus`, `--lumen-good`, `--lumen-good-text`, `--lumen-hairline`, `--lumen-ink`, `--lumen-muted-ink`, `--lumen-series-1`, `--lumen-series-2`, `--lumen-series-3`, `--lumen-series-4`, `--lumen-series-5`, `--lumen-series-6`, `--lumen-warn`, `--lumen-warn-text`); this item's CSS also reads `--lumen-font-mono`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

```tsx
import { GlobalSearch } from "@/components/ui/lumen/controls/global-search";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `GlobalSearch` | — | The trigger, the hotkeys and the search palette. |

## Sound
- Keep every `data-slot` and `data-sound` attribute: the sound layer reads them.
- Installing this item adds no audio. Nothing plays until the app mounts `GlassSoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/glass-sound.json`, import from `@/components/beautiful-ui/glass-sound`); `GlassSoundToggle` is its mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/lumen/controls/global-search.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when
- global search, command palette, cmd k, search bar, jump to, quick actions, record search, spotlight, Lumen
- An app with enough pages, actions or records that people want to type rather than click

### Not when
- Filtering one list: use the Filter Bar
- A handful of links: use navigation

## Mistakes
- Pass the AbortSignal to fetch, so slow answers never overwrite newer ones
- Give pages keywords people actually type ("billing", not only "Plans and invoices")

## Usage

```tsx
import { GlobalSearch } from "@/components/ui/lumen/controls/global-search";

<GlobalSearch
  recentKey="app-search"
  onNavigate={(href) => router.push(href)}
  sources={[
    { id: "pages", label: "Pages", items: [{ id: "billing", title: "Plans and invoices", href: "/settings/billing", keywords: ["billing"] }] },
    { id: "accounts", label: "Accounts", search: (q, signal) => fetch(`/api/accounts?q=${q}`, { signal }).then((r) => r.json()) },
  ]}
/>
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `sources` | `SearchSource[]` |  | Each is { id, label } plus items (matched as you type) or search(query, signal) (async, debounced, stale calls aborted); minQuery and limit per source. |
| `SearchResult` | `{ id, title, subtitle?, icon?, href?, onSelect?, keywords?, shortcut? }` |  | A result: href navigates (through onNavigate); onSelect runs an action. |
| `onNavigate` | `(href: string) => void` |  | Pass your router's push. Default: a full page load. |
| `recentKey` | `string` |  | Remember recent picks (with an href) in localStorage under this key. |
| `hotkey` | `boolean` | `true` | ⌘K / Ctrl+K anywhere, and / when not typing, open it. |
| `debounceMs` | `number` | `180` | The pause before async sources search. |
| `labels` | `Partial<Labels>` |  | Every word, for i18n. |

Full docs: https://beautiful-ui.dev/components/lumen-global-search

## Customising
- Colours: set the `--lumen-*` tokens on `:root`, or on a container with the `lumen-scope` class to retheme one area. Add the `lumen-inherit` class to follow your shadcn palette instead (`--chart-N`, `--destructive`).
- Dark mode follows the `.dark` class on an ancestor (the shadcn and next-themes convention).
- Update later by re-running the install with `--overwrite` (review the diff if you edited it). Changelog: https://beautiful-ui.dev/r/changelog.json

## Keyboard

| Keys | Action |
|---|---|
| ⌘K / Ctrl+K, / | Open from anywhere |
| ↑ / ↓ | Move through results (loops) |
| Enter | Open or run the result |
| Escape | Close |

## Motion inventory

| Interaction | What moves |
|---|---|
| Move | The lens glides to the highlighted result with a lit filament |
| Searching | A scan line crosses the source's row; still under reduced motion |

## Accessibility contract (preserve when editing)
- A labelled dialog with a combobox and listbox (cmdk)
- Groups are labelled; loading and failures are status rows in words
- The trigger names its shortcut (aria-keyshortcuts)
- Nothing is announced mid-typing except results changing

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-global-search
```

Pro item: needs the `@beautiful-ui-pro` registry in `components.json` and `BEAUTIFUL_UI_TOKEN` in `.env.local` (https://beautiful-ui.dev/account). Setup: https://beautiful-ui.dev/docs/pro. Your components.json `style` picks the build: radix-*, new-york and default get Radix, base-* gets Base UI.

## Credits
- cmdk (https://cmdk.paco.me)
- Built on shadcn/ui (https://ui.shadcn.com)

The lumen foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://beautiful-ui.dev/r/lumen-foundation.json.