Number Field
A numeric input with increment/decrement controls and built-in scrubbing. Wraps @base-ui/react/number-field. Re-exports the compositional parts (Root, Group, Increment, Input, Decrement, ScrubArea) under DS-styled wrappers without owning state.
Preview
Rendered from the story the storybook (a11y) CI gate runs axe against — the preview can't show something that hasn't been verified.
Install
Two equivalent paths — the URL works in any shadcn-CLI setup; the alias works once you've registered @interlace in your components.json.
npx shadcn@latest add https://ds.interlace.tools/r/number-field.jsonnpx shadcn@latest add @interlace/number-fieldBehavior
What this component does — the keyboard path, the measured colour, the text equivalent and the states it can be in. Every figure below is read out of the test or the source that enforces it by scripts/build-behavior-map.mjs, so nothing here can outlive the gate that keeps it true.
Measured contrast
packages/ui/__tests__/theme-contract-lock.test.ts ↗Every semantic colour pair this component's own source uses, measured against the shipped hexes in all 4 theme × scheme combinations. The tightest is input on card at 3.11:1 (interlace · dark), against a floor of 3:1.
| Pair | interlacelight | interlacedark | harborlight | harbordark | Floor |
|---|---|---|---|---|---|
| input on cardcontrol border inside a card | 3.62:1 | 3.11:1 | 3.62:1 | 3.85:1 | 3.0:1SC 1.4.11 |
| input on backgroundcontrol border (SC 1.4.11) | 3.62:1 | 3.35:1 | 3.43:1 | 4.25:1 | 3.0:1SC 1.4.11 |
| ring on backgroundfocus ring (SC 2.4.13) | 8.80:1 | 11.79:1 | 8.39:1 | 10.03:1 | 3.0:1SC 1.4.11 |
| ring on cardfocus ring inside a card | 8.80:1 | 10.92:1 | 8.86:1 | 9.10:1 | 3.0:1SC 1.4.11 |
Text pairs are held to 4.5:1 (WCAG 2.2 SC 1.4.3); borders, rings and chart axes to 3:1 (SC 1.4.11 non-text). Bold is the worst cell in the row — the one a brand fork has to keep an eye on.
Runtime contract
packages/ui/vitest.config.ts ↗Where it renders, how narrow it survives, and whether its lines are inside the coverage gate — three answers a consumer needs before the paste, not after the bug.
- Render boundary
'use client'Hydrates. It brings JavaScript to any route that imports it — put the boundary here, not at the page.
- Minimum viewport
MIN_VIEWPORT = 320Declared, not assumed. Below 320 CSS px the preflight contract draws a dev-mode outline — how to switch it on.
- Coverage gate
not in the gateThe 100% gate currently covers
src/charts/**/*.{ts,tsx}andsrc/lib/**/*.{ts,tsx}andsrc/primitives/{button-variants,data-state-model,meter-scale,skeleton-variants}.tsandsrc/primitives/{alert,aspect-ratio,avatar,badge,box,breadcrumb,button,callout,card,checkbox,container,data-state,focus-ring,grade-badge,grid,input,label,meter,pagination,published-date,reading-time,section,section-boundary,separator,skip-link,stack,stat-strip,tag,textarea,typography,visually-hidden}.tsx. This file is outside it — the glob widens in phase 7.2.
History
This component is at v1.1.0, first shipped in @interlace/ui 1.0.0. The version is stamped as a banner into the file the install writes, so the copy in your tree says which one you have — compare it with the number above before deciding whether to re-run the install.
@interlace/ui 1.0.01 entry
- Addedminor
The component floor reaches every tier: form, overlay, navigation and display primitives were modelled to the portable 26-rule floor with skeletons, locked breakpoints, and AA contrast measured per composite rather than eyeballed.
Components- @interlace/input
- @interlace/textarea
- @interlace/select
- @interlace/checkbox
- @interlace/radio-group
- @interlace/switch
- @interlace/slider
- @interlace/form
- @interlace/label
- @interlace/dialog
- @interlace/alert-dialog
- @interlace/sheet
- @interlace/popover
- @interlace/tooltip
- @interlace/hover-card
- @interlace/dropdown-menu
- @interlace/context-menu
- @interlace/tabs
- @interlace/accordion
- @interlace/collapsible
- @interlace/breadcrumb
- @interlace/pagination
- @interlace/toast
- @interlace/card
- @interlace/badge
- @interlace/avatar
- @interlace/alert
- @interlace/separator
- @interlace/progress
- @interlace/skeleton
Import
7 named exports — pull the parts you need.
import { MIN_VIEWPORT, NumberField, NumberFieldDecrement, NumberFieldGroup, NumberFieldIncrement, NumberFieldInput, NumberFieldScrubArea } from '@/components/ui/number-field';Anatomy
Extracted from the primitive's JSDoc header. The source is the only documentation that can't drift.
NumberField (Root) (div — data-min-viewport=320)
├─ NumberFieldScrubArea (optional drag-to-scrub region)
└─ NumberFieldGroup (the visible button group)
├─ NumberFieldDecrement (minus button)
├─ NumberFieldInput (the actual number input)
└─ NumberFieldIncrement (plus button)Accessibility
Every story for this component is rendered headlessly and checked with axe-core (wcag2aa, wcag22aa, best-practice, ACT) on every PR. That gate has no continue-on-error, so what ships has zero known violations.
What follows is what static analysis can see. Axe cannot press a key and never sees an overlay open, so the operable-without-a-mouse claim lives in Behavior instead, where the keyboard path is replayed step by step.
- Focus + keyboard behaviour
- Owned by @base-ui/react/number-field — focus trapping, dismissal and typeahead come from the headless primitive, not from us.
- Focus ring (WCAG 2.2 SC 2.4.13)
- Not focusable — no focus indicator required.
- Reduced motion
- No animation to gate.
- ARIA in the source
- None — semantics come from the element or the Base UI primitive rather than hand-written ARIA.
Examples
5 more states from the same story file.
R-rule compliance
Every primitive in @interlace/ui models to the portable 26-rule floor enforced by the componentApi ESLint preset. The cells below pin exactly where each rule applies in this file.
| Rule | Concept | Where |
|---|---|---|
| R4 | Extends Base UI part props | each wrapper extends `React.ComponentProps<typeof BaseNF.X>` |
| R6 | data-slot per part | number-field / -group / -input / -increment / -decrement |
| R7 | cn + ...rest | `cn(BASE, className)` + `{...props}` |
| R12 | Reuse over wrap | Base UI owns scrub + keyboard + clamping |
| R14 | Declares min viewport | `data-min-viewport={String(MIN_VIEWPORT)}` + exported const |
| R19 | Tokens only | border-input, bg-background, ring-ring — semantic tokens |
| R25 | Client component | Required — Base UI NumberField ships client hooks |
| R26 | A11y from upstream | aria-valuenow, aria-valuemin, aria-valuemax handled |
Minimum viewport
This primitive declares MIN_VIEWPORT = 320 CSS px (DESIGN_PRINCIPLES #14). When mounted in a container narrower than this, the preflight contract draws a dev-mode outline so the regression is visible during local development.
<body data-interlace-dev>...</body>
Add the data-interlace-dev attribute to the body in development builds only — preflight then outlines any primitive whose container is below its declared data-min-viewport.
Dependencies
- Base UI primitive
- @base-ui/react/number-field
- Lucide icons
- none
- NPM dependencies
@base-ui/react
- Registry dependencies
Source
The full implementation — components/ui/number-field.tsx once installed.
'use client';
import * as React from 'react';
// @interlace/number-field v1.1.0 — Interlace design system.
// Docs, props and live preview: https://ds.interlace.tools/c/number-field
// What changed since: https://ds.interlace.tools/c/number-field#history
// Generated banner — keep it, the upgrade diff reads this version.
/**
* @interlace/ui — NumberField
*
* A numeric input with increment/decrement controls and built-in scrubbing.
* Wraps @base-ui/react/number-field. Re-exports the compositional parts
* (Root, Group, Increment, Input, Decrement, ScrubArea) under DS-styled
* wrappers without owning state.
*
* ## Anatomy
*
* NumberField (Root) (div — data-min-viewport=320)
…149 more lines…Registry JSON
The raw registry record — what the shadcn CLI fetches.