HTMLElement: toggle event
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("HTML DOM")}}
The **toggle** event of the {{domxref("HTMLElement")}} interface fires on a {{domxref("Popover_API", "popover", "", "nocode")}} element, {{htmlelement("dialog")}} element, or {{htmlelement("details")}} element just after it is shown or hidden.
- If the element is transitioning from hidden to showing, the [
event.oldState](/en-US/docs/Web/API/ToggleEvent/oldState) property will be set toclosedand the [event.newState](/en-US/docs/Web/API/ToggleEvent/newState) property will be set toopen. - If the element is transitioning from showing to hidden, then
event.oldStatewill beopenandevent.newStatewill beclosed.
This event is not cancelable.
Syntax
Use the event name in {{domxref("EventTarget/addEventListener", "addEventListener()")}}:
addEventListener("toggle", (event) => { })Alternatively, assign to the event handler property of the interface:
ontoggle = (event) => { }Event type
A {{domxref("ToggleEvent")}}. Inherits from {{domxref("Event")}}.
{{InheritanceDiagram("ToggleEvent")}}
Examples
The example code below demonstrates how the toggle event might be used for {{domxref("Popover_API", "popover", "", "nocode")}}. The same code is might be used for a {{htmlelement("dialog")}} or {{htmlelement("details")}} elements in the same way.
Basic example
This example shows how to listen for the toggle event and log the result.
HTML
The HTML consists of a popover and a button for toggling it open and closed.
<button popovertarget="mypopover">Toggle the popover</button>
<div id="mypopover" popover>Popover content</div>JavaScript
The code adds an event listener for the toggle event and logs the state.
const popover = document.getElementById("mypopover");
popover.addEventListener("toggle", (event) => {
if (event.newState === "open") {
log("Popover has been shown");
} else {
log("Popover has been hidden");
}
});Result
{{EmbedLiveSample("Basic example", '100%', "250px")}}
A note on toggle event coalescing
If multiple toggle events are fired before the event loop has a chance to cycle, only a single event will be fired. This is referred to as "event coalescing".
For example:
popover.addEventListener("toggle", () => {
// …
});
popover.showPopover();
popover.hidePopover();
// `toggle` only fires onceOther examples
- Opening a modal dialog example in
HTMLDialogElement
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- [
popover](/en-US/docs/Web/HTML/Reference/Global_attributes/popover) HTML global attribute - Popover API
- Related event: [
beforetoggle](/en-US/docs/Web/API/HTMLElement/beforetoggle_event)