Skip to main content

The Heading component for Retool Mobile

A content area to display text.

Demo

Settings​

Heading includes the following configurable options when building apps in the IDE.

Show on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeSizeStylesValueWidth

Properties​

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

global​

boolean

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

​

boolean

Whether the component is visible.

id​

string

The unique identifier.

Whether the component is visible in the desktop layout.

Whether the component is visible in the mobile layout.

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

The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.

pluginType​

string

The plugin type.

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

The size.

Values
default

The default size.

small

The smallest size.

style​

object

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

textAlign​

enum

The alignment of the text within the input field.

value​

string

The value.

width​

number

The width.

Methods​

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

clearValue​

Clear the current values.

heading.clearValue()

resetValue​

Reset the current value to the default value.

heading.resetValue()

setHidden​

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

heading.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

setValue​

Set the current value.

heading.setValue(value)
Parameters

value​

string

The value.