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

CKTIS / HTML

onpagehide — tratar a saída de uma página

O atributo onpagehide em body regista um processador para o evento pagehide do objeto Window. Num evento gerado pelo navegador, o valor true de event.persisted indica que o navegador pretende conservar o documento para uma possível reutilização, não que o conserve efetivamente.

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

Sintaxe

<body onpagehide="JavaScript statements">

onpagehide é um atributo processador de eventos para pagehide. Quando colocado em body, trata o evento em Window, e não um evento limitado a esse elemento. Não é um atributo global disponível em qualquer elemento. A norma também o disponibiliza no elemento histórico frameset. O valor contém instruções JavaScript; o objeto do evento está disponível como event.

O evento pagehide diz respeito à saída de uma página, não apenas à mudança de separador. Num evento gerado pelo navegador, a propriedade persisted do objeto PageTransitionEvent tem o valor false quando o documento é abandonado definitivamente e true quando o navegador pretende conservá-lo para uma possível reutilização, por exemplo, na cache de navegação para trás/para a frente (bfcache). O valor true não garante que o documento seja efetivamente conservado nem que seja restaurado mais tarde.

O equivalente em JavaScript é window.onpagehide = handler; a atribuição substitui o processador anterior dessa propriedade. window.addEventListener('pagehide', handler) permite registar processadores independentes. O exemplo envia um evento sintético para obter um resultado reproduzível: não sai da página nem a coloca no bfcache.

Exemplos

<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>onpagehide demo</title>
<body onpagehide="document.getElementById('result').textContent = event.type + ': persisted=' + event.persisted">
  <output id="result">Waiting</output>
  <script>
    window.dispatchEvent(new PageTransitionEvent('pagehide', {
      persisted: true
    }));
  </script>
</body>
</html>

Resultado

pagehide: persisted=true

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