Number Input

An input field to enter a number, percentage, or currency. It supports minimum and maximum values, and currency symbols, and can perform validation of required field and custom rules.

Number Input can display a stepper, thousands separator, and have a maximum number of decimal places.

Properties

Available properties for Number Input with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.

NameTypeDescriptionvaluenumber | null

The current value.

allowNullboolean

Whether to allow a null value instead of 0 when the input field is empty.

currencystring

The three-letter ISO currency code to use if format is currency.

decimalPlacesnumber | null

The number of decimal places to display. If necessary, values round up or down automatically.

disabledboolean

Whether user input, interaction, or selection is disabled.

formDataKeystring

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

format'decimal' | 'percent' | 'currency'

The formatting style to use.

hiddenboolean

Whether the component is visible.

hideValidationMessageboolean

Whether to hide the validation message if the invalid is true.

iconAfterIconKey

The icon to display after the primary content.

iconBeforeIconKey

The icon to display before the primary content.

inputTooltipstring

The tooltip text to display below the input field on focus.

inputValuenumber | null

The current or most recently entered value of the input field.

invalidboolean

Whether the current value has failed any validation rules.

labelstring

The text to display as a label for the input field.

labelAlign'left' | 'right'

The horizontal alignment of the label.

labelCaptionstring

The additional text to display with the label.

labelPosition'left' | 'top'

The position of the label relative to the input field.

labelWidthnumber

The label width, in the unit specified in labelWidthUnit.

labelWidthUnit'%' | 'px' | 'col'

The specified units for labelWidth.

labelWrapboolean

Whether the label can wrap to multiple lines.

loadingboolean

Whether to display a loading indicator.

maintainSpaceWhenHiddenboolean

Whether the component takes up space on the canvas if hidden is true.

marginstring

The amount of margin to render outside of the component.

maxnumber | null

The maximum value to allow.

minnumber | null

The minimum value to allow.

padDecimalboolean

Whether to include trailing zeros to match the specified number for decimalPlaces.

placeholderstring

The text to display in the input field when empty.

preventScrollboolean

Whether to prevent scrolling behavior from changing the input value.

readOnlyboolean

Whether the value is read only and cannot be modified.

requiredboolean

Whether the input is required for validation.

showClearboolean

Whether to display a button to clear the current value of the input field.

showInEditorboolean

Whether the component remains visible in the editor if hidden is true.

showSeparatorsboolean

Whether the formatted value includes a localized thousands separator.

showStepperboolean

Whether the input field includes buttons to adjust the value incrementally.

textAfterstring

The text to display after the primary content.

textAlign'left' | 'right'

The horizontal alignment of text.

textBeforestring

The text to display before the primary content.

tooltipTextstring

The text to display in a tooltip on hover or focus.

validationMessagestring

The validation message to display if the input is invalid.

Events

Events are triggered by user interactions with Number Input. Use event handling to trigger queries or other actions in response to events.

NameDescriptionSubmit

A user submits the current value.

Change

A user changes the current value.

Focus

A user selects the input field.

Blur

A user deselects the input field.

Methods

Methods for interacting with Number Input. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.

NameDescriptionsetValue(value: string | number)

Set the current value.

scrollIntoView(options: any)

Scrolls the canvas or parent container so that the selected component appears in the visible area.

validate()

Validates the value of the input field.

clearValidation()

Clear the validation message from the input field.

setHidden(hidden: boolean)

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

setDisabled(disabled: boolean)

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

resetValue()

Reset value to the default value.

focus()

Set focus on the input field.

clearValue()

Clear the current value.

Related components