The Retool Context object
Information about the current mobile app and device.
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 |
Default | null |
Examples
"/path/to/app"
Examples
"12345678-1234-1234-1234-123456789012"
currentScreen
The currently selected page.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
"page1"
deviceBrand
The human-readable device brand.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
iPhone
deviceManufacturer
The device manufacturer.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
Apple
deviceModelName
The human-readable name of the device model.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
iPhone 14 Pro
deviceName
The human-readable name of the device.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
iPhone
Examples
PHONE
environment
The selected environment.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
"production"
inEditorMode
Whether the app is open in the App IDE.
Type | boolean |
Format | True/False |
Configurability | Read-only |
Default | null |
Examples
true
pageTag
The release version of the app. Defaults to latest
if using the working version.
Type | string |
Format | Plain Text |
Configurability | Read-only |
Default | null |
Examples
latest
v1.0.0
platform
The platform used to access the app.
Type | string | ||||||||
Format | Plain Text | ||||||||
Configurability | Read-only | ||||||||
Allowed Values |
| ||||||||
Default | null |
Examples
ios
runningQueries
A list of queries running.
Type | array |
Format | Plain Text |
Array values | string |
Configurability | Read-only |
Default | [] |
Examples
["query1", "query2"]
translations
A list of translated text for localization.
Type | object |
Configurability | Read-only |
Default | null |