HTMLDetailsElement: toggle event

The toggle event fires when the open/closed state of a <details> element is toggled.

Interface Event
Bubbles No
Cancelable No
Default Action Toggles the open state of the <details> element.
Event handler property None

Examples

This example logs chapters that are open. Chapters are removed from the log when they are closed.

HTML

<aside id="log">
  <b>Open chapters:</b>
  <div data-id="ch1" hidden>I</div>
  <div data-id="ch2" hidden>II</div>
  <div data-id="ch3" hidden>III</div>
</aside>
<section id="summaries">
  <b>Chapter summaries:</b>
  <details id="ch1">
    <summary>Chapter I</summary>
    Philosophy reproves Boethius for the foolishness of his complaints against Fortune. Her very nature is caprice.
  </details>
  <details id="ch2">
    <summary>Chapter II</summary>
    Philosophy in Fortune's name replies to Boethius' reproaches, and proves that the gifts of Fortune are hers to give and to take away.
  </details>
  <details id="ch3">
    <summary>Chapter III</summary>
    Boethius falls back upon his present sense of misery. Philosophy reminds him of the brilliancy of his former fortunes.
  </details>
</section>

CSS

body {
  display: flex;
  flex-direction: row-reverse;
}

#log {
  flex-shrink: 0;
  padding-left: 3em;
}

#summaries {
  flex-grow: 1;
}

JavaScript

function logItem(e) {
  const item = document.querySelector(`[data-id=${e.target.id}]`);
  item.toggleAttribute('hidden');
}

const chapters = document.querySelectorAll('details');
chapters.forEach((chapter) => {
  chapter.addEventListener('toggle', logItem);
});

Result

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'toggle event' in that specification.
Living Standard  

Browser compatibility

No compatibility data found. Please contribute data for "api.HTMLDetailsElement.toggle_event" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

Contributors to this page: chrisdavidmills, mdnwebdocs-bot, mfluehr, Claas
Last updated by: chrisdavidmills,