W3cubDocs

/Web APIs

ToggleEvent: ToggleEvent() constructor

The ToggleEvent() constructor creates a new ToggleEvent object.

Syntax

js

new ToggleEvent(type, init)

Parameters

type

A string representing the type of event. In the case of ToggleEvent this is always toggleevent.

init

An object containing the following properties:

newState

A string representing the state the element is transitioning to. Possible values are "open" and "closed".

oldState

A string representing the state the element is transitioning from. Possible values are "open" and "closed".

Examples

A developer would not use this constructor manually. A new ToggleEvent object is constructed when a handler is invoked as a result of a relevant event firing.

For example:

js

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
ToggleEvent 114 114 114 No 100 17 114 114 No No 17 No

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ToggleEvent/ToggleEvent