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.
altText
An accessible description for screen readers.
Examples
clickable
Whether there is an enabled Click event handler.
Examples
disabled
Whether input, interaction, selection, or triggering is disabled.
Examples
hidden
Whether this object is hidden from view.
Examples
horizontalAlign
The horizontal alignment of the contents.
The unique identifier (name).
Examples
isHiddenOnDesktop
Whether to show or hide this object in the desktop layout.
Examples
isHiddenOnMobile
Whether to show or hide this object in the mobile layout.
Examples
loading
Whether to display a loading indicator.
Examples
maintainSpaceWhenHidden
Whether to take up space on the canvas if hidden is true.
Examples
margin
The amount of margin to render outside.
Examples
showInEditor
Whether the component remains visible in the editor if hidden is true.
Examples
styleVariant
The style variant to use.
Examples
Methods
JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.
icon.setHidden()
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
Parameters
hidden
Whether this object is hidden from view.
Examples
Examples
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 |
|---|
| Click | An item is clicked or pressed. |