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

CKTIS / HTML

onclose — tratar um evento close

O atributo onclose contém código JavaScript que trata o evento close. Uma utilização comum é reagir ao fecho de um elemento dialog, por exemplo lendo o seu returnValue. Não é um mecanismo para impedir o fecho.

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

Sintaxe

onclose="JavaScript statements"

onclose é um atributo global de tratamento do evento close. O seu valor é código JavaScript, não um valor booleano. Pode ser escrito em qualquer elemento HTML, mas a presença do atributo, por si só, não faz com que o elemento emita este evento.

Uma utilização comum é com o elemento dialog. A chamada a close() fecha uma caixa de diálogo aberta e coloca um evento close na fila. No processador do atributo, this refere-se ao elemento e event disponibiliza o objeto do evento. O resultado do fecho pode ser lido através de this.returnValue.

O evento close de um elemento dialog não propaga e não pode ser cancelado. Para impedir um pedido de fecho, trata o evento cancelável cancel; o próprio close() ignora essa etapa. Remover manualmente o atributo open não dispara close.

Não confundas o atributo com a propriedade JavaScript element.onclose, à qual se atribui uma função, nem com addEventListener('close', handler), que permite registar vários listeners. No exemplo, o processador lê o resultado done e atualiza o texto apenas depois de o evento colocado na fila ser despachado.

Exemplos

<!doctype html>
<meta charset="utf-8">
<title>onclose</title>
<dialog id="demo" onclose="document.getElementById('result').textContent = 'closed: ' + this.returnValue">
  <p>Dialog</p>
</dialog>
<output id="result">waiting</output>
<script>
  const dialog = document.getElementById('demo');
  dialog.show();
  dialog.close('done');
</script>

Resultado

closed: done

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