The Currency component for Retool Apps

An input field to enter a monetary number value.

Version: Cloud and 3.185 Edge

Currency is a preset version of Number Input. It has been preconfigured with common options for currency input.

Demo

For more information about using the Currency component, refer to the number inputs guide.

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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector

---

decimalPlaces

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

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Content > Decimal places

---

disabled

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Disabled Method setDisabled()
Default	false

Examples

true

---

format

The formatting style to use.

Type	string
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description decimal Decimal. percent Percent. currency Currency.

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Suffix icon
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Prefix icon
Default	null

Examples

/icon:bold/shopping-gift

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Default	currency1

Examples

query1

button1

---

inputTooltip

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

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Read-only

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Maximum

---

min

The minimum value to allow.

Type	number
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules > Minimum

---

padDecimal

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

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

placeholder

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

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content > Placeholder
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced > Read only
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

showSeparators

Whether the formatted value includes a localized thousands separator.

Type	boolean
Mutability	Control Usage Retool UI Inspector > Appearance > Show thousands separator

---

showStepper

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

Type	boolean
Mutability	Control Usage Retool UI Inspector > Appearance > Advanced > Show stepper buttons

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance > style

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Read-only
Allowed Values	Value Description left Left-aligned text. center right Right-aligned text.

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI 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
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Helper text
Default	null

Examples

Submit

---

value

The current value.

Type	number
Mutability	Read-only

---

Methods

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

currency.clearValidation()

Clear the validation message from the input field.

Definition

currency.clearValidation()

Examples

Clear the validation message from currency.

currency.clearValidation();

---

currency.clearValue()

Clear the current values.

Definition

currency.clearValue()

Examples

Clear the current value of currency.

currency.clearValue();

---

currency.focus()

Set focus on the input field.

Definition

currency.focus()

Examples

Set focus on currency.

currency.focus();

---

currency.resetValue()

Reset the current value to the default value.

Definition

currency.resetValue()

Examples

Reset the current value of currency.

currency.resetValue();

---

currency.scrollIntoView()

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

Definition

currency.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 currency into view.

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

---

currency.setHidden()

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

Definition

currency.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide currency.

currency.setHidden(true);

Unhide currency.

currency.setHidden(false);

---

currency.setValue()

Set the current value.

Definition

currency.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of currency to userValue.

currency.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.