The Editable Text component for classic apps

A click-to-edit input field to enter a single line of text.

Editable Text is a single-line input field for text values. It functions similarly to Text Input but renders as plain text until clicked.

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.

autoCapitalize

The type of automatic capitalization that the browser can automatically perform when using virtual or on-screen keyboards.

Type	string
Format	Plain Text
Configurability	Inspector > Interaction > Advanced > Capitalize
Allowed Values	Value Description none No capitalization. sentences Capitalize sentences. words Capitalize words. characters Capitalize characters.
Default	none

Examples

false"words"

---

autoComplete

Whether the browser can perform autocomplete on the input field.

Type	boolean
Format	True/False
Configurability	Inspector
Default	false

Examples

falsetrue

---

autoFill

The data type of the input field for browsers to autofill if autoComplete is true.

Type	string
Format	Plain Text
Configurability	Inspector
Allowed Values	Value Description off Disable browser autofill. additional-name Additional name. address-line1 Address line 1. address-line2 Address line 2. birthdate-day Birthdate day. birthdate-full Full birthdate. birthdate-month Birthdate month. birthdate-year Birthdate year. cc-csc Credit card security code. cc-exp Credit card expiration date. cc-exp-day Credit card expiration day. cc-exp-month Credit card expiration month. cc-exp-year Credit card expiration year. cc-number Credit card number. country Country. current-password Current password. email Email address. family-name Family name. gender Gender. given-name Given name. honorific-prefix Honorific prefix. honorific-suffix Honorific suffix. name Full name. new-password New password. one-time-code One-time code. postal-code Postal code. street-address Street address. tel Telephone number. username Username.
Default	off

Examples

false"email"

---

editIcon

The icon to display that indicates an editable value.

Type	string
Format	Icon Key
Configurability	Inspector > Content > Add-ons > Edit icon
Default	"/icon:bold/interface-edit-write-1"

Examples

false/icon:bold/interface-edit-write-1

---

enforceMaxLength

Whether to enforce the maximum length.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Advanced > Enforce max length
Default	false

Examples

falsetrue

---

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

---

---

iconAfter

The suffix icon to display.

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

Examples

false/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

false/icon:bold/shopping-gift

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	editableText1

Examples

falsequery1

falsebutton1

---

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

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

---

inputValue

The default or most recently entered value.

Type	string
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

falsetrue

---

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

falsetrue

---

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

falsetop

---

loading

Whether to display a loading indicator.

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

Examples

falsetrue

---

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

falsetrue

---

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

false4px 8px

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Configurability	Inspector > Interaction > Validation rules > Max length
Default	null

Examples

false100

---

minLength

The minimum number of characters to allow.

Type	number
Format	Integer
Configurability	Inspector > Interaction > Validation rules > Min length
Default	null

Examples

false20

---

pattern

A regular expression (regex), without forward slashes around the pattern, to validate input if patternType is regex.

Type	string
Format	Regular Expression
Configurability	Inspector > Interaction > Validation rules > Regex
Default	null

Examples

false^[a-zA-Z0-9]+$

---

patternType

The pattern with which to validate the input.

Type	string
Format	Plain Text
Configurability	Inspector
Allowed Values	Value Description email Email address. regex Regular expression statement. url URL.
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

falseEnter a value

---

readOnly

Whether user input is read-only.

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

Examples

falsetrue

---

required

Whether a value is required to be selected.

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

Examples

falsetrue

---

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

falsetrue

---

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

falsetrue

---

spellCheck

Whether the browser can perform spellcheck on the input field.

Type	boolean
Format	True/False
Configurability	Inspector > Interaction > Advanced > Enable spell check
Default	false

Examples

falsetrue

---

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

falseUSD

falsepx

false@example.com

---

textBefore

The prefix text to display.

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

Examples

false$

falseEmail address

falseSKU

---

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

falseSubmit

---

value

The current or default value.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Default value
Default	null

Examples

falseHello world!

---

Methods

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

editableText.clearValidation()

Clear the validation message from the input field.

Definition

editableText.clearValidation()

Examples

Clear the validation message from editableText.

editableText.clearValidation();

---

editableText.clearValue()

Clear the current values.

Definition

editableText.clearValue()

Examples

Clear the current value of editableText.

editableText.clearValue();

---

editableText.focus()

Set focus on the component.

Definition

editableText.focus()

Examples

Set focus on editableText.

editableText.focus();

---

editableText.resetValue()

Reset the current value to the default value.

Definition

editableText.resetValue()

Examples

Reset the current value of editableText.

editableText.resetValue();

---

editableText.scrollIntoView()

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

Definition

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

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

---

editableText.setValue()

Set the current value.

Definition

editableText.setValue(value)

Parameters

value

The value.

Type	string | number | boolean | object | array

---

Examples

Set the current value of editableText to userValue.

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