HTML
A content area to embed HTML and CSS markup.
You're viewing documentation for classic apps, which use Retool's original app editor. The new app builder is the recommended way to build apps and where Retool focuses new development.
HTML supports most HTML tags and presentational attributes. Scripting is not supported but event handlers are available.
To embed web pages, use an IFrame component. For functionality that isn't available in other components, or to use React or HTML and JavaScript, use a Custom Component.
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.
clickable
Whether there is an enabled Click event handler.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Interaction > Event handlers |
| Default | false |
Examples
falsetrue
events
A list of configured event handlers that trigger actions or queries.
| Type | array |
| Array values | object |
| Configurability | Inspector > Interaction > Event handlers |
| Default | null |
Array Object Properties
event
The event that triggers the action. Refer to the events section for details of available events for this object.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Event |
| Default | null |
method
The JavaScript method to perform when type is datasource, widget, state, or localStorage.
| Type | string |
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Run script actions |
| Default | null |
type
The type of action to perform.
| Type | string | ||||||||||||||
| Configurability | Inspector > Interaction > Event handlers > Edit event handler > Action | ||||||||||||||
| Allowed Values |
| ||||||||||||||
| Default | null |
hidden
Whether this object is hidden from view.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Hidden |
| Default | false |
Examples
falsetrue
Examples
falsequery1
falsebutton1
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on desktop |
| Default | false |
Examples
falsetrue
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Show on mobile |
| Default | true |
Examples
falsetrue
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Maintain space when hidden |
| Default | false |
Examples
falsetrue
margin
The amount of margin to render outside.
| Type | string | |||||||||
| Format | Plain Text | |||||||||
| Configurability | Inspector > Spacing > Margin | |||||||||
| Allowed Values |
| |||||||||
| Default | 4px 8px |
Examples
false4px 8px
showInEditor
Whether the component remains visible in the editor if hidden is true.
| Type | boolean |
| Format | True/False |
| Configurability | Inspector > Appearance > Advanced > Always show in edit mode |
| Default | false |
Examples
falsetrue
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 |
|---|---|
| Change | The value is changed. |
| Click | An item is clicked or pressed. |
To attach an event handler to a specific element in the HTML, add a data-<event type>-target attribute. For example:
<button data-click-target="primary">Trigger event</button>