# Number Field (Lumen Halo): prompt.md (v1.0.0)

- id: `lumen-number-field` · version 1.0.0 · component · pro (All-Access)
- 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-number-field`
- npm dependencies: none
- registry dependencies: utils, @beautiful-ui/lumen-input-group, https://beautiful-ui.dev/r/lumen-foundation.json
- docs: https://beautiful-ui.dev/components/lumen-number-field
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

A number with minus and plus steppers: arrows step, Page Up/Down step ten, Home and End go to the bounds, and typed text is read forgivingly and settles clamped to min and max and rounded to the step. The value is a number or null, never a string.

## 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/number-field.tsx`; shared code: `lib/beautiful-ui/core/fields.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `lumen-input-group`, `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: `NumberField`, 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 { NumberField } from "@/components/ui/lumen/controls/number-field";
```

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `NumberField` | — | The field. |

## 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/number-field.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
- number input, quantity stepper, seats, spin button, numeric field, Lumen
- Forms that need this input done properly, with its states and keyboard

### Not when
- A plain text value: use Input

## Mistakes
- Give it a label (a Label, or aria-label)
- Keep the value in your state; it's controlled or uncontrolled like any input

## Usage

```tsx
import { NumberField } from "@/components/ui/lumen/controls/number-field";

<NumberField value={seats} onValueChange={setSeats} min={1} max={500} unit="seats" aria-label="Seats" />
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value / defaultValue / onValueChange` | `number \| null` |  | The number (null when empty). |
| `min / max / step` | `number` | `none / none / 1` | Bounds and step; decimals follow the step (0.1 steps stay clean). |
| `format / locale / unit` | `Intl.NumberFormatOptions / string / string` |  | How it reads when not being edited, and words after it, like seats. |
| `disabled / id / aria-label` | `…` |  | As an input. |

Full docs: https://beautiful-ui.dev/components/lumen-number-field

## 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 |
|---|---|
| ↑ / ↓ | Step |
| Page Up / Page Down | Step ten |
| Home / End | Min / max |

## Motion inventory

| Interaction | What moves |
|---|---|
| Focus | The field's lit ring |

## Accessibility contract (preserve when editing)
- A spinbutton with its value, bounds and value text
- The stepper buttons are named and skip the tab order (the arrows do the same)

## Install

```bash
npx shadcn@latest add @beautiful-ui-pro/lumen-number-field
```

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.