Store Value

Github Discord Appsmith Cloud Community Forum

Search…

Store Value

This function is used to store key-value data to access later anywhere in the app.

Click to expand
Signature
1
storeValue(key: string, value: any, persist? = true): void
Copied!
Arguments
Argument Name
Description
key
Name of the key to store the value against
value
Value to give the key you are creating/updating
persist
Should this key value get persisted in the browser local storage to use between sessions. Defaults to true
Reading values
You can read values from the store by referencing the key inside the appsmith.store object
1
{{ appsmith.store.key }}
Copied!
Usage
Persisted state is cleared out when a user logs out
Transient state (persist=false) is only available till the user exits the app or refreshes a page
If a same key is available in transient and persisted state, the transient value gets preference
Store value is asynchronous and thus, you cannot read the effect of store value in the next line itself
1
{{
2
  storeValue("userID", 42);
3
}}
Copied!

Framework Reference - Previous

Navigate To

Next - Framework Reference

Copy To Clipboard

Last modified 17d ago

Copy link

Contents