Skip to main content

The Retool Context object

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.

appName​

The name and path of the app.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"/path/to/app"

appUuid​

The unique ID of the app.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"12345678-1234-1234-1234-123456789012"

currentScreen​

The currently selected page.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"page1"

deviceBrand​

The human-readable device brand.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falseiPhone

deviceManufacturer​

The device manufacturer.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falseApple

deviceModelName​

The human-readable name of the device model.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falseiPhone 14 Pro

deviceName​

The human-readable name of the device.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falseiPhone

deviceType​

The device type.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falsePHONE

environment​

The selected environment.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
false"production"

inEditorMode​

Whether the app is open in the app IDE.

Type boolean
Format True/False
Configurability Read-only
Defaultnull
Examples
falsetrue

pageTag​

The release version of the app. Applies only to apps in 'preview' mode. Defaults to latest if using the working version.

Type string
Format Plain Text
Configurability Read-only
Defaultnull
Examples
falselatest
false1.0.0

platform​

The platform used to access the app.

Type string
Format Plain Text
Configurability Read-only
Allowed Values
ValueDescription
android

Android.

ios

iOS or iPadOS.

web

Web browser.

Defaultnull
Examples
falseios

runningQueries​

A list of queries running.

Type array
Format Plain Text
Array values string
Configurability Read-only
Default[]
Examples
false["query1", "query2"]

translations​

A list of translated text for localization.

Type object
Configurability Read-only
Defaultnull