The Text web component
A content area to display Markdown text or HTML content.
Text supports Github Flavored Markdown and most presentation attributes, such as images, links, and text formatting.
Settings
Text includes the following configurable options when building apps in the IDE.
Disable MarkdownHeightAlignShow on desktopShow on mobileMaintain space when hiddenMarginOverflowAlways show in edit modeStylesHelper textValue |
Properties
All properties for Text with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
disableMarkdown
Whether to disable markdown rendering for the text.
global
Whether the object is globally scoped for use in all app pages.
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
horizontalAlign
The horizontal alignment of the contents.
Values
left | Left alignment. |
center | Center alignment. |
right | Right alignment. |
stretched | Justified alignment |
id
The unique identifier.
imageWidth
Whether to crop images to fit or scale to fill the width.
Values
fit | Crop images to fit. |
fill | Scale to fill the width. |
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
tooltipText
The tooltip text to display.
verticalAlign
The vertical alignment of the content.
Values
top | Align to the top. |
center | Align to the center. |
bottom | Align to the bottom. |
Methods
JavaScript API methods for interacting with Text. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
clearValue
Clear the current values.
text.clearValue()
resetValue
Reset the current value to the default value.
text.resetValue()
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
text.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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. |
setHidden
Set the hidden
value to toggle whether the component is visible. Defaults to true
without a parameter.
text.setHidden(hidden)