The Rich Text Editor component for Retool Apps

An input field to enter text with rich formatting.

Version: Cloud and 3.185 Edge

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.

formDataKey

The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Interaction > Form data key
Default	{{ self.id }}

Examples

table1.selectedRow.id

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance > Hidden Method setHidden()
Default	false

Examples

true

---

id

The unique identifier (name).

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

Examples

query1

button1

---

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

---

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

---

onBlur

The event handler that runs when the input field loses focus.

Type	string
Mutability	Read-only

---

selection

The index of the cursor and the length of the selection.

Type	object
Format	object
Mutability	Read-only

Object Properties

index

The start position.

Type	number
Mutability	Read-only

---

length

The length to select.

Type	number
Mutability	Read-only

---

Examples

{"index": 0, "length": 5}

---

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

---

style

Custom style options.

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

---

value

The value.

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

richTextEditor.scrollIntoView()

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

Definition

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

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

---

richTextEditor.setSelection()

Set the current selection.

Definition

richTextEditor.setSelection()

---

richTextEditor.setValue()

Set the current value.

Definition

richTextEditor.setValue(id, pluginType, isHiddenOnDesktop, isHiddenOnMobile, style, maintainSpaceWhenHidden, showInEditor, margin, value)

Parameters

id

(No description available)

Type

unknown

---

pluginType

(No description available)

Type

unknown

---

isHiddenOnDesktop

(No description available)

Type

unknown

---

isHiddenOnMobile

(No description available)

Type

unknown

---

style

(No description available)

Type

unknown

---

maintainSpaceWhenHidden

(No description available)

Type

unknown

---

showInEditor

(No description available)

Type

unknown

---

margin

(No description available)

Type

unknown

---

value

(No description available)

Type

unknown

---

Examples

Set the current value of richTextEditor to userValue.

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