Skip to main content

The HTML component for Retool Mobile

A content area to embed HTML content.

Demo

Settings​

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

Event handlersHorizontal scrollHTMLShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStyles

Properties​

All properties for HTML 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. Refer to the events section for a list of supported events.

method​

enum

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

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

global​

boolean

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

​

boolean

Whether the component is visible.

Whether to support scrolling beyond the width of the viewport.

html​

string

The HTML content.

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.

style​

object

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

Methods​

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

setHidden​

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

html.setHidden(hidden)
Parameters

​

boolean

Whether the component is visible.

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.

click​

The item is clicked or pressed.