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

CKTIS / JavaScript

DOMTokenList : ajouter, supprimer et basculer des jetons

Modifiez des jetons individuellement avec `add()`, `remove()` et `toggle()`. Utilisez `force` lorsqu’une condition doit déterminer la présence d’un jeton.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

list.add(...tokens)
list.remove(...tokens)
list.toggle(token)
list.toggle(token, force)

element.classList donne accès à une DOMTokenList : un ensemble dynamique de jetons uniques qui distingue les majuscules des minuscules. Modifier la liste met à jour l’attribut class, et toute modification de l’attribut reste visible même via une référence à la liste enregistrée auparavant. Ces méthodes relèvent des API du DOM, pas d’ECMAScript ; l’environnement d’exécution doit fournir les API du DOM nécessaires.

add() ajoute les jetons indiqués sans créer de doublons. remove() supprime les jetons indiqués et ignore ceux qui sont absents. Les deux méthodes acceptent plusieurs jetons comme arguments distincts et renvoient undefined.

toggle(token) inverse l’état d’un seul jeton : il l’ajoute s’il est absent ou le supprime s’il est présent. Avec toggle(token, force), true garantit sa présence et false son absence. Les deux formes indiquent si le jeton est présent après l’appel, et non si la liste a changé. Utilisez toggle(token, condition) pour faire dépendre la présence du jeton d’une condition booléenne.

Dans les trois méthodes, un jeton vide déclenche une DOMException nommée SyntaxError, tandis qu’un jeton contenant un caractère d’espacement ASCII déclenche une DOMException nommée InvalidCharacterError. Passez list.add("a", "b"), et non list.add("a b") : les arguments ne sont pas découpés en jetons.

Exemples

{
  function createExampleElement() {
    if (typeof document !== "undefined") {
      return document.createElement("div");
    }

    // Without a DOM, model only the operations used here with valid tokens.
    const tokens = new Set();
    return {
      classList: {
        add(...values) {
          for (const value of values) tokens.add(value);
        },
        remove(...values) {
          for (const value of values) tokens.delete(value);
        },
        toggle(value, force = !tokens.has(value)) {
          if (force) tokens.add(value);
          else tokens.delete(value);
          return tokens.has(value);
        }
      },
      getAttribute(name) {
        return name === "class" ? [...tokens].join(" ") : null;
      }
    };
  }

  const element = createExampleElement();
  const list = element.classList;

  list.add("card", "pending", "card");
  list.remove("pending", "missing");

  console.log(list.toggle("active"));
  console.log(list.toggle("active"));
  console.log(list.toggle("ready", true));
  console.log(list.toggle("active", false));
  console.log(element.getAttribute("class"));
}

Résultat

true
false
true
false
card ready

Exécutez le code dans la console d’un navigateur. L’élément n’est pas inséré dans la page. Les deux premiers résultats montrent l’ajout puis la suppression de `active`. Les deux suivants indiquent que `ready` est présent et que `active` reste absent. La dernière ligne contient la valeur de l’attribut `class`.

Leçons associées

  • JavaScript · Leçon 7 · Avancé · Version : 4
  • JavaScript · Leçon 32 · Intermédiaire · Version : 3
  • JavaScript · Leçon 34 · Intermédiaire · Version : 3
  • JavaScript · Leçon 43 · Intermédiaire · Version : 3

Sources