Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / HTML

onbeforetoggle — gestire un’imminente modifica dello stato

L’attributo `onbeforetoggle` imposta un gestore per `beforetoggle`. L’evento viene generato prima dell’apertura di un popover, ma non prima di ogni chiusura. Viene generato anche prima dei cambiamenti di stato di un elemento `dialog` avviati con metodi come `showModal()` o `close()`. Aggiungere o rimuovere direttamente l’attributo `open` di un elemento `dialog` non genera l’evento. Il gestore consente di controllare lo stato precedente e quello previsto e di annullare l’apertura.

Versione: WHATWG HTML Living Standard; index snapshot date recorded separately

Sintassi

onbeforetoggle="JavaScript statements"
element.onbeforetoggle = (event) => { /* handler */ };
element.addEventListener("beforetoggle", (event) => { /* listener */ });

onbeforetoggle è un attributo gestore di eventi per beforetoggle; il suo valore contiene codice JavaScript, non un valore booleano. La proprietà corrispondente è element.onbeforetoggle. L’evento viene generato prima che un popover si apra, ma non prima di ogni chiusura. Ad esempio, rimuovere dal documento un popover aperto lo chiude senza generare beforetoggle. Non fare quindi affidamento su questo evento per rilevare ogni chiusura. Per un elemento dialog, viene generato, ad esempio, quando si usa show() o showModal() per aprirlo oppure close() per chiuderlo. Aggiungere o rimuovere direttamente l’attributo open cambia lo stato dell’elemento dialog senza generare beforetoggle.

L’oggetto ToggleEvent espone oldState e newState, i cui valori sono "closed" o "open". Durante l’apertura, l’evento può essere annullato con event.preventDefault(). Se viene generato durante la chiusura, non è annullabile. toggle è un evento distinto che segnala una modifica dello stato: non confonderlo con beforetoggle.

Il codice dell’attributo ha accesso a event; anche return false annulla un evento annullabile. Assegnare una funzione a element.onbeforetoggle sostituisce il gestore già presente in quella proprietà. In alternativa, addEventListener("beforetoggle", handler) permette di aggiungere listener indipendenti.

L’esempio annulla l’apertura richiesta da showPopover(), quindi il testo atteso è open: false. È necessario un browser che implementi queste funzionalità e consenta i gestori di eventi in linea. Aggiungere onbeforetoggle da solo non conferisce a un elemento il comportamento popover.

Esempi

<!doctype html>
<meta charset="utf-8">
<title>onbeforetoggle</title>
<div id="panel" popover="manual"
     onbeforetoggle="if (event.newState === 'open') event.preventDefault()">
  Popover
</div>
<pre id="result"></pre>
<script>
  const panel = document.getElementById('panel');
  panel.showPopover();
  document.getElementById('result').textContent =
    'open: ' + panel.matches(':popover-open');
</script>

Risultato

open: false

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti