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, in the given Storage
object.
Syntax
var aValue = storage.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
Specification | Status | Comment |
---|---|---|
HTML Living Standard The definition of 'Storage.getItem' in that specification. |
Living Standard |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
getItem | Chrome Full support 4 | Edge Full support 12 | Firefox Full support 3.5 | IE Full support 8 | Opera Full support 10.5 | Safari Full support 4 | WebView Android Full support ≤37 | Chrome Android Full support 18 | Firefox Android Full support 6 | Opera Android Full support 11 | Safari iOS Full support 3.2 | Samsung Internet Android Full support 1.0 |
Legend
- Full support
- Full support