A StorageEvent is sent to a window when a storage area it has access to is changed within the context of another document.

Note: Although this event existed prior to Gecko 2.0, it did not match the specification. The old event format is now represented by the nsIDOMStorageEventObsolete interface.

Method overview

void initStorageEvent(
  in DOMString type,
  in boolean canBubble,
  in boolean cancelable,
  in DOMString key,
  in DOMString oldValue,
  in DOMString newValue,
  in USVString url,
  in nsIDOMStorage storageArea
);

Attributes

Attribute Type Description
key DOMString Represents the key changed. The key attribute is null when the change is caused by the storage clear() method. Read only.
newValue DOMString The new value of the key. The newValue is null when the change has been invoked by storage clear() method or the key has been removed from the storage. Read only.
oldValue DOMString The original value of the key. The oldValue is null when the key has been newly added and therefore doesn't have any previous value. Read only.
storageArea nsIDOMStorage Represents the Storage object that was affected. Read only.
url USVString The URL of the document whose key changed. Read only.

Methods

initStorageEvent()

Initializes the event in a manner analogous to the similarly-named method in the DOM Events interfaces.

void initStorageEvent(
  in DOMString type,
  in boolean canBubble,
  in boolean cancelable,
  in DOMString key,
  in DOMString oldValue,
  in DOMString newValue,
  in USVString url,
  in nsIDOMStorage storageArea
);

Parameters

typeArg
The name of the event.
canBubble
A boolean indicating whether the event bubbles up through the DOM or not.
cancelable
A boolean indicating whether the event is cancelable.
key
The key whose value is changing as a result of this event.
oldValue
The key's old value.
newValue
The key's new value.
url
The URL of the document initiating the change.
storageArea
The DOM Storage object representing the storage area on which this event occurred.

Specification

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
StorageEventChrome Full support 1Edge Full support YesFirefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
StorageEvent() constructorChrome Full support 17Edge ? Firefox Full support YesIE ? Opera Full support YesSafari ? WebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS ? Samsung Internet Android ?
initStorageEvent
Non-standard
Chrome Full support YesEdge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
keyChrome Full support 1Edge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
newValueChrome Full support 1Edge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
oldValueChrome Full support 1Edge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
storageAreaChrome Full support 3Edge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?
urlChrome Full support 5Edge Full support 12Firefox Full support YesIE ? Opera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android ?

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.

Document Tags and Contributors

Last updated by: Konrud,