A StorageEvent
is sent to a window when a storage area it has access to is changed within the context of another document.
<div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 11.666666666666666%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-50 0 600 70" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/Event" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Event</text></a><polyline points="76,25 86,20 86,30 76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/StorageEvent" target="_top"><rect x="116" y="1" width="120" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="176" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">StorageEvent</text></a></svg></div>
a:hover text { fill: #0095DD; pointer-events: all;}
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
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.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
StorageEvent | Chrome Full support 1 | Edge Full support Yes | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
StorageEvent() constructor | Chrome Full support 17 | Edge ? | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari ? | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS ? | Samsung Internet Android ? |
initStorageEvent | Chrome Full support Yes | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
key | Chrome Full support 1 | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
newValue | Chrome Full support 1 | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
oldValue | Chrome Full support 1 | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
storageArea | Chrome Full support 3 | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung Internet Android ? |
url | Chrome Full support 5 | Edge Full support 12 | Firefox Full support Yes | IE ? | Opera Full support Yes | Safari Full support Yes | WebView Android Full support Yes | Chrome Android Full support Yes | Firefox Android Full support Yes | Opera Android Full support Yes | Safari iOS Full support Yes | Samsung 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.