Skip to main content

The localStorage object

Store and retrieve data in localStorage.

Use localStorage to save data locally to the browser.

Properties

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

global

boolean

Whether the object is globally scoped for use in all app pages.


boolean

Whether the component is visible.


id

string

The unique identifier.


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.


value

object

The value.


Methods

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

setValue

Set the current value.

localStorage.setValue(value)
Parameters

value

object

The value.