ContextQMD
Back to Content

Storage: getItem() method

files/en-us/web/api/storage/getitem/index.md

latest1.5 KB
Original Source

{{APIRef("Web Storage API")}}

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

Syntax

js-nolint
getItem(keyName)

Parameters

  • keyName
    • : A string containing the name of the key you want to retrieve the value of.

Return value

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

Examples

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

js
function setStyles() {
  const currentColor = localStorage.getItem("bgcolor");
  const currentFont = localStorage.getItem("font");
  const 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

{{Specifications}}

Browser compatibility

{{Compat}}

See also