The Rich Text Editor web component

An input field to enter text with rich formatting.

Demo

Settings

Rich Text Editor includes the following configurable options when building apps in the IDE.

Event handlersForm data keyHiddenShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesValue

Properties

All properties for Rich Text Editor with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

events

object[]

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

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

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

---

---

formDataKey

string

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

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

onBlur

Deprecated

function

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

---

pluginType

string

The plugin type.

---

selection

object

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

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

value

string

The value.

---

Methods

JavaScript API methods for interacting with Rich Text Editor. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

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

richTextEditor.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

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.

---

---

---

setSelection

Set the current selection.

richTextEditor.setSelection(setSelectionOptions)

Parameters

setSelectionOptions

---

---

setValue

Set the current value.

richTextEditor.setValue(value)

Parameters

value

string

The value.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

blur

The input field is blurred.

---

change

The value is changed.

---

focus

The input field is focused.

---