# Number Field (Notchset): prompt.md (v1.0.0)

- id: `number-field` · 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/number-field`
- npm dependencies: none
- registry dependencies: utils, https://beautiful-ui.dev/r/notchset-foundation.json
- docs: https://beautiful-ui.dev/components/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 − value + field whose digits roll on strips, with hold-to-repeat keys, a scrubbable ruler and a running total; plus NumberNodes, a small range as nodes on a rule.

## 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/notchset/number-field.tsx`; shared code: `lib/beautiful-ui/notchset/instrument.tsx`, `lib/beautiful-ui/notchset/root.ts`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-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`, `NumberNodes`, and every exported type.
- CSS: the install adds the notchset foundation (tokens, keyframes, motion levels) to your global stylesheet 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 `--notchset-*` custom properties (`--notchset-check`, `--notchset-control-edge`, `--notchset-draw-from`, `--notchset-ease-bloom`, `--notchset-ease-travel`, `--notchset-fade`, `--notchset-focus-color`, `--notchset-focus-inset`, `--notchset-life-from`, `--notchset-life-ms`, `--notchset-node-blink`, `--notchset-node-bloom`, `--notchset-node-delay`, `--notchset-plate-color`, `--notchset-rise-from`, `--notchset-rule`, `--notchset-scroll`, `--notchset-signal`, `--notchset-sweep-to`). Never add Tailwind colour classes inside the component.

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

## Parts

| Part | data-slot | What it is for |
|---|---|---|
| `NumberField` | `number-field` | The field. |
| `NumberNodes` | `number-nodes` | The node picker. |

Style a part with `[data-slot="<slot>"]` selectors or its `className`; keep the attributes when editing.

## 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 `SoundProvider` once (install: `npx shadcn@latest add https://beautiful-ui.dev/r/notchset-sound.json`, import from `@/components/ui/notchset/sound-provider`); `useSound()` gives `muted` and `setMuted` for a mute control. Without a provider the audio engine never loads.

## Match the original
- Read `components/ui/notchset/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 field, stepper, quantity, seats, spinbutton, number input, Notchset
- Seats, limits, quantities: a number people nudge

### Not when
- Free-form numbers like prices: use Input with inputMode=decimal

## Mistakes
- Pass valueText for anything the number alone doesn't say ("7 seats, $98 per month")

## Usage

```tsx
"use client";

import * as React from "react";
import { NumberField } from "@/components/ui/notchset/number-field";

export function SeatCount() {
  const [seats, setSeats] = React.useState(5);
  return <NumberField value={seats} onValueChange={setSeats} min={1} max={50} label="SEATS" unit={(v) => (v === 1 ? "SEAT" : "SEATS")} ruler />;
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `value / onValueChange` | `number / fn` |  | Controlled. |
| `min / max / step / largeStep` | `number` |  | Limits and steps (PgUp/PgDn use largeStep). |
| `unit / help / total` | `node or (value) => node` |  | The unit beside the value; the lines under it. |
| `ruler / rulerLabels` | `boolean / number[]` |  | The scrubbable ruler. |
| `NumberNodes` | `{ value, onValueChange, min, max, label, meta }` |  | A radio group of nodes for 0–5 style ranges. |

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

## Customising
- Colours: the component reads your shadcn tokens (`--background`, `--foreground`, `--border` …), refined by the `--notchset-*` tokens. The signal colour is `--notchset-signal` (it falls back to `--destructive`). Set tokens on `:root`, or on any container to retheme one area.
- 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 |
|---|---|
| ↑ / → and ↓ / ← | Step |
| PgUp / PgDn | Step by five |
| Home / End | Limits |

## Performance

- Digits are transforms; repeat and scrub write one state update per step.

## Responsive

- Fills its container; the ruler scales with it. Keys grow to 44px on touch screens.

## Motion inventory

| Interaction | What moves |
|---|---|
| Step | Digits roll on 0–9 strips (340ms settle); a tick per step |
| Hold | One step, then every 70ms after 380ms |
| Scrub | The ruler follows the pointer with no transition |

## Accessibility contract (preserve when editing)
- The value is a spinbutton with min, max, now and an optional valuetext
- ± keys are labelled and disabled at the limits
- NumberNodes is a radio group; arrows move and pick

## Install

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