W3cubDocs

/DOM

Storage.getItem

The getItem() method of the Storage interface, when passed a key name, will return that key's value or null if the key does not exist.

Syntax

var aValue = localStorage.getItem(keyName);

Parameters

keyName
A DOMString containing the name of the key you want to retrieve the value of.

Return value

A DOMString containing the value of the key. If the key does not exist, null is returned.

Example

The following function retrieves three data items from local storage, then uses them to set custom styles on a page.

function setStyles() {
  var currentColor = localStorage.getItem('bgcolor');
  var currentFont = localStorage.getItem('font');
  var currentImage = localStorage.getItem('image');

  document.getElementById('bgcolor').value = currentColor;
  document.getElementById('font').value = currentFont;
  document.getElementById('image').value = currentImage;

  htmlElem.style.backgroundColor = '#' + currentColor;
  pElem.style.fontFamily = currentFont;
  imgElem.setAttribute('src', currentImage);
}

Note: To see this used within a real world example, see our Web Storage Demo.

Specifications

Browser compatibilityUpdate compatibility data on GitHub

Desktop
Chrome Edge Firefox Internet Explorer Opera Safari
Basic support 4 12 3.5 8 10.5 4
Mobile
Android webview Chrome for Android Edge Mobile Firefox for Android Opera for Android iOS Safari Samsung Internet
Basic support Yes 18 13 6 11 3.2 ?

See also

© 2005–2018 Mozilla Developer Network and individual contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Storage/getItem