Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / HTML

onstorage — tratar alterações do Web Storage

O atributo onstorage em body define o processador Window do evento storage. Permite reagir a alterações em localStorage ou sessionStorage partilhados, feitas noutro documento e não no documento que efetua a escrita.

Versão: WHATWG HTML Living Standard; index snapshot date recorded separately

Sintaxe

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

onstorage é um atributo de processamento de eventos em body, não um atributo global. O seu valor contém código JavaScript com o parâmetro event disponível. Processa o evento storage do objeto Window, não um evento dirigido ao próprio body. O equivalente em JavaScript é window.onstorage: atribuir uma nova função substitui o processador existente e atribuir null remove-o.

Uma alteração real no armazenamento notifica assincronamente outros documentos que partilham essa área de armazenamento, mas não o documento que efetua a escrita. Para localStorage, podem ser outros separadores da mesma origem. Para sessionStorage, têm também de pertencer ao mesmo contexto de navegação de nível superior, como frames no mesmo separador. Escrever um valor idêntico não desencadeia uma notificação.

O StorageEvent expõe key, oldValue, newValue, o url do documento que efetua a alteração e storageArea. Para uma chave nova, oldValue é null; para uma chave removida, newValue é null; e clear() define os três campos de dados como null. Uma operação que não altera nada não envia uma notificação.

O exemplo envia um evento sintético sem modificar o armazenamento, para demonstrar o funcionamento do atributo de forma determinística. Não testa a comunicação entre documentos. Para o executar, é necessário ter JavaScript ativado e permitir processadores de eventos inline.

Exemplos

<!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>

Resultado

theme: light -> dark

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes