Skip to main content
Applies to: Cloud and 3.259.0-edge

The Editable Text component for Retool 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
ValueDescription
none

No capitalization.

sentences

Capitalize sentences.

words

Capitalize words.

characters

Capitalize characters.

Defaultnone
Examples
"words"

autoComplete​

Whether the browser can perform autocomplete on the input field.

Type boolean
Format True/False
Configurability Inspector
Defaultfalse
Examples
true

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

Defaultoff
Examples
"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
/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
Defaultfalse
Examples
true

events​

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

Type array
Array values object
Configurability Inspector > Interaction > Event handlers
Defaultnull
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
Defaultnull

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
Defaultnull

type​

The type of action to perform.

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

Defaultnull

iconAfter​

The suffix icon to display.

Type string
Format Icon Key
Configurability Inspector > Content > Add-ons > Suffix icon
Defaultnull
Examples
/icon:bold/shopping-gift

iconBefore​

The prefix icon to display.

Type string
Format Icon Key
Configurability Inspector > Content > Add-ons > Prefix icon
Defaultnull
Examples
/icon:bold/shopping-gift

id​

The unique identifier (name).

Type string
Format Plain Text
Configurability Inspector
DefaulteditableText1
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 default or most recently entered value.

Type string
Configurability Read-only
Defaultnull

isHiddenOnDesktop​

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

Type boolean
Format True/False
Configurability Inspector > Appearance > Advanced > Show on desktop
Defaultfalse
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
Defaulttrue
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
ValueUI OptionDescription
topTop

Above the input field or value.

leftLeft

Left of the input field or value.

Defaultleft
Examples
top

loading​

Whether to display a loading indicator.

Type boolean
Format True/False
Configurability Inspector > Interaction > Loading
Defaultfalse
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
Defaultfalse
Examples
true

margin​

The amount of margin to render outside.

Type string
Format Plain Text
Configurability Inspector > Spacing > Margin
Allowed Values
ValueUI OptionDescription
4px 8pxNormal

Normal margin.

0None

No margin.

Default4px 8px
Examples
4px 8px

maxLength​

The maximum number of characters to allow.

Type number
Format Integer
Configurability Inspector > Interaction > Validation rules > Max length
Defaultnull
Examples
100

minLength​

The minimum number of characters to allow.

Type number
Format Integer
Configurability Inspector > Interaction > Validation rules > Min length
Defaultnull
Examples
20

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
Defaultnull
Examples
^[a-zA-Z0-9]+$

patternType​

The pattern with which to validate the input.

Type string
Format Plain Text
Configurability Inspector
Allowed Values
ValueDescription
email

Email address.

regex

Regular expression statement.

url

URL.

Defaultnull

placeholder​

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

Type string
Formatstring
Configurability Inspector > Content > Placeholder
DefaultEnter a value
Examples
Enter a value

readOnly​

Whether user input is read-only.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Read only
Defaultfalse
Examples
true

required​

Whether a value is required to be selected.

Type boolean
Format True/False
Configurability Inspector > Interaction > Validation rules > Required
Defaultfalse
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
Defaultfalse
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
Defaultfalse
Examples
true

spellCheck​

Whether the browser can perform spellcheck on the input field.

Type boolean
Format True/False
Configurability Inspector > Interaction > Advanced > Enable spell check
Defaultfalse
Examples
true

style​

Custom style options.

Type object
Configurability Inspector > Appearance > style
Defaultnull

textAfter​

The suffix text to display.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Suffix text
Defaultnull
Examples
USD
px
@example.com

textBefore​

The prefix text to display.

Type string
Format Plain Text
Configurability Inspector > Content > Add-ons > Prefix text
Defaultnull
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
Defaultnull
Examples
Submit

value​

The current or default value.

Type string
Format Plain Text
Configurability Inspector > Content > Default value
Defaultnull
Examples
Hello 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 input field.

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
ValueDescription
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
ValueDescription
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(key, value)
Parameters

key​

The key.

Type string

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.

EventDescription
BlurThe input field is deselected.
ChangeThe value is changed.
FocusThe input field is selected.