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

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

Search that takes no room until it's needed: an icon in a top bar opens, in place, into a Search Box that grows from where the icon sits, with results underneath that arrow keys walk. Escape or a click away folds it back to the icon and keeps what you typed.

## 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/compact-search.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-search-box`, `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: `CompactSearch`, 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-foreground`, `--lumen-accent-text`, `--lumen-bad`, `--lumen-bad-text`, `--lumen-chart-accent`, `--lumen-chart-accent-foreground`, `--lumen-chart-accent-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-compact-w`, `--lumen-font-sans`, `--lumen-radius-k`. Never add Tailwind colour classes inside the component.

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

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `CompactSearch` | — | The icon, the field and the results. |

## 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/compact-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
- expanding search, collapsible search, search icon, header search, top bar search, mobile search, Lumen
- Crowded top bars and toolbars where a full field doesn't fit until someone wants it

### Not when
- A page whose main job is search: show Search Box open
- App-wide search with commands: use Command Palette

## Mistakes
- Give it a width that fits your bar; the field never exceeds the screen

## Usage

```tsx
"use client";

import * as React from "react";
import { CompactSearch } from "@/components/ui/lumen/controls/compact-search";

export function TopBarSearch({ pages }: { pages: { id: string; label: string }[] }) {
  const [q, setQ] = React.useState("");
  const hits = pages.filter((p) => p.label.toLowerCase().includes(q.toLowerCase()));
  return <CompactSearch value={q} onValueChange={setQ} results={hits} onResultSelect={(hit) => console.log(hit.id)} />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `results / onResultSelect` | `{ id, label, description? }[]` |  | Listed under the field while there's a query; Enter or a click selects. |
| `value / defaultValue / onValueChange` | `string` |  | The query, controlled or not (kept while folded). |
| `expanded / defaultExpanded / onExpandedChange` | `boolean` |  | Open or folded, controlled or not. |
| `width` | `number` | `280` | The open width in px (it never exceeds the screen). |
| `loading / placeholder / label` | `Search Box props` | `"Search"` | label names the icon button and the field. |

Full docs: https://beautiful-ui.dev/components/lumen-compact-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 |
|---|---|
| Enter or Space (icon) | Open |
| Arrow down / up, Enter | Walk and pick a result |
| Escape | Clear; again to fold |

## Motion inventory

| Interaction | What moves |
|---|---|
| Open | The well grows toward the start from the icon's cell; the icon hands over without the bar moving |

## Accessibility contract (preserve when editing)
- The icon is a named button with aria-expanded; opening focuses the field, folding returns focus to the icon
- Results are a listbox the field points at (aria-activedescendant), so arrow keys never leave the field

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-compact-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
- 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.