The Number Input component for Retool Apps

An input field to enter a number.

Demo

Properties

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

allowNull

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Validation rules > Allow null
Default	false

Examples

true

---

currency

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

Type	string
Configurability	Inspector
Default	null

---

decimalPlaces

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

Type	number
Format	Integer
Configurability	Inspector > Content > Decimal places
Default	null

---

disabled

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

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Disabled
Default	false

Examples

true

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).
Default	null

---

---

format

The formatting style to use.

Type	string
Configurability	Inspector
Allowed Values	Value Description decimal Decimal. percent Percent. currency Currency.
Default	null

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Configurability	Inspector > Content > Add-ons > Suffix icon
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Configurability	Inspector > Content > Add-ons > Prefix icon
Default	null

Examples

/icon:bold/shopping-gift

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	numberInput1

Examples

query1

button1

---

inputTooltip

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

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Helper text
Default	`Shift+Enter` to save, `Esc` to cancel

Examples

`Shift+Enter` to save, `Esc` to cancel

---

inputValue

The most recently entered value.

Type	number
Configurability	Read-only
Default	null

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

labelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Loading
Default	false

Examples

true

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

max

The maximum value to allow.

Type	number
Configurability	Inspector > Interaction > Validation rules > Maximum
Default	null

---

min

The minimum value to allow.

Type	number
Configurability	Inspector > Interaction > Validation rules > Minimum
Default	null

---

padDecimal

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

Type	boolean
Configurability	Inspector
Default	null

---

placeholder

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

Type	string
Format	string
Configurability	Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Advanced > Read only
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Validation rules > Required
Default	false

Examples

true

---

showClear

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

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Show clear button
Default	false

Examples

true

---

showInEditor

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

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

showSeparators

Whether the formatted value includes a localized thousands separator.

Type	boolean
Configurability	Inspector > Appearance > Show thousands separator
Default	null

---

showStepper

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

Type	boolean
Configurability	Inspector > Appearance > Advanced > Show stepper buttons
Default	null

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Suffix text
Default	null

Examples

USD

px

@example.com

---

textAlign

The alignment of the text within the input field.

Type	string
Configurability	Read-only
Allowed Values	Value Description left Left-aligned text. center right Right-aligned text.
Default	null

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Prefix text
Default	null

Examples

$

Email address

SKU

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Configurability	Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	number
Configurability	Read-only
Default	null

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

numberInput.clearValidation()

Clear the validation message from the input field.

Definition

numberInput.clearValidation()

Examples

Clear the validation message from numberInput.

numberInput.clearValidation();

---

numberInput.clearValue()

Clear the current values.

Definition

numberInput.clearValue()

Examples

Clear the current value of numberInput.

numberInput.clearValue();

---

numberInput.focus()

Set focus on the input field.

Definition

numberInput.focus()

Examples

Set focus on numberInput.

numberInput.focus();

---

numberInput.resetValue()

Reset the current value to the default value.

Definition

numberInput.resetValue()

Examples

Reset the current value of numberInput.

numberInput.resetValue();

---

numberInput.scrollIntoView()

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

Definition

numberInput.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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.

---

---

Examples

Scroll the minimum amount to immediately bring numberInput into view.

numberInput.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

numberInput.setHidden()

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

Definition

numberInput.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide numberInput.

numberInput.setHidden(true);

Unhide numberInput.

numberInput.setHidden(false);

---

numberInput.setValue()

Set the current value.

Definition

numberInput.setValue(key, value)

Parameters

key

The key.

Type

string

---

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of numberInput to userValue.

numberInput.setValue(userValue);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Blur	The input field is deselected.
Change	The value is changed.
Focus	The input field is selected.
Submit	The value is submitted.