Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

DOMTokenList: aggiungere, rimuovere e alternare token

Modifica singoli token con `add()`, `remove()` e `toggle()`. Usa l’argomento `force` quando la presenza di un token deve dipendere da una condizione.

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

Sintassi

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

element.classList espone una DOMTokenList: un insieme di token univoci che si aggiorna in tempo reale e distingue maiuscole e minuscole. Modificare l’elenco aggiorna l’attributo class, e le modifiche all’attributo sono visibili anche tramite un riferimento all’elenco salvato in precedenza. Questi metodi fanno parte delle API del DOM, non di ECMAScript; l’ambiente di esecuzione deve fornire le API del DOM necessarie.

add() aggiunge i token indicati senza creare duplicati. remove() rimuove i token indicati e ignora quelli assenti. Entrambi i metodi accettano più token come argomenti separati e restituiscono undefined.

toggle(token) inverte lo stato di un solo token: lo aggiunge se è assente o lo rimuove se è presente. Con toggle(token, force), true ne garantisce la presenza e false l’assenza. Entrambe le forme restituiscono un booleano che indica se il token è presente dopo la chiamata, non se qualcosa è cambiato. Usa toggle(token, condizione) per far dipendere la presenza del token da una condizione booleana.

In tutti e tre i metodi, un token vuoto genera una DOMException chiamata SyntaxError; un token contenente un carattere di spaziatura ASCII genera una DOMException chiamata InvalidCharacterError. Usa list.add("a", "b"), non list.add("a b"): gli argomenti non vengono suddivisi in token.

Esempi

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

Risultato

true
false
true
false
card ready

Esegui il codice nella console del browser. L’elemento non viene inserito nella pagina. I primi due risultati mostrano l’aggiunta e la rimozione di `active`; i successivi indicano che `ready` è presente e `active` resta assente. L’ultima riga contiene il valore dell’attributo `class`.

Lezioni correlate

  • JavaScript · Lezione 7 · Avanzato · Versione: 4
  • JavaScript · Lezione 32 · Intermedio · Versione: 3
  • JavaScript · Lezione 34 · Intermedio · Versione: 3
  • JavaScript · Lezione 43 · Intermedio · Versione: 3

Fonti