Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / HTML

ontoggle — gérer les changements d’état d’ouverture

L’attribut ontoggle contient du JavaScript qui gère l’événement toggle après le changement de l’état d’ouverture d’un élément. Cela concerne notamment details, dialog et les éléments utilisés comme popovers. L’attribut n’ouvre ni ne ferme lui-même un élément.

Version : WHATWG HTML Living Standard; index snapshot date recorded separately

Syntaxe

ontoggle="JavaScript statements"
element.ontoggle = (event) => { /* handler */ };
element.addEventListener("toggle", (event) => { /* listener */ });

ontoggle est un attribut de gestion de l’événement toggle ; sa valeur est du code JavaScript, et non une valeur booléenne. Il est disponible sur les éléments HTML, mais son ajout ne crée pas de comportement de divulgation. L’événement est déclenché lors des changements d’état de details, dialog et des éléments utilisés comme popover.

Dans le code de l’attribut, event désigne l’événement et this désigne l’élément qui le gère. L’objet ToggleEvent fournit oldState et newState, dont les valeurs sont "open" ou "closed". toggle signale un changement effectué : il ne remonte pas dans la phase de propagation et ne peut pas être annulé. preventDefault() n’annule pas le changement.

La notification est mise en file d’attente, et des changements successifs rapides peuvent être regroupés en un seul événement. Ne supposez donc pas qu’un appel du gestionnaire aura lieu pour chaque changement d’état. beforetoggle est un événement distinct, déclenché avant un changement par les mécanismes qui le prennent en charge ; ce n’est pas une forme antérieure de toggle disponible pour chaque changement de details.

En JavaScript, vous pouvez affecter une fonction à la propriété element.ontoggle ; une nouvelle affectation remplace la fonction précédente à cet emplacement de gestion. addEventListener("toggle", handler) permet d’enregistrer des écouteurs indépendants. L’exemple utilise l’attribut pour montrer sa syntaxe : le script ouvre details, et le gestionnaire met à jour le texte lorsque l’événement est distribué.

Exemples

<!doctype html>
<html lang="en">
<meta charset="utf-8">
<title>ontoggle example</title>
<details id="panel" ontoggle="document.getElementById('status').textContent = event.oldState + ' -> ' + event.newState">
  <summary>Details</summary>
  <p>Extra information.</p>
</details>
<pre id="status">Waiting</pre>
<script>
  document.getElementById('panel').open = true;
</script>
</html>

Résultat

closed -> open

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources