ToggleEvent
Baseline
Widely available
*
This feature is well established and works across many devices and browser versions. It’s been available across browsers since November 2023.
* Some parts of this feature may have varying levels of support.
The ToggleEvent interface represents an event that fires when a popover element is toggled between being shown and hidden.
This is the event object for the beforetoggle and toggle events, which fire on elements as follows:
Constructor
ToggleEvent()-
Creates a
ToggleEventobject.
Instance properties
This interface inherits properties from its parent, Event.
ToggleEvent.newStateRead only-
A string (either
"open"or"closed"), representing the state the element is transitioning to. ToggleEvent.oldStateRead only-
A string (either
"open"or"closed"), representing the state the element is transitioning from. ToggleEvent.sourceRead only-
An
Elementobject instance representing the HTML control that initiated the toggle.
Examples
Basic example
const popover = document.getElementById("mypopover");
// …
popover.addEventListener("beforetoggle", (event) => {
if (event.newState === "open") {
console.log("Popover is being shown");
} else {
console.log("Popover is being hidden");
}
});
Specifications
| Specification |
|---|
| HTML # toggleevent |