The Number Input component for Retool Apps

An input field to enter a number.

For more information on how to use this component, refer to the Number inputs guide.

Demo

Settings

Number Input includes the following configurable options when building apps in the IDE.

HiddenShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties

All properties for Number Input with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

allowNull

boolean

Whether to allow and validate a null value instead of 0 if the input field is empty.

---

currency

string

The three-letter ISO currency code to use.

---

decimalPlaces

number

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

---

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

---

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

format

enum

The formatting style to use.

Values

decimal	Decimal.
percent	Percent.
currency	Currency.

---

formDataKey

string

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

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

hideValidationMessage

boolean

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

---

iconAfter

enum

The suffix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

iconBefore

enum

The prefix icon to display.

Values

You can select an icon or dynamically set one with a valid icon key.

Demo

---

id

string

The unique identifier.

---

inputTooltip

string

The tooltip text to display.

---

invalid

boolean

Whether the value has failed any validation rules.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

label

string

The text label to display.

---

labelAlign

enum

The horizontal alignment of the label.

Values

left	Left of the input field.
top	Above the input field.

---

labelCaption

string[]

The label for the node.

---

labelWidth

number

The label width, in the unit specified in labelWidthUnit.

---

labelWidthUnit

enum

The specified units for labelWidth, if labelPosition is left.

Values

%	Percent.
px	Pixels.
col	Columns.

---

labelWrap

boolean

Whether the label can wrap to multiple lines.

---

loading

boolean

Whether to display a loading indicator.

---

maintainSpaceWhenHidden

boolean

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

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

max

number

The maximum value to allow.

---

min

number

The minimum value to allow.

---

padDecimal

boolean

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

---

placeholder

string

The text to display within the input field when there is no value.

---

pluginType

string

The plugin type.

---

preventScroll

boolean

Whether to prevent scrolling behavior from changing the input value.

---

readOnly

boolean

Whether user input is read-only.

---

required

boolean

Whether a value is required.

---

showClear

boolean

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

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

showSeparators

boolean

Whether the formatted value includes a localized thousands separator.

---

showStepper

boolean

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

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

textAfter

string

The suffix text to display.

---

textBefore

string

The prefix text to display.

---

tooltipText

string

The tooltip text to display.

---

validationMessage

string

The validation message to display if invalid is true.

---

value

number

The value.

---

Methods

JavaScript API methods for interacting with Number Input. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValidation

Clear the validation message from the input field.

numberInput.clearValidation()

---

clearValue

Clear the current values.

numberInput.clearValue()

---

focus

Set focus on the input field.

numberInput.focus()

---

resetValue

Reset the current value to the default value.

numberInput.resetValue()

---

scrollIntoView

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

numberInput.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setHidden

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

numberInput.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

numberInput.setValue(value)

Parameters

value

string

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

blur

The input field is blurred.

---

change

The value is changed.

---

focus

The input field is focused.

---

submit

Input values are submitted.

---