Skip to main content

The Variable object

Manage variables that store temporary state.

Create variables to store data within a Retool app. Each instance has a unique name with which to reference (e.g., myVariable1.value).

Properties​

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

​

boolean

Whether the component is visible.

id​

string

The name.

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.

The value.

Methods​

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

setIn​

Set the value of a nested key.

variable.setIn(setInOptions)
Parameters

setInOptions​

object

Store and retrieve data in localStorage.

Properties

keyPath​

string[]

A list of key-value pairs stored in localStorage.

The value.

setValue​

Set the current value.

variable.setValue(value)
Parameters

The value.