localStorage

Provides access to the W3C's Web [Storage](../storage.html) interface

var permanentStorage = window.localStorage;
var tempStorage = window.sessionStorage;

Methods

  • key: Returns the name of the key at the specified position.

  • getItem: Returns the item identified by the specified key.

  • setItem: Assigns a keyed item's value.

  • removeItem: Removes the item identified by the specified key.

  • clear: Removes all of the key/value pairs.

Details

The window.localStorage interface implements the W3C's Web [Storage](../storage.html) interface. An app can use it to save persistent data using key-value pairs. The window.sessionStorage interface works the same way in every respect, except that all data is cleared each time the app closes. Each database provides a separate namespace.

Supported Platforms

  • Android
  • BlackBerry WebWorks (OS 6.0 and higher)
  • iOS
  • Tizen
  • Windows Phone 7 and 8

Key Quick Example

var keyName = window.localStorage.key(0);

Set Item Quick Example

window.localStorage.setItem("key", "value");

Get Item Quick Example

    var value = window.localStorage.getItem("key");
    // value is now equal to "value"

Remove Item Quick Example

    window.localStorage.removeItem("key");

Clear Quick Example

    window.localStorage.clear();

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Storage Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        window.localStorage.setItem("key", "value");
        var keyname = window.localStorage.key(i);
        // keyname is now equal to "key"
        var value = window.localStorage.getItem("key");
        // value is now equal to "value"
        window.localStorage.removeItem("key");
        window.localStorage.setItem("key2", "value2");
        window.localStorage.clear();
        // localStorage is now empty
    }

    </script>
  </head>
  <body>
    <h1>Example</h1>
    <p>localStorage</p>
  </body>
</html>

Windows Phone 7 Quirks

Dot notation is not available on Windows Phone 7. Be sure to use setItem or getItem, rather than accessing keys directly from the storage object, such as window.localStorage.someKey.