CKTIS / HTML
onbeforeunload — tratar um evento antes de sair de uma página
O atributo onbeforeunload em body define um processador para o evento beforeunload do objeto Window. Pode solicitar um aviso antes de sair da página, mas não garante que seja apresentada uma caixa de diálogo nem que a navegação seja cancelada.
Versão: WHATWG HTML Living Standard; index snapshot date recorded separately
Sintaxe
<body onbeforeunload="event.preventDefault()">onbeforeunload é um atributo processador de eventos em body. O seu valor é código JavaScript, não um nome de evento nem um valor booleano. Trata o evento beforeunload do objeto Window, e não um evento dirigido ao próprio body. A propriedade JavaScript correspondente é window.onbeforeunload.
Ao sair efetivamente de uma página, o processador pode chamar event.preventDefault() para pedir confirmação. Um mecanismo antigo consiste em definir event.returnValue como uma cadeia não vazia. Uma regra especial de onbeforeunload também permite devolver um valor diferente de null e undefined para cancelar o evento; não transponhas para aqui o padrão habitual return false. O valor devolvido por uma função passada a addEventListener() não funciona desta forma.
Cancelar o evento não garante que a navegação pare: o navegador decide se apresenta uma confirmação, e o utilizador pode optar por sair. A caixa de diálogo requer uma ativação prévia do utilizador e pode ser suprimida pelas restrições do navegador. Não é possível definir um texto de aviso personalizado. Ativa o processador apenas quando existirem alterações por guardar e remove-o depois de guardar; não o consideres um mecanismo garantido para guardar dados.
O exemplo envia para window um evento sintético e cancelável e verifica event.defaultPrevented. O resultado esperado é true. Não testa uma navegação real nem uma caixa de diálogo; em seguida, remove o atributo para não deixar nenhum processador ativo.
Exemplos
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>onbeforeunload wiring test</title>
</head>
<body onbeforeunload="event.preventDefault()">
<p>See the browser console.</p>
<script>
const event = new Event('beforeunload', { cancelable: true });
window.dispatchEvent(event);
console.log(event.defaultPrevented);
document.body.removeAttribute('onbeforeunload');
</script>
</body>
</html>Resultado
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.