CodeAPI

wix-storage

The wix-storage module contains functionality for the persistent storage of key/value data in the user's browser.

There are two types of storage:

  • Local: Data in local storage never expires, even if the user closes your page. When the user reopens the page later, the data can still be retrieved.

  • Session: Data in session storage is available while the user's web session is active. The session ends when the user closes the browser tab or window. When the session ends, all the data in session storage is lost. Reloading or restoring the page does not affect session storage data.

To use the Storage API, import the needed storage type(s) from the wix-storage module:

   import {local, session} from 'wix-storage';

   // Or one of:

   import {local} from 'wix-storage';
   import {session} from 'wix-storage';

The APIs in wix-storage can only be used in front-end code.

Some older browsers may not fully support wix-storage. See Browser compatibility for more information.

Table of Contents

PROPERTIES

?
Store values associated with an object.
localUsed for local storage of data.
sessionUsed for session storage of data.

local

Used for local storage of data.

Description

Use the methods in Storage to manage local data.

Syntax

get local(): Storage
TYPE
?
The kind of data the property stores.

Examples

Store an item in local storage

import {local} from 'wix-storage';

// ...

local.setItem("key", "value");

Retrieve an item from local storage

import {local} from 'wix-storage';

// ...

let value = local.getItem("key"); // "value"

Remove an item from local storage

import {local} from 'wix-storage';

// ...

local.removeItem("key");

Remove all items from local storage

import {local} from 'wix-storage';

// ...

local.clear();

session

Used for session storage of data.

Description

Use the methods in Storage to manage session data.

Syntax

get session(): Storage
TYPE
?
The kind of data the property stores.

Examples

Store an item in session storage

import {session} from 'wix-storage';

// ...

session.setItem("key", "value");

Retrieve an item from session storage

import {session} from 'wix-storage';

// ...

let value = session.getItem("key"); // "value"

Remove an item from session storage

import {session} from 'wix-storage';

// ...

session.removeItem("key");

Remove all items from session storage

import {session} from 'wix-storage';

// ...

session.clear();