HTMLElement: toggle event

Das toggle-Ereignis des HTMLElement-Interfaces wird bei einem Popover-Element, einem <dialog>-Element oder einem <details>-Element unmittelbar nach dessen Anzeige oder Ausblenden ausgelöst.

  • Wenn das Element vom Zustand "versteckt" zu "sichtbar" wechselt, wird die Eigenschaft event.oldState auf closed und die Eigenschaft event.newState auf open gesetzt.
  • Falls das Element von "sichtbar" zu "versteckt" wechselt, wird event.oldState auf open und event.newState auf closed gesetzt.

Dieses Ereignis ist nicht cancelable.

Syntax

Verwenden Sie den Ereignisnamen in Methoden wie addEventListener() oder setzen Sie eine Ereignis-Handler-Eigenschaft.

js
addEventListener("toggle", (event) => {});

ontoggle = (event) => {};

Ereignistyp

Beispiele

Der folgende Beispielcode zeigt, wie das toggle-Ereignis für ein Popover verwendet werden kann. Der gleiche Code kann für ein <dialog>- oder <details>-Element auf die gleiche Weise verwendet werden.

Einfaches Beispiel

Dieses Beispiel zeigt, wie man dem toggle-Ereignis zuhört und das Ergebnis protokolliert.

HTML

Das HTML besteht aus einem Popover und einem Button, um es zu öffnen und zu schließen.

html
<button popovertarget="mypopover">Toggle the popover</button>
<div id="mypopover" popover>Popover content</div>

JavaScript

Der Code fügt einen Ereignis-Listener für das toggle-Ereignis hinzu und protokolliert den Zustand.

js
const popover = document.getElementById("mypopover");

popover.addEventListener("toggle", (event) => {
  if (event.newState === "open") {
    console.log("Popover has been shown");
  } else {
    console.log("Popover has been hidden");
  }
});

Ergebnis

Eine Anmerkung zur Zusammenfassung von toggle-Ereignissen

Wenn mehrere toggle-Ereignisse ausgelöst werden, bevor der Ereignisschleifen-Zyklus durchläuft, wird nur ein einziges Ereignis ausgelöst. Dies wird als "Ereignis-Zusammenfassung" bezeichnet.

Zum Beispiel:

js
popover.addEventListener("toggle", () => {
  //...
});

popover.showPopover();
popover.hidePopover();
// `toggle` only fires once

Weitere Beispiele

Spezifikationen

Specification
HTML Standard
# event-toggle

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch