Addaw, anar a la pàgina d'inici Donar

Tècnica Tècniques generals WCAG 2.2

G85Explicar en text com corregir una dada amb format incorrecte

Nom oficial al W3C: Proporcionar una descripció textual quan l'entrada de l'usuari no s'ajusta al format o als valors requerits

Versión en castellano

En poques paraules

Quan una dada no té el format correcte, com un DNI sense lletra o una data mal escrita, el web ho ha d'explicar amb text. El missatge diu quin camp és erroni i com corregir-lo: el format esperat, un exemple vàlid o un valor semblant que sí que s'accepta.

Per què és important

Un missatge com «Dades incorrectes» no ajuda ningú. La persona no sap què ha de canviar i ho intenta a cegues.

Ho pateixen sobretot les persones amb discapacitat cognitiva, les que utilitzen lector de pantalla i les persones grans. Moltes abandonen el tràmit a mitges.

Com es fa

  1. Comproveu la dada en sortir del camp o en enviar el formulari.
  2. Si hi ha un error, escriviu un missatge que anomeni el camp i digui com corregir-lo. Per exemple: «Data de naixement: utilitzeu el format dia/mes/any, com ara 05/03/1980».
  3. Poseu el missatge al costat del camp, associat amb aria-describedby, i marqueu el camp amb aria-invalid="true".
  4. Si hi ha diversos errors, mostreu a dalt un resum amb enllaços a cada camp i porteu el focus a aquest resum.
  5. Conserveu el que ja s'ha escrit, excepte les contrasenyes i altres dades de seguretat.

Exemple pràctic

Formulari de cita prèvia d'un ajuntament que comprova el DNI i el codi postal abans d'enviar. El que s'avalua és el missatge d'error. Ha de dir quin camp és erroni, per què i com corregir-lo. I ha de conservar el que ja s'ha escrit.

Així no: Missatge genèric que, a més, esborra les dades

Si el DNI o el codi postal estan malament, només apareix «Dades incorrectes.». No diu quin camp és erroni ni quin format s'espera. A més, el formulari es buida i cal tornar-ho a escriure tot. Proveu d'enviar el DNI «1234» i el codi postal «3000».

Captura de pantalla de l'exemple incorrecte: Missatge genèric que, a més, esborra les dades
Així es veu l'exemple incorrecte.

La demostració conté, a propòsit, l'error d'accessibilitat que s'explica.

Mostra el codi de l'exemple incorrecte
<form id="cita" action="#" novalidate>
  <label for="dni">DNI</label>
  <input id="dni" name="dni" autocomplete="off">
  <label for="cp">Codi postal</label>
  <input id="cp" name="cp" inputmode="numeric" autocomplete="postal-code">
  <button>Demana cita</button>
  <p id="msg"></p>
</form>
<style>label, input { display: block; } input { margin-bottom: .6em; }</style>
<script>
document.getElementById('cita').addEventListener('submit', function (e) {
  e.preventDefault();
  var ok = /^\d{8}[A-Za-z]$/.test(this.dni.value.trim()) && /^\d{5}$/.test(this.cp.value.trim());
  document.getElementById('msg').textContent = ok ? 'Cita sol·licitada.' : 'Dades incorrectes.';
  if (!ok) this.reset();
});
</script>

Així sí: Error explicat al costat del camp i en un resum amb enllaços

Cada camp amb error mostra un missatge amb el format esperat i un exemple vàlid. El missatge s'associa al camp amb aria-describedby i el camp es marca amb aria-invalid. A dalt apareix un resum amb enllaços a cada camp. El focus passa a aquest resum i les dades escrites es conserven.

Proveu-ho aquí:

Mostra el codi de l'exemple correcte
<form id="cita" action="#" novalidate>
  <div id="resumen" tabindex="-1"></div>
  <label for="dni">DNI</label>
  <input id="dni" name="dni" autocomplete="off" aria-describedby="dni-err">
  <p id="dni-err" class="err"></p>
  <label for="cp">Codi postal</label>
  <input id="cp" name="cp" inputmode="numeric" autocomplete="postal-code" aria-describedby="cp-err">
  <p id="cp-err" class="err"></p>
  <button>Demana cita</button>
</form>
<style>label, input { display: block; } .err { color: #b00020; margin: .2em 0 .6em; }</style>
<script>
var f = document.getElementById('cita'), res = document.getElementById('resumen');
var reglas = [
  ['dni', /^\d{8}[A-Za-z]$/, 'DNI: ha de tenir 8 números i una lletra, per exemple 12345678Z.'],
  ['cp', /^\d{5}$/, 'Codi postal: ha de tenir 5 xifres, per exemple 30001.']
];
f.addEventListener('submit', function (e) {
  e.preventDefault();
  var lista = '';
  reglas.forEach(function (r) {
    var ok = r[1].test(f[r[0]].value.trim());
    f[r[0]].setAttribute('aria-invalid', ok ? 'false' : 'true');
    document.getElementById(r[0] + '-err').textContent = ok ? '' : r[2];
    if (!ok) lista += '<li><a href="#' + r[0] + '">' + r[2] + '</a></li>';
  });
  res.innerHTML = lista ? '<p>Reviseu aquestes dades:</p><ul>' + lista + '</ul>' : '<p>Cita sol·licitada.</p>';
  res.focus();
});
res.addEventListener('click', function (e) {
  var a = e.target.closest('a');
  if (a) { e.preventDefault(); document.getElementById(a.getAttribute('href').slice(1)).focus(); }
});
</script>

Com comprovar-ho

Teclat

  1. Escriviu dades amb un format erroni (per exemple, DNI «1234») i envieu amb Retorn.
  2. Comproveu que apareix un text que anomena el camp i explica com corregir-lo, amb el format o un exemple.
  3. Activeu amb Retorn un enllaç del resum. El focus ha d'arribar al camp corresponent.
  4. Comproveu que les dades escrites continuen als camps, excepte les contrasenyes o altres dades de seguretat.

Lector de pantalla (NVDA o VoiceOver)

  1. Envieu el formulari amb errors. Escolteu el que s'anuncia quan el focus passa al resum.
  2. Aneu amb el tabulador fins al camp erroni. S'ha d'anunciar com a no vàlid i s'ha de llegir el missatge d'error.

Hauria d'anunciar: «DNI, edició, no vàlid, DNI: ha de tenir 8 números i una lletra, per exemple 12345678Z.»

Eines del navegador

  1. Obriu les eines de desenvolupament (F12), pestanya Accessibilitat, i seleccioneu el camp erroni.
  2. Comproveu que «Invalid» val true. La descripció accessible ha de contenir el text de l'error, que ve d'aria-describedby.

Validació automàtica

  1. axe DevTools, WAVE o Lighthouse només analitzen la pàgina tal com és en aquell moment. Provoqueu l'error abans d'executar-los.
  2. Detecten referències trencades d'aria-describedby o camps sense etiqueta. Però no valoren si el missatge anomena el camp ni si explica com corregir-lo. Això es revisa manualment.

Errors freqüents en auditories

  • Missatges genèrics com «Reviseu el formulari» o «Error 400», que no diuen quin camp és erroni ni quin format s'espera.
  • Indicar l'error només amb una vora vermella o una icona, sense text.
  • Recarregar la pàgina amb el formulari buit, de manera que cal tornar-ho a escriure tot.
  • Refiar-se només dels avisos del navegador. Desapareixen de seguida i no sempre expliquen el format correcte.
Veure el text complet del W3C (traducció al català)

Aquesta és una traducció no oficial al català de la tècnica G85 de Techniques for WCAG 2.2, del W3C. Pot contenir errors. L'únic document oficial i normatiu és la versió original en anglès, publicada al lloc web del W3C.

Aplicabilitat

Contingut que accepta la introducció de dades per part de l'usuari, amb restriccions en el format, el valor o el tipus de l'entrada.

Descripció

L'objectiu d'aquesta tècnica és oferir ajuda per corregir els errors d'entrada quan la informació facilitada per l'usuari no s'accepta. Quan els usuaris introdueixen dades que es validen i es detecten errors d'entrada, es proporciona en text informació sobre la naturalesa i la ubicació de l'error d'entrada, de manera que els usuaris puguin identificar el problema. Un enfocament consisteix a utilitzar validació al costat del client i mostrar un quadre de diàleg d'alerta que descrigui l'error immediatament, quan l'usuari introdueix dades no vàlides al camp. Un altre enfocament, amb validació al costat del servidor, consisteix a tornar a mostrar el formulari (incloses les dades introduïdes prèviament) juntament amb una descripció textual a la part superior de la pàgina que indiqui que s'ha produït un error, descrigui la naturalesa del problema i ofereixi maneres de localitzar fàcilment el camp o els camps amb problemes.

Sigui quina sigui la manera com es proporcioni la descripció textual, hauria de fer alguna de les coses següents per ajudar l'usuari:

  • Oferir exemples de l'entrada de dades correcta per al camp,
  • Descriure l'entrada de dades correcta per al camp,
  • Mostrar valors d'entrada correctes que siguin semblants als introduïts per l'usuari, amb instruccions sobre com introduir un d'aquests valors correctes si l'usuari així ho vol.

Exemples

  • L'usuari introdueix dades no vàlides en un camp de formulari. Quan l'usuari surt del camp, apareix un quadre de diàleg d'alerta que descriu la naturalesa de l'error perquè el pugui corregir.
  • L'usuari introdueix dades no vàlides en un camp de formulari i envia el formulari. El servidor retorna el formulari, amb les dades de l'usuari encara presents, i indica clarament en text, a la part superior de la pàgina, que hi ha hagut errors d'entrada. El text descriu la naturalesa de l'error o els errors i indica clarament quin camp tenia el problema, de manera que l'usuari hi pugui arribar fàcilment per solucionar-lo.
  • L'usuari introdueix dades no vàlides en un camp de formulari i intenta enviar el formulari. Un script al costat del client detecta l'error, cancel·la l'enviament i modifica el document per afegir, després del botó d'enviament, una descripció textual de l'error amb enllaços al camp o als camps erronis. L'script també modifica les etiquetes dels camps amb problemes per ressaltar-los.

Proves

Procediment

  1. Emplenar un formulari introduint deliberadament dades que no s'ajustin al format o als valors requerits
  2. Comprovar que es proporciona una descripció textual que identifica el camp erroni i ofereix informació sobre la naturalesa de l'entrada no vàlida i sobre com corregir-la.
  3. Comprovar que les altres dades introduïdes prèviament per l'usuari es tornen a mostrar, tret que es tracti d'un camp relacionat amb la seguretat en què no sigui apropiat conservar les dades per tornar-les a mostrar (p. ex., una contrasenya).

Resultats esperats

  • Les comprovacions núm. 2 i núm. 3 són certes

Com ho comprovem a ADDAW

En cada auditoria d'ADDAW revisem aquesta tècnica pàgina per pàgina i us lliurem els errors amb captures i la manera de corregir-los.

Sol·licitar una auditoria

Basat en la tècnica G85 del W3C (WCAG 2.2). Explicació i exemples: ADDAW. Traducció no oficial del text del W3C © W3C, llicència de documents del W3C. Heu vist un error? Escriviu-nos.