NumberInput

Numeric field with increment and decrement steppers. Built on React Aria NumberField with a stepper group for keyboard- and pointer-friendly adjustments. Prefer this over a plain text field when the value must stay numeric.

Examples

Default

Pass a label and seed with defaultValue (or control via value / onChange).

Quantity

import { NumberInput } from '@var-ui/react';

<NumberInput label="Quantity" defaultValue={1} />

Bounds and step

Clamp the range with minValue / maxValue and set step for how far each stepper click (or arrow key) moves.

Quantity

Between 0 and 10

import { NumberInput } from '@var-ui/react';

<NumberInput
  label="Quantity"
  defaultValue={1}
  minValue={0}
  maxValue={10}
  step={1}
  description="Between 0 and 10"
/>

Props

Accessibility

Built on React Aria NumberField. The increment and decrement controls expose aria-labels (“Increase” / “Decrease”). Pair with label, and use description / errorMessage so assistive tech gets the same help and validation copy as sighted users. Arrow keys adjust the value within any configured bounds.

Props

Prop	Type	Default	Description
`className`	`string \| undefined`	—	—
`description`	`string \| undefined`	—	Helper text shown below the control when there is no error.
`errorMessage`	`string \| undefined`	—	Validation message; when set, the field is shown in an error state.
`label`	`string \| undefined`	—	Visible label rendered above the control.
`placeholder`	`string \| undefined`	—	—

React Aria props

Prop	Type	Default	Description
`aria-describedby`	`string \| undefined`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string \| undefined`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-label`	`string \| undefined`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string \| undefined`	—	Identifies the element (or elements) that labels the current element.
`autoFocus`	`boolean \| undefined`	—	Whether the element should receive focus on render.
`children`	`ChildrenOrFunction<NumberFieldRenderProps>`	—	The children of the component. A function may be provided to alter the children based on component state.
`decrementAriaLabel`	`string \| undefined`	—	A custom aria-label for the decrement button. If not provided, the localized string "Decrement" is used.
`defaultValue`	`number \| undefined`	—	The default value (uncontrolled).
`dir`	`string \| undefined`	—	—
`form`	`string \| undefined`	—	The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
`hidden`	`boolean \| undefined`	—	—
`id`	`string \| undefined`	—	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`incrementAriaLabel`	`string \| undefined`	—	A custom aria-label for the increment button. If not provided, the localized string "Increment" is used.
`inert`	`boolean \| undefined`	—	—
`isDisabled`	`boolean \| undefined`	—	Whether the input is disabled.
`isInvalid`	`boolean \| undefined`	—	Whether the input value is invalid.
`isReadOnly`	`boolean \| undefined`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean \| undefined`	—	Whether user input is required on the input before form submission.
`isWheelDisabled`	`boolean \| undefined`	—	Enables or disables changing the value with scroll.
`lang`	`string \| undefined`	—	—
`maxValue`	`number \| undefined`	—	The largest value allowed for the input.
`minValue`	`number \| undefined`	—	The smallest value allowed for the input.
`name`	`string \| undefined`	—	The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
`onAnimationEnd`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationEndCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIteration`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIterationCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStart`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStartCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onBeforeInput`	`FormEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the input value is about to be modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/beforeinput_event).
`onBlur`	`((e: FocusEvent<Element, Element>) => void) \| undefined`	—	Handler that is called when the element loses focus.
`onChange`	`((value: number) => void) \| undefined`	—	Handler that is called when the value changes.
`onClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a text composition system completes or cancels the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionend_event).
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a text composition system starts a new text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event).
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a new character is received in the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionupdate_event).
`onContextMenu`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenuCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onCopy`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user copies text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncopy).
`onCut`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user cuts text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncut).
`onDoubleClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onFocus`	`((e: FocusEvent<Element, Element>) => void) \| undefined`	—	Handler that is called when the element receives focus.
`onFocusChange`	`((isFocused: boolean) => void) \| undefined`	—	Handler that is called when the element's focus status changes.
`onGotPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onGotPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onInput`	`FormEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the input value is modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
`onKeyDown`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is pressed.
`onKeyUp`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is released.
`onLostPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onLostPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDown`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDownCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseEnter`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseLeave`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMove`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMoveCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOut`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOutCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOver`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOverCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUp`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUpCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onPaste`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user pastes text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/onpaste).
`onPointerCancel`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancelCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDown`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDownCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerEnter`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerLeave`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMove`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMoveCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOut`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOutCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOver`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOverCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUp`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUpCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onScroll`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onScrollCapture`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onSelect`	`ReactEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when text in the input is selected. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/select_event).
`onTouchCancel`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancelCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEnd`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEndCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMove`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMoveCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStart`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStartCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancel`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancelCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEnd`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEndCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRun`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRunCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStart`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStartCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheel`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheelCapture`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`render`	`DOMRenderFunction<"div", NumberFieldRenderProps> \| undefined`	—	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
`slot`	`string \| null \| undefined`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
`step`	`number \| undefined`	—	The amount that the input value changes with each increment or decrement "tick".
`style`	`StyleOrFunction<NumberFieldRenderProps> \| undefined`	—	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
`translate`	`"yes" \| "no" \| undefined`	—	—
`validate`	`((value: number) => true \| ValidationError \| null \| undefined) \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`validationBehavior`	`"native" \| "aria" \| undefined`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`value`	`number \| undefined`	—	The current value (controlled).

DOM props (2)

Prop	Type	Default	Description
`commitBehavior`	`"validate" \| "snap" \| undefined`	`'snap'`	Controls the behavior of the number field when the user blurs the field after editing. 'snap' will clamp the value to the min/max values, and snap to the nearest step value. 'validate' will not clamp the value, and will validate that the value is within the min/max range and on a valid step.
`formatOptions`	`NumberFormatOptions \| undefined`	—	Formatting options for the value displayed in the number field. This also affects what characters are allowed to be typed by the user.

Theme this component via createDesignTheme({ components: { numberInput: … } }). See Customize for the full override API.

Public classes and data attributes from @var-ui/core numberInput().

root

Name	Example	Description
`class`	`var-ui-number-input`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

label

Name	Example	Description
`class`	`var-ui-number-input__label`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

group

Name	Example	Description
`class`	`var-ui-number-input__group`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

input

Name	Example	Description
`class`	`var-ui-number-input__input`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

stepper

Name	Example	Description
`class`	`var-ui-number-input__stepper`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

description

Name	Example	Description
`class`	`var-ui-number-input__description`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

error

Name	Example	Description
`class`	`var-ui-number-input__error`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

Apply via `recipeProps(recipe(…))` or copy the class / data attributes onto your markup.