Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

DOMTokenList: añadir, eliminar y alternar tokens

Modifica tokens individuales con `add()`, `remove()` y `toggle()`. Usa el argumento `force` cuando una condición deba determinar si un token está presente.

Versión: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxis

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

element.classList ofrece una DOMTokenList: un conjunto dinámico de tokens únicos que distingue entre mayúsculas y minúsculas. Modificar la lista actualiza el atributo class, y los cambios en el atributo se reflejan incluso en una referencia a la lista guardada anteriormente. Estos métodos pertenecen a la API del DOM, no a ECMAScript; el entorno de ejecución debe proporcionar las API del DOM necesarias.

add() añade los tokens indicados sin crear duplicados. remove() elimina los tokens indicados e ignora los que no estén presentes. Ambos métodos aceptan varios tokens como argumentos separados y devuelven undefined.

toggle(token) invierte la presencia de un solo token: lo añade si no estaba o lo elimina si estaba. Con toggle(token, force), true garantiza su presencia y false su ausencia. Ambas formas devuelven si el token está presente después de la llamada, no si hubo un cambio. Usa toggle(token, condicion) para que la presencia del token dependa de una condición booleana.

En los tres métodos, un token vacío provoca una DOMException llamada SyntaxError; si contiene un carácter de espacio en blanco ASCII, la DOMException se llama InvalidCharacterError. Utiliza list.add("a", "b"), no list.add("a b"): los argumentos no se dividen en tokens.

Ejemplos

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

Resultado

true
false
true
false
card ready

Ejecuta el código en la consola del navegador. El elemento no se inserta en la página. Los dos primeros resultados muestran cómo se añade y se elimina `active`. Los dos siguientes indican que `ready` está presente y que `active` sigue ausente. La última línea contiene el valor del atributo `class`.

Lecciones relacionadas

  • JavaScript · Lección 7 · Avanzado · Versión: 4
  • JavaScript · Lección 32 · Intermedio · Versión: 3
  • JavaScript · Lección 34 · Intermedio · Versión: 3
  • JavaScript · Lección 43 · Intermedio · Versión: 3

Fuentes