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

CKTIS / HTML

onpageswap — gerir um documento de saída durante a navegação

O atributo onpageswap em body define o processador Window para o evento pageswap. Este evento diz respeito ao documento de saída durante a navegação; não indica que uma nova página apareceu.

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

Sintaxe

<body onpageswap="JavaScript statements">

onpageswap é um atributo de conteúdo que contém código JavaScript para um processador do evento pageswap. No elemento body, configura o processador de Window, e não um processador independente desse elemento. Não é um atributo booleano: o seu valor é código, e o parâmetro event fornece o evento.

O navegador pode enviar pageswap à janela do documento de saída quando este deixa de estar ativo devido à navegação. Não é necessário que o documento seja descarregado: o evento também pode ser disparado quando o navegador o mantém na cache de navegação para trás e para a frente (bfcache). O evento real utiliza a interface PageSwapEvent; a sua propriedade viewTransition pode disponibilizar uma transição de vista ou ter o valor null. Não confundas este evento com pagereveal, que diz respeito ao início da apresentação de um documento. pageswap não serve para cancelar uma navegação.

O atributo em body e a propriedade window.onpageswap configuram o mesmo processador: atribuir uma nova função substitui a anterior. A alternativa window.addEventListener('pageswap', handler) adiciona processadores independentes sem substituir essa propriedade. A política Content Security Policy pode bloquear código nos atributos; nesse caso, utiliza um script externo permitido.

O script do exemplo apenas regista na consola o resultado de duas verificações: se body tem o atributo onpageswap e se window disponibiliza a propriedade onpageswap. O script não dispara nenhum evento nem inicia uma navegação, pelo que o resultado não confirma que o processador definido no atributo seja executado.

Exemplos

<!doctype html>
<html lang="en">
<head><meta charset="utf-8"><title>Body onpageswap handler</title></head>
<body onpageswap="document.body.dataset.received = event.type">
  <script>
    console.log('onpageswap attribute present: ' + document.body.hasAttribute('onpageswap'));
    console.log('onpageswap event property available: ' + ('onpageswap' in window));
  </script>
</body>
</html>

Resultado

onpageswap attribute present: true
onpageswap event property available: 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