Skip to content

NumberField

A wrapper around React Aria’s NumberField component. Provides keyboard-accessible increment/decrement buttons and locale-aware number formatting.

Terminal window
npx @a2ra/cli add number-field
{
"type": "NumberField",
"props": {
"label": "Quantity",
"name": "qty",
"minValue": 1,
"maxValue": 100,
"step": 1,
"defaultValue": 1
}
}
PropTypeDescription
labelstringVisible label
placeholderstringPlaceholder text
minValuenumberMinimum allowed value
maxValuenumberMaximum allowed value
stepnumberIncrement/decrement step
valuenumberControlled value
defaultValuenumberUncontrolled default
namestringForm field name
isRequiredtrue
false default
Marks field as required
isDisabledtrue
false default
Disables the input
isReadOnlytrue
false default
Prevents editing
isInvalidtrue
false default
Shows error styling
isWheelDisabledtrue
false default
Prevents mouse wheel from changing the value
validationBehavioraria default
native
Validation reporting strategy
descriptionstringHelper text
errorMessagestringError text shown when isInvalid is true
  • isWheelDisabled: true is recommended in forms to prevent accidental value changes when the user scrolls the page.
  • The increment/decrement buttons are keyboard-accessible and ARIA-labelled automatically.