Components/Form
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/numberinput
Number inputs allow users to enter and edit numeric values in a single line input field. The value can be inserted using the keyboard or incremented using the arrow controls.
<Input/> instead.<DatePicker/> or <TimeInput/> instead.Adjust the size using the size prop. There are 3 supported sizes:
large.medium.small.Style the field using the border prop. It supports 4 styles:
standard.round.bottomLine to create an editable, underlined title field.none.Control the status of the input using the status prop. It supports 3 states:
error demonstrates that a required input is missing something or the entry was invalid.warning highlights an input value that might have a significant impact to a user.loading shows when an input value is being uploaded to the server.Add text that explains the status or what action the user should take with the statusMessage prop.
Showing the status message inline, directly below the input is preferred in all default cases.
<FormField/> and add the statusMessage.statusMessage prop. Control tooltip placement with tooltipPlacement prop.View more inline status message examples in <FormField/>.
Add text, icons or a button at the beginning or end of the input field using prefix and suffix.
Inputs can also be made read-only or disabled entirely.
readOnly disables the field, so users can't enter new values. The current value can still be copied.disabled removes all interactions and creates a disabled input state. Use it to highlight functions that are unavailable.Enable a button that lets users easily clear the input value by using the clearButton prop. Use it when the input value is optional or has to be cleared often.
Use the step prop to specify what the increments are when clicking up or down on the arrows.
The arrows controls can be hidden with hideStepper. When the arrows are hidden, the field value can still be incremented by the set step when the field is changed using the arrow keys on the keyboard.
If the user inputs something outside of the minimum or maximum, explain that it's invalid using the invalidMessage prop.
Get informed about invalid message events by using the onInvalid callback function.
Use NumberInput in controlled mode by passing value and onChange props.
The min and max properties enable built-in range validation, so no need to add onChange and value.
Users will still be able to enter invalid numbers, but will be notified that what they entered is invalid. Set the error message using invalidMessage.
Don't allow users to submit a form with an invalid input value. Use onInvalid to get an invalid event.
react-hook-form reduces the amount of code you need to write while removing unnecessary re-renders. The preview here demonstrates form validation in action while using the number input.
Use number input with other components like <Slider/> in a <FieldSet/> wrapper to group them together and let users define the exact numerical value.
Stack items next to each other with <Box/> when fields represent the same data, or when a change in one input affects one or more other fields.
Disable the arrows once the minimum or maximum value has been reached.
To help users enter the correct value, use helper text below the input which describes the constraints.
This will help prevent user errors.
| Name | Type | Default | Description |
|---|---|---|---|
ariaControls | string | — | Associate a control with the regions that it controls. |
ariaDescribedby | string | — | Associate a region with its descriptions. Similar to aria-controls but instead associating descriptions to the region and description identifiers are separated with a space. |
ariaLabel | string | — | Define a string that labels the current element in case where a text label isn't visible on the screen. |
autocomplete | string | — | Sets the value of the native autocomplete attribute, for example off or email. |
autoFocus | boolean | — | Focus the element on mount (standard React input autoFocus) |
autoSelect | boolean | — | Automatically selects the entire input text. |
backgroundColor | string | — | Sets the background color of the input. Accepts any CSS color value. |
border | "none" | "standard" | "round" | "bottomLine" | — | Control the border style of input. |
clearButton | boolean | — | Displays clear button (X) on a non-empty input. |
clearButtonAriaLabel | string | — | Aria label for the clear button. |
clearButtonTooltipContent | ReactNode | — | When provided, hovering displays a tooltip with this content. |
clearButtonTooltipProps | TooltipCommonProps | — | Clear button tooltip props. |
customInput | ReactNode | Function | — | Render a custom input instead of the default html input tag. |
dataHook | string | — | Applies a data-hook HTML attribute that can be used in the tests. |
defaultValue | string | number | — | Defines the initial value of an input. |
disabled | boolean | — | Specifies whether input should be disabled or not. |
disableEditing | boolean | — | Restricts input editing. |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | Sets the label of the virtual keyboard's enter key on touch devices. |
focusOnClearClick | boolean | — | Specifies whether to focus the field when clear button is clicked. |
hideStatusSuffix | boolean | — | Specifies whether status suffix should be hidden. |
hideStepper | boolean | — | Specifies whether stepper should be hidden. |
id | string | — | Assigns a unique identifier for the root element. |
inputmode | string | 'numeric' | Sets the native inputmode attribute, which picks the virtual keyboard on touch devices. |
inputRef | (input: HTMLInputElement) => void | MutableRefObject<HTMLInputElement | null> | — | Ref to the underlying <input> DOM element. Accepts callback and object refs. Use for input masking libraries such as use-mask-input. Memoize callback refs to avoid reattaching on every render. |
invalidMessage | string | — | Enables internal validation and defines a message to display when user types invalid value. |
max | number | — | Sets a maximum value of an input. Similar to html5 max attribute. |
maxLength | number | — | Sets the maximum number of characters that can be inserted to a field. |
menuArrow | boolean | — | Specifies whether input should have a dropdown menu arrow on the right side. |
min | number | — | Sets a minimum value of an input. Similar to HTML5 min attribute. |
name | string | — | Reference element data when a form is submitted. |
noLeftBorderRadius | boolean | — | Specifies whether input shouldn't have rounded corners on its left. |
noRightBorderRadius | boolean | — | Specifies whether input shouldn't have rounded corners on its right. |
onBlur | FocusEventHandler | — | Defines a standard input onBlur callback. |
onChange | (value: number | null, stringValue: string) => void | — | Defines a standard input onChange callback. |
onClear | (event: KeyboardEvent<HTMLButtonElement> | MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Displays clear button (X) on a non-empty input and calls a callback function. |
onCompositionChange | (isComposing: boolean) => void | — | Defines a callback function called on compositionstart/compositionend events. |
onEnterPressed | KeyboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when the user presses -enter-. |
onEscapePressed | KeyboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when the user presses -escape-. |
onFocus | (e?: FocusEvent<HTMLInputElement, Element> | undefined) => void | — | Defines a standard input onFocus callback. |
onInputClicked | MouseEventHandler | — | Defines a standard input onClick callback. |
onInvalid | (stringValue: string, { validationType, value, }: { validationType?: "outOfBoundsError" | "formatError" | undefined; value: string; }) => void | — | Defines a callback function which is called on cases when invalid value is typed. - return { stringValue: string, { validationType: 'formatError' | 'outOfBoundsError', value: string }} - validationType - type 'formatError' is set when value is in the wrong format - type 'outOfBoundsError' is set when min or max props are used and value doesn't match the bounds - value - is set to current input value |
onKeyDown | KeyboardEventHandler<HTMLInputElement> | — | Defines a standard input onKeyDown callback. |
onKeyUp | KeyboardEventHandler<HTMLInputElement> | — | Defines a standard input onKeyUp callback. |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when user pastes text from a clipboard (using a mouse or keyboard shortcut) |
pattern | string | — | Sets a pattern that typed value must match to be valid (regex) |
placeholder | string | — | Sets a placeholder message to display. |
prefix | ReactNode | — | Pass a component you want to show as the prefix of the input, e.g., text, icon. |
readOnly | boolean | — | Specifies whether input is read only. |
required | boolean | — | Specifies whether input is mandatory. |
rtl | boolean | — | Specifies text direction. If true, the text is displayed from right to left. |
size | "small" | "tiny" | "medium" | "large" | — | Controls the size of the input. |
status | "error" | "warning" | "loading" | — | Specify the status of a field. |
statusMessage | ReactNode | — | Defines the message to display on status icon hover. If not given or empty, no tooltip is displayed. |
statusMessageTooltipProps | TooltipCommonProps | — | Status message tooltip props. |
step | number | number[] | — | Specifies the interval between number values. |
strict | boolean | — | Has no effect. |
suffix | ReactNode | — | Pass a component you want to show as the suffix of the input, e.g., text, icon. |
tabIndex | number | — | Indicates that element can be focused and where it participates in sequential keyboard navigation. |
textOverflow | "ellipsis" | "clip" | — | Handles text overflow behavior. It can either clip (default) or display ellipsis. |
tooltipPlacement | "right" | "left" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-end" | "bottom-start" | "left-end" | "left-start" | — | Controls placement of a status tooltip. |
type | string | — | Specifies the type of <input/> element to display. Default is text. |
value | string | number | — | Specifies the current value of the element. |
withSelection | boolean | — |
Import the driver matching your test environment:
| Method | Description |
|---|---|
clickOnIncrement | Click on ticker up |
clickOnDecrement | Click on ticker down |
isDownDisabled | Check if ticker down is disabled |
isUpDisabled | Check if ticker up is disabled |
click | — |
getInputAttribute | — |
getInputElementClasses | — |
suffixComponentExists | — |
getRootElementClasses | — |
getAriaDescribedby | — |
getAriaLabel | — |
getName | — |
getMaxLength | — |
getType | — |
getAriaControls | — |
clickIconAffix | — |
clickCustomAffix | — |
getCustomAffixText | — |
hasSuffix | — |
getClearButtonTooltipContent | — |
prefixComponentExists | — |
hasPrefix | — |
hasClearButton | — |
clickClear | — |
getValue | — |
getText | — |
getPattern | — |
getPlaceholder | — |
isOfSize | — |
getSize | — |
isDisabled | — |
isHoveredStyle | — |
isFocusedStyle | — |
getRequired | — |
enterText | — |
getAutocomplete | — |
getDefaultValue | — |
getTabIndex | — |
isCustomInput | — |
getReadOnly | — |
getDisabled | — |
getTextOverflow | — |
focus | — |
blur | — |
keyUp | — |
keyDown | — |
pressKey | — |
paste | — |
copy | — |
wheel | — |
trigger | — |
isFocus | — |
clickMenuArrow | — |
hasMenuArrow | — |
isRTL | — |
getCursorLocation | — |
clearText | — |
clickOutside | — |
isMasked | — |
isSelected | — |
hasStatus | Return true if there's a status |
getStatusMessage | If there's a status message, returns its text value |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
base | Returns UniDriver for the base element. |
Last updated: 26 October 2026