ToggleEvent

Baseline 広く利用可能 *

この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年11月以降、すべてのブラウザーで利用可能です。

* この機能の一部は、対応レベルが異なる場合があります。

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

ToggleEvent インターフェイスは、ポップオーバー要素の状態が表示と非表示の間で切り替わるときにユーザーに通知するイベントを表します。

これは HTMLElement の beforetoggle および toggle イベントのためのイベントオブジェクトであり、表示中と非表示の間で遷移したときに（それぞれ前と後に）ポップオーバーで発行されます。

メモ: ToggleEvent は HTMLDetailsElement の toggle イベントとは関係ありません。こちらは <details> において、open/closed の状態が変化したときに発生します。こちらのイベントオブジェクトは一般的な Event です。

コンストラクター

ToggleEvent(): ToggleEvent オブジェクトを作成します。

インスタンスプロパティ

このインターフェイスは、親である Event からプロパティを継承しています。

ToggleEvent.newState 読取専用: （"open" または "closed"の）文字列で、要素が遷移した後の状態を表します。
ToggleEvent.oldState 読取専用: （"open" または "closed"の）文字列で、要素が遷移する前の状態を表します。

例

基本的な例

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