The Icon component for Retool Mobile

A content area to display an icon.

Demo

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.

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	Value Description 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).
Default	null

---

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

icon

The icon to display if type is library.

Type	string
Format	Icon Key
Configurability	Inspector > Content > Add-ons > Icon
Default	null

Examples

/icon:bold/shopping-gift

---

svg

The SVG] markup to render if type is svg.

Type	string
Configurability	Inspector
Default	null

---

type

The icon type

Type	string
Configurability	Inspector
Allowed Values	Value Description library Icon from the Retool icon library. uri Icon from a URL. svg Custom SVG.
Default	null

---

url

The URL to the image to display if type is uri.

Type	string
Configurability	Inspector
Default	null

---

width

The width.

Type	string
Format	Integer
Configurability	Inspector
Allowed Values	Value Description full Full width. fixed Fixed width.
Default	null

Examples

1280

---

widthPx

The width.

Type	number
Format	Integer
Configurability	Inspector
Default	null

Examples

1280

---

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.

Definition

icon.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide icon.

icon.setHidden(true);

Unhide icon.

icon.setHidden(false);

---

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.