Editable Number
A click-to-edit field to enter a number, percentage, or currency. Editable Number functions similarly to Number Input but is rendered as a static number when not being edited. It supports minimum and maximum values, currency symbols, and can perform validation of required field and custom rules.
Editable Number can display a stepper, thousands separator, and have a maximum number of decimal places.
Properties
Available properties for Editable Number with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
The current value.
Whether to allow a null value instead of 0 when the input field is empty.
The three-letter ISO currency code to use if format is currency.
The number of decimal places to display. If necessary, values round up or down automatically.
The icon to display that indicates an editable value.
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
The formatting style to use.
Whether the component is visible.
Whether to hide the validation message if the invalid is true.
The icon to display after the primary content.
The icon to display before the primary content.
The tooltip text to display below the input field on focus.
The current or most recently entered value of the input field.
Whether the current value has failed any validation rules.
The text to display as a label for the input field.
The horizontal alignment of the label.
The additional text to display with the label.
The position of the label relative to the input field.
The label width, in the unit specified in labelWidthUnit.
The specified units for labelWidth.
Whether the label can wrap to multiple lines.
Whether to display a loading indicator.
Whether the component takes up space on the canvas if hidden is true.
The amount of margin to render outside of the component.
The maximum value to allow.
The minimum value to allow.
Whether to include trailing zeros to match the specified number for decimalPlaces.
The text to display in the input field when empty.
Whether the value is read only and cannot be modified.
Whether the input is required for validation.
Whether to display a button to clear the current value of the input field.
Whether the component remains visible in the editor if hidden is true.
Whether the formatted value includes a localized thousands separator.
Whether the input field includes buttons to adjust the value incrementally.
The text to display after the primary content.
The horizontal alignment of text.
The text to display before the primary content.
The text to display in a tooltip on hover or focus.
The validation message to display if the input is invalid.
Events
Events are triggered by user interactions with Editable Number. Use event handling to trigger queries or other actions in response to events.
A user changes the current value.
A user selects the input field.
A user deselects the input field.
Methods
Methods for interacting with Editable Number. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.
Set the current value.
Clear the current value.
Scrolls the canvas or parent container so that the selected component appears in the visible area.
Validates the value of the input field.
Clear the validation message from the input field.
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
Reset value to the default value.
Set focus on the input field.
Removes focus on the input field.