The Text component for Retool Apps

A content area to display Markdown text or HTML content.

Version: Self-hosted 3.114 Stable

Text supports Github Flavored Markdown and most presentation attributes, such as images, links, and text formatting.

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.

disableMarkdown

Whether to render the value as Markdown or plain text.

Type	boolean
Mutability	Control Usage Retool UI Inspector > Content > Value

---

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Spacing > Height
Allowed Values	Value Description auto Expand to fit content. fixed Fixed height. fill
Default	fixed

---

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

---

horizontalAlign

The horizontal alignment of the contents.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Appearance > Alignment
Allowed Values	Value Description left Left alignment. center Center alignment. right Right alignment.
Default	left

---

id

The unique identifier (name).

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

Examples

query1

button1

---

imageWidth

Whether to crop images to fit or scale to fill the width.

Type	string
Mutability	Control Usage Retool UI Inspector > Appearance > Image width
Allowed Values	Value Description fit Crop images to fit. fill Scale to fill the width.

---

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

---

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 current value.

Type	string
Mutability	Read-only

---

verticalAlign

The vertical alignment of the content.

Type	string
Mutability	Read-only
Allowed Values	Value Description top Align to the top. center Align to the center. bottom Align to the bottom.

---

Methods

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

text.clearValue()

Clear the current values.

Definition

text.clearValue()

Examples

Clear the current value of text.

text.clearValue();

---

text.resetValue()

Reset the current value to the default value.

Definition

text.resetValue()

Examples

Reset the current value of text.

text.resetValue();

---

text.scrollIntoView()

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

Definition

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

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

---

text.setHidden()

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

Definition

text.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide text.

text.setHidden(true);

Unhide text.

text.setHidden(false);

---

text.setValue()

Set the current value.

Definition

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

Parameters

id

The unique identifier (name).

Type	string
Format	Plain Text
Default	{placeholder}1

Examples

query1

button1

---

pluginType

The underlying object type.

Type

string

---

isHiddenOnDesktop

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

Type	boolean
Format	True/False
Default	false

Examples

true

---

isHiddenOnMobile

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

Type	boolean
Format	True/False
Default	true

Examples

true

---

style

Custom style options.

Type

object

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Default	false

Examples

true

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

value

The value.

Type	array
Array values	string

---

Examples

Set the current value of text to userValue.

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