WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / HTML

onstorage — Änderungen an Web Storage behandeln

Das Attribut onstorage auf body legt den Window-Handler für das storage-Ereignis fest. Damit lassen sich Änderungen an gemeinsam genutztem localStorage oder sessionStorage behandeln, die in einem anderen Dokument vorgenommen wurden, nicht im Dokument, das den Schreibvorgang ausführt.

Version: WHATWG HTML Living Standard; index snapshot date recorded separately

Syntax

<body onstorage="handleStorage(event)">…</body>
window.onstorage = handleStorage;

onstorage ist ein Ereignis-Handler-Attribut auf body, kein globales Attribut. Sein Wert enthält JavaScript-Code mit dem verfügbaren Parameter event. Es behandelt das storage-Ereignis des Window-Objekts, nicht ein Ereignis, das auf body selbst zielt. Das JavaScript-Gegenstück ist window.onstorage; durch Zuweisen einer neuen Funktion wird der vorhandene Handler ersetzt, durch Zuweisen von null wird er entfernt.

Eine tatsächliche Speicheränderung benachrichtigt asynchron andere Dokumente, die denselben Speicherbereich verwenden, nicht aber das Dokument, das den Schreibvorgang ausführt. Bei localStorage können dies andere Tabs desselben Ursprungs sein. Bei sessionStorage müssen sie zusätzlich zum selben obersten Browsing-Kontext gehören, etwa Frames innerhalb desselben Tabs. Das Schreiben eines identischen Werts löst keine Benachrichtigung aus.

Das StorageEvent stellt key, oldValue, newValue, die url des ändernden Dokuments und storageArea bereit. Bei einem neuen Schlüssel ist oldValue gleich null, bei einem entfernten Schlüssel ist newValue gleich null, und clear() setzt alle drei Datenfelder auf null. Eine Operation, die nichts ändert, sendet keine Benachrichtigung.

Das Beispiel löst ein synthetisches Ereignis aus, ohne den Speicher zu ändern, um das Verhalten des Attributs reproduzierbar zu zeigen. Es testet nicht die Kommunikation zwischen Dokumenten. Für die Ausführung müssen JavaScript aktiviert und Inline-Ereignis-Handler erlaubt sein.

Beispiele

<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>onstorage demo</title>
<body onstorage="document.getElementById('result').textContent = event.key + ': ' + event.oldValue + ' -> ' + event.newValue">
<pre id="result">Waiting</pre>
<script>
window.dispatchEvent(new StorageEvent('storage', {
  key: 'theme',
  oldValue: 'light',
  newValue: 'dark'
}));
</script>
</body>
</html>

Ergebnis

theme: light -> dark

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen