ToggleEvent: ToggleEvent() コンストラクター

Baseline 2023

Newly available

Since November 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.

Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

ToggleEvent() コンストラクターは、新しい ToggleEvent オブジェクトを生成します。

構文

new ToggleEvent(type, init)

引数

type

文字列で、イベントの方を表します。ToggleEvent の場合、これは常に toggleevent です。

init

以下のプロパティを持つオブジェクトです。

newState

文字列で、この要素が遷移した後の状態を表します。取りうる値は "open" および "closed" です。

oldState

文字列で、この要素が遷移する前の状態を表します。取りうる値は "open" および "closed" です。

例

開発者がこのコンストラクタを手動で使用することはないでしょう。関連するイベントが発行された結果、ハンドラーが呼び出されると、新しい ToggleEvent オブジェクトが生成されます。

例えば次の通りです。

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");
  }
});