Tutorial de formularios accesibles

El patrón que sigue todo formulario de Lily, sea cual sea el framework: etiquetar cada control, comprobar al enviar, poner cada error junto a su campo y resumir los errores donde llega el foco.

Lo que vas a construir

Un formulario de dos campos que, al enviarse con errores, dice qué está mal, junto a cada campo y en un resumen arriba, y lleva el foco allí, para que quien usa el teclado o un lector de pantalla encuentre los errores de inmediato. Se muestra en HTML sencillo con las clases de Lily; cada catálogo de framework genera el mismo marcado con sus propios componentes Field, Hint, ErrorMessage y ErrorSummary . Unos 20 minutos; conviene hacer antes el tutorial de HTML .

Paso 1 — Etiquetar cada control y decir qué se espera

<form class="form" novalidate>
  <div class="field">
    <label class="label" for="name">Full name</label>
    <input class="text-input" type="text" id="name" name="name" autocomplete="name" required />
  </div>
  <div class="field">
    <label class="label" for="email">Email</label>
    <p class="hint" id="email-hint">We only use this to send your appointment.</p>
    <input class="email-input" type="email" id="email" name="email"
      autocomplete="email" aria-describedby="email-hint" required />
  </div>
  <button class="button" type="submit">Continue</button>
</form>
  • Un <label for> visible en cada control, nunca un texto de ejemplo en su lugar: desaparece en cuanto se escribe.
  • Una indicación se une al nombre del campo mediante aria-describedby, así que un lector de pantalla la lee junto con el campo.
  • autocomplete permite que el navegador rellene lo que ya sabe (WCAG 1.3.5).
  • novalidate desactiva los avisos propios del navegador, porque mostrarás los errores tú, con tus palabras y en tu idioma. Los atributos required y type se mantienen: tu script los lee.

Paso 2 — Comprobar al enviar, no mientras se escribe

Decirle a alguien que su correo es incorrecto tras la primera letra es ruido. Comprueba al enviar. Los 63 temas ya marcan un campo como no válido solo después de editarlo y salir de él (:user-invalid), o cuando estableces aria-invalid="true", así que nada se vuelve rojo al cargar la página.

Nunca desactives el botón de envío hasta que el formulario sea válido: un botón desactivado no puede explicar por qué.

Paso 3 — Poner cada error junto a su campo

<div class="field">
  <label class="label" for="email">Email</label>
  <p class="hint" id="email-hint">We only use this to send your appointment.</p>
  <p class="error-message" id="email-error">Enter an email address in the right format, like name@example.com</p>
  <input class="email-input" type="email" id="email" name="email" autocomplete="email"
    aria-invalid="true" aria-describedby="email-hint email-error" required />
</div>
  • aria-invalid="true" indica que el campo es incorrecto; el mensaje dice por qué y cómo corregirlo.
  • El mensaje está en aria-describedby, después de la indicación, así que se lee cuando el campo recibe el foco.
  • Di qué hacer, no solo qué está mal: «Introduce una dirección de correo con el formato correcto», no «No válido».
  • Nunca solo el color: el texto es el error; el borde rojo solo lo repite (WCAG 1.4.1).

Paso 4 — Resumir los errores donde llega el foco

<div class="error-summary" role="alert" tabindex="-1" aria-labelledby="error-summary-title">
  <h2 id="error-summary-title">There is a problem</h2>
  <ul>
    <li><a href="#name">Enter your full name</a></li>
    <li><a href="#email">Enter an email address in the right format, like name@example.com</a></li>
  </ul>
</div>

Colócalo arriba del formulario y mueve el foco a él al enviar. Cada enlace lleva directamente a su campo. tabindex="-1" permite que el resumen reciba el foco sin añadir una parada de tabulación.

Paso 5 — El script que lo une todo

const messages = {
  name: { valueMissing: "Enter your full name" },
  email: {
    valueMissing: "Enter your email address",
    typeMismatch: "Enter an email address in the right format, like name@example.com",
  },
};

const form = document.querySelector("form");
form.addEventListener("submit", (event) => {
  form.querySelector(".error-summary")?.remove();
  const errors = [];
  for (const field of form.querySelectorAll("input")) {
    const old = document.getElementById(field.id + "-error");
    old?.remove();
    const describedBy = (field.getAttribute("aria-describedby") ?? "")
      .split(" ").filter((id) => id && id !== field.id + "-error");
    const problem = Object.keys(messages[field.name] ?? {}).find((key) => field.validity[key]);
    if (!problem) {
      field.removeAttribute("aria-invalid");
      field.setAttribute("aria-describedby", describedBy.join(" "));
      continue;
    }
    const text = messages[field.name][problem];
    const message = document.createElement("p");
    message.className = "error-message";
    message.id = field.id + "-error";
    message.textContent = text;
    field.before(message);
    field.setAttribute("aria-invalid", "true");
    field.setAttribute("aria-describedby", [...describedBy, message.id].join(" "));
    errors.push({ id: field.id, text });
  }
  if (errors.length === 0) return; // valid: let it submit
  event.preventDefault();
  const summary = document.createElement("div");
  summary.className = "error-summary";
  summary.setAttribute("role", "alert");
  summary.tabIndex = -1;
  summary.setAttribute("aria-labelledby", "error-summary-title");
  summary.innerHTML = '<h2 id="error-summary-title">There is a problem</h2><ul></ul>';
  for (const { id, text } of errors) {
    const link = document.createElement("a");
    link.href = "#" + id;
    link.textContent = text;
    const item = document.createElement("li");
    item.append(link);
    summary.querySelector("ul").append(item);
  }
  form.prepend(summary);
  summary.focus();
});

Los mensajes son tuyos, en tu idioma: la propiedad validity del navegador indica qué regla falló, y tu tabla dice qué comunicar a la persona. Lily no incluye texto en inglés que traducir.

Comprueba tu trabajo: envía el formulario vacío con el teclado. El foco pasa al resumen y un lector de pantalla lee «There is a problem» y ambos errores. Sigue un enlace: el foco llega al campo, que se lee con su indicación y su error. Corrige ambos y envía: el formulario se envía y no queda ningún error.

Qué evitar

  • Limitar o corregir lo que alguien escribió sin decírselo; díselo.
  • Vaciar un formulario cuando hay un error: conserva todo lo que se introdujo.
  • Un error que solo aparece al pasar el puntero, o solo en una información emergente.
  • Que un formulario caduque sin aviso; usa timeout-dialog para avisar y ampliar el tiempo.

Próximos pasos