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

CKTIS / JavaScript

DOMTokenList: comprobar y alternar tokens

`contains()` comprueba si un token está presente sin modificar la lista. `toggle()` alterna su presencia o la fija con `force` y devuelve si el token queda presente.

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

Sintaxis

tokens.contains(token)
tokens.toggle(token)
tokens.toggle(token, force)

element.classList proporciona una DOMTokenList que refleja en todo momento el atributo class del elemento. Estos métodos pertenecen a la API del DOM, no a ECMAScript 2024. Su compatibilidad depende del entorno de ejecución. En un navegador, el ejemplo usa el DOM nativo; en Node.js, usa una implementación simplificada para los tokens válidos del ejemplo.

tokens.contains(token) devuelve true si el token exacto está presente, y false en caso contrario. No modifica la lista, distingue entre mayúsculas y minúsculas y no busca subcadenas. Devuelve false para una cadena vacía o que contenga algún carácter de espacio en blanco ASCII.

tokens.toggle(token) añade un token ausente o elimina uno presente. tokens.toggle(token, true) garantiza que esté presente; tokens.toggle(token, false) garantiza que esté ausente. El resultado indica si el token está presente después de la llamada, no si la lista ha cambiado. Para que una clase dependa de una condición booleana, usa tokens.toggle(token, condition). Pasar undefined como force equivale a omitir el argumento: tokens.toggle(token, undefined) alterna la presencia del token. Cualquier otro valor que se pase como force se convierte a booleano: la cadena "false" se convierte en true, no en false.

toggle() admite un token cada vez. Una cadena vacía provoca una DOMException llamada SyntaxError; un carácter de espacio en blanco ASCII en el token provoca una DOMException llamada InvalidCharacterError, incluso si force vale false. Pasa el nombre de clase sin el punto del selector: "active", no ".active".

Ejemplos

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

    // Node.js has no browser DOM. This stand-in handles the valid tokens used below.
    const classes = new Set([initialClass]);
    return {
      get className() {
        return [...classes].join(" ");
      },
      classList: {
        contains(token) {
          return classes.has(token);
        },
        toggle(token, force) {
          const present = force === undefined ? !classes.has(token) : Boolean(force);
          if (present) classes.add(token);
          else classes.delete(token);
          return present;
        },
      },
    };
  }

  const element = createExampleElement("panel");
  const tokens = element.classList;

  console.log(tokens.contains("active"));
  console.log(tokens.toggle("active"));
  console.log(tokens.toggle("active"));
  console.log(tokens.toggle("active", true));
  console.log(tokens.toggle("active", true));
  console.log(tokens.toggle("active", false));
  console.log(element.className);
}

Resultado

false
true
false
true
true
false
panel

Las dos llamadas sin `force` primero añaden `active` y luego lo eliminan. Las dos llamadas con `true` devuelven `true`, aunque la segunda no cambia nada. La llamada con `false` elimina `active` y deja solo `panel`.

Lecciones relacionadas

  • JavaScript · Lección 31 · Intermedio · Versión: 3

Fuentes