structyl

Number Field

stable

A numeric input with stepper buttons and Intl formatting.

Basic usage

Examples

Quantity selector

A controlled number field used as a cart quantity input.

Quantities and currency

NumberField supports min, max, step and Intl formatting options.

Features

  • Min / max / step.
  • Keyboard + wheel support.

Installation

bash
pnpm dlx structyl add number-field

API Reference

NumberField.Root

Numeric input with steppers and Intl formatting.

PropTypeDefault
valuenumber

Controlled value.

defaultValuenumber

Initial value when uncontrolled.

onValueChange(value?: number) => void

Called when the value changes.

minnumber

Minimum allowed value.

maxnumber

Maximum allowed value.

stepnumber

Increment / decrement amount.

1
formatOptionsIntl.NumberFormatOptions

Number formatting options.

disabledboolean

Disable the field.

false

NumberField.Input

The text input with role="spinbutton".

PropTypeDefault

NumberField.IncrementTrigger

Button that increases the value.

PropTypeDefault

NumberField.DecrementTrigger

Button that decreases the value.

PropTypeDefault
Number Field | structyl