Window: storage event
The storage event of the Window interface fires when another document that shares the same storage area (either localStorage or sessionStorage) as the current window updates that storage area. The event is not fired on the window that made the change.
- For
localStorage, the event is fired in all other browsing contexts that are in the same origin as the initiating document. This includes other tabs with the same origin. - For
sessionStorage, the event is fired in all other browsing contexts that are in the same origin and the same top-level browsing context as the initiating document. This only includes embedded iframes, if any, in the same tab, and not other tabs.
This event is not cancelable and does not bubble.
Syntax
Use the event name in addEventListener():
addEventListener("storage", (event) => { })
Alternatively, assign to the event handler property of the interface:
onstorage = (event) => { }
Event type
A StorageEvent. Inherits from Event.
Event handler aliases
In addition to the Window interface, the event handler property onstorage is also available on the following targets:
Examples
Log the sampleList item to the console when the storage event fires:
window.addEventListener("storage", () => {
// When local storage changes, dump the list to
// the console.
console.log(JSON.parse(window.localStorage.getItem("sampleList")));
});
The same action can be achieved using the onstorage event handler property (but note that this replaces other event listeners added using onstorage, if any):
window.onstorage = () => {
// When local storage changes, dump the list to
// the console.
console.log(JSON.parse(window.localStorage.getItem("sampleList")));
};