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

Tècnica Scripts de client WCAG 2.2

SCR32Validar formularis amb JavaScript i mostrar els errors en una llista

Nom oficial al W3C: Proporcionar validació al costat del client i afegir el text dels errors mitjançant el DOM

Versión en castellano

En poques paraules

En enviar un formulari, un script revisa els camps abans de trametre'ls. Si hi ha errors, mostra a sobre del formulari una llista de missatges que expliquen cada problema. Cada missatge és un enllaç que porta al camp afectat. A més, el focus es mou a aquesta llista perquè ningú no es perdi l'avís.

Per què és important

Si un error només es marca amb una vora vermella, moltes persones no el veuen. Qui fa servir un lector de pantalla (programa que llegeix en veu alta el que hi ha a la pantalla) tampoc no se n'assabenta si no s'anuncia res.

Per exemple, en un formulari de cita prèvia amb el DNI mal escrit, la persona prem «Demana cita» i no passa res. No sap què falla ni on. Una llista clara d'errors, amb enllaços a cada camp, ho resol.

Com es fa

  1. En enviar, comproveu amb JavaScript els camps obligatoris i els formats (data, DNI, correu...).
  2. Si hi ha errors, atureu l'enviament i inseriu una llista de missatges al principi del formulari.
  3. Escriviu cada missatge en text. Indiqueu el camp i què cal fer: «Data de naixement: utilitzeu el format dd/mm/aaaa».
  4. Convertiu cada missatge en un enllaç al seu camp, per exemple <a href="#dni">. Així s'hi arriba directament per corregir-lo.
  5. Moveu el focus al bloc d'errors perquè el lector de pantalla el llegeixi.
  6. Quan es corregeixi un camp, traieu-ne el missatge. Valideu també al servidor, perquè pot ser que l'script no s'executi.

Com comprovar-ho

  1. Envieu el formulari amb tots els camps ben emplenats. No ha d'aparèixer cap error.
  2. Envieu-lo amb un camp buit o mal escrit. Ha d'aparèixer el missatge correcte per a aquest camp.
  3. Comproveu que el focus salta a la llista d'errors i que el lector de pantalla la llegeix.
  4. Activeu un missatge i comproveu que porta al seu camp. Corregiu-lo, torneu a enviar i verifiqueu que el missatge desapareix.

Exemple

Formulari de cita prèvia que llista l'error del DNI amb un enllaç al camp i porta el focus a aquesta llista.

<form id="cita" novalidate>
  <div id="errores" tabindex="-1"></div>
  <label for="dni">DNI</label>
  <input id="dni" name="dni">
  <button>Demana cita</button>
</form>
<script>
document.getElementById('cita').addEventListener('submit', function (e) {
  if (!/^\d{8}[A-Z]$/i.test(document.getElementById('dni').value)) {
    e.preventDefault();
    var caja = document.getElementById('errores');
    caja.innerHTML = '<p>Reviseu aquestes dades:</p><ul><li><a href="#dni">DNI: escriviu 8 números i una lletra.</a></li></ul>';
    caja.focus();
  }
});
</script>
Veure el text complet del W3C (traducció al català)

Aquesta és una traducció no oficial al català de la tècnica SCR32 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

Scripts utilitzats amb HTML.

Descripció

L'objectiu d'aquesta tècnica és mostrar com presentar un missatge d'error quan falla la validació al costat del client d'un camp de formulari. S'utilitzen elements d'ancoratge per mostrar els missatges d'error en una llista que s'insereix a sobre dels camps que s'han de validar. Els elements d'ancoratge s'utilitzen als missatges d'error perquè el focus s'hi pugui situar i així atreure l'atenció de l'usuari. L'href dels elements d'ancoratge conté un enllaç intern de la pàgina que fa referència als camps en què s'han detectat errors.

En una aplicació en producció, si JavaScript està desactivat, la validació al costat del client no es produirà. Per tant, aquesta tècnica només seria suficient en situacions en què es confiï en els scripts per a la conformitat, o quan també s'utilitzin tècniques de validació al costat del servidor que detectin els errors i retornin la pàgina amb informació sobre els camps erronis.

Exemples

Llistar els errors en un bloc al principi del formulari

Aquest exemple valida tant els camps obligatoris com els camps que requereixen un format concret. Quan es detecta un error, l'script insereix al DOM una llista de missatges d'error i hi mou el focus.

Captura de pantalla que mostra els missatges d'error de diversos camps que no s'han emplenat correctament
Els missatges d'error apareixen com una llista d'enllaços a prop del principi del formulari.

HTML del formulari

<!DOCTYPE HTML>
<html lang="en">
  <head>
    <title>Form Validation</title>
    <meta charset="utf-8">
    <link href="css/validate.css" rel="stylesheet">
    <script src="scripts/validate.js">
  </head>
  <body>
    <h1>Form Validation</h1>
    <p>The following form is validated before being submitted if scripting
      is available, otherwise the form is validated on the server. All fields are
      required, except those marked optional. If errors are found in the submission,
      the form is cancelled and a list of errors is displayed
      at the top of the form.</p>
    <p>Please enter your details below.</p>
    <h2>Validating Form</h2>
    <form id="personalform">
      <div class="validationerrors"></div>
      <fieldset>
        <legend>Personal Details</legend>
          <div>
            <label for="forename">Please enter your forename</label>
            <input autocomplete="given-name" class="string"
             id="forename" name="forename" type="text" value="">
         </div>
         <div>
            <label for="age">Please enter your age</label>
            <input class="number" id="age" name="age" type="text" value="">
         </div>
         <div>
           <label for="email">Please enter your email address</label>
           <input autocomplete="email" class="email" id="email"
            name="email" type="text" value="">
         </div>
      </fieldset>
      <div>
        <input type="submit" name="signup" value="Sign up">
      </div>
    </form>
    <h2>Second Form</h2>
    <form id="secondform">
      <div class="validationerrors"></div>
      <fieldset>
        <legend>Second Form Details</legend>
          <div>
            <label for="suggestion">Enter a suggestion</label>
            <input class="string" id="suggestion" name="suggestion" type="text" value="">
          </div>
          <div>
            <label for="optemail">Please enter your email address (optional)</label>
            <input autocomplete="email" class="optional email" id="optemail"
             name="optemail" type="text" value="">
          </div>
          <div>
            <label for="rating">Please rate this suggestion</label>
            <input class="number" id="rating" name="rating" type="text" value="">
          </div>
          <div>
            <label for="jibberish">Enter some jibberish (optional)</label>
            <input id="jibberish" name="jibberish" type="text" value="">
          </div>
      </fieldset>
      <div>
        <input type="submit" name="submit" value="Add Suggestion">
      </div>
    </form>
  </body>
</html>

El codi JavaScript que fa la validació i insereix els missatges d'error

window.onload = initialise;
function initialise() {
  var objForms = document.getElementsByTagName('form');
  var iCounter;
  // Attach an event handler for each form
  for (iCounter=0; iCounter<objForms.length; iCounter++) {
    objForms[iCounter].onsubmit = function(){return validateForm(this);};
  }
}
// Event handler for the form
function validateForm(objForm) {
  var arClass = [];
  var iErrors = 0;
  var objField = objForm.getElementsByTagName('input');
  var objLabel = objForm.getElementsByTagName('label');
  var objList = document.createElement('ol');
  var objError, objExisting, objNew, objTitle, objParagraph, objAnchor, objPosition;
  var strLinkID, iFieldCounter, iClassCounter, iCounter;
  // Get the id or name of the form, to make a unique
  // fragment identifier
  if (objForm.id) {
    strLinkID = objForm.id + 'ErrorID';
  }
  else {
    strLinkID = objForm.name + 'ErrorID';
  }
  // Iterate through input form controls, looking for validation classes
  for (iFieldCounter=0; iFieldCounter<objField.length; iFieldCounter++) {
  // Get the class for the field, and look for the appropriate class
  arClass = objField[iFieldCounter].className.split(' ');
  for (iClassCounter=0; iClassCounter<arClass.length; iClassCounter++) {
    switch (arClass[iClassCounter]) {
      case 'string':
        if (!isString(objField[iFieldCounter].value, arClass)) {
          if (iErrors === 0) {
            logError(objField[iFieldCounter], objLabel, objList, strLinkID);
          }
          else {
            logError(objField[iFieldCounter], objLabel, objList, '');
          }
          iErrors++;
        }
      break;
      case 'number':
        if (!isNumber(objField[iFieldCounter].value, arClass)) {
          if (iErrors === 0) {
            logError(objField[iFieldCounter], objLabel, objList, strLinkID);
          }
          else {
            logError(objField[iFieldCounter], objLabel, objList, '');
          }
          iErrors++;
        }
      break;
      case 'email' :
        if (!isEmail(objField[iFieldCounter].value, arClass)) {
          if (iErrors === 0) {
            logError(objField[iFieldCounter], objLabel, objList, strLinkID);
          }
          else {
            logError(objField[iFieldCounter], objLabel, objList, '');
          }
          iErrors++;
        }
        break;
      }
    }
  }
  if (iErrors > 0) {
    // If not valid, display error messages
    objError = objForm.getElementsByTagName('div');
    // Look for existing errors
    for (iCounter=0; iCounter<objError.length; iCounter++) {
      if (objError[iCounter].className == 'validationerrors') {
        objExisting = objError[iCounter];
      }
    }
    objNew = document.createElement('div');
    objTitle = document.createElement('h2');
    objParagraph = document.createElement('p');
    objAnchor = document.createElement('a');
    if (iErrors == 1) {
      objAnchor.appendChild(document.createTextNode('1 Error in Submission'));
    }
    else {
      objAnchor.appendChild(document.createTextNode(iErrors + ' Errors in Submission'));
    }
    objAnchor.href = '#' + strLinkID;
    objAnchor.className = 'submissionerror';
    objTitle.appendChild(objAnchor);
    objParagraph.appendChild(document.createTextNode('Please review the following'));
    objNew.className = 'validationerrors';
    objNew.appendChild(objTitle);
    objNew.appendChild(objParagraph);
    objNew.appendChild(objList);
    // If there were existing error, replace them with the new lot,
    // otherwise add the new errors to the start of the form
    if (objExisting) {
      objExisting.parentNode.replaceChild(objNew, objExisting);
    }
    else {
      objPosition = objForm.firstChild;
      objForm.insertBefore(objNew, objPosition);
    }
    // Allow for latency
    setTimeout(function() { objAnchor.focus(); }, 50);
    // Don't submit the form
    objForm.submitAllowed = false;
    return false;
  }
  // Submit the form
  return true;
	}
  // Function to add a link in a list item that points to problematic field control
  function addError(objList, strError, strID, strErrorID) {
		var objListItem = document.createElement('li');
    var objAnchor = document.createElement('a');
    // Fragment identifier to the form control
    objAnchor.href='#' + strID;
    // Make this the target for the error heading
    if (strErrorID.length > 0) {
      objAnchor.id = strErrorID;
    }
    // Use the label prompt for the error message
    objAnchor.appendChild(document.createTextNode(strError));
    // Add keyboard and mouse events to set focus to the form control
    objAnchor.onclick = function(event){return focusFormField(this, event);};
    objAnchor.onkeypress = function(event){return focusFormField(this, event);};
    objListItem.appendChild(objAnchor);
    objList.appendChild(objListItem);
  }
  function focusFormField(objAnchor, objEvent) {
    var strFormField, objForm;
    // Allow keyboard navigation over links
    if (objEvent && objEvent.type == 'keypress') {
      if (objEvent.keyCode != 13 && objEvent.keyCode != 32) {
        return true;
      }
    }
    // set focus to the form control
    strFormField = objAnchor.href.match(/[^#]\w*$/);
    objForm = getForm(strFormField);
    objForm[strFormField].focus();
    return false;
  }
    // Function to return the form element from a given form field name
    function getForm(strField) {
      var objElement = document.getElementById(strField);
    // Find the appropriate form
    do {
      objElement = objElement.parentNode;
    } while (!objElement.tagName.match(/form/i) && objElement.parentNode);
    return objElement;
  }
  // Function to log the error in a list
  function logError(objField, objLabel, objList, strErrorID) {
    var iCounter, strError;
    // Search the label for the error prompt
    for (iCounter=0; iCounter<objLabel.length; iCounter++) {
      if (objLabel[iCounter].htmlFor == objField.id) {
        strError = objLabel[iCounter].firstChild.nodeValue;
      }
    }
    addError(objList, strError, objField.id, strErrorID);
  }
  // Validation routines - add as required
  function isString(strValue, arClass) {
    var bValid = (typeof strValue == 'string' && strValue.replace(/^\s*|\s*$/g, '') 
    !== '' && isNaN(strValue));
    return checkOptional(bValid, strValue, arClass);
  }
  function isEmail(strValue, arClass) {
    var objRE = /^[\w-\.\']{1,}\@([\da-zA-Z\-]{1,}\.){1,}[\da-zA-Z\-]{2,}$/;
    var bValid = objRE.test(strValue);
    return checkOptional(bValid, strValue, arClass);
  }
  function isNumber(strValue, arClass) {
    var bValid = (!isNaN(strValue) && strValue.replace(/^\s*|\s*$/g, '') !== '');
    return checkOptional(bValid, strValue, arClass);
  }
  function checkOptional(bValid, strValue, arClass) {
    var bOptional = false;
    var iCounter;
    // Check if optional
    for (iCounter=0; iCounter<arClass.length; iCounter++) {
      if (arClass[iCounter] == 'optional') {
        bOptional = true;
      }
    }
    if (bOptional && strValue.replace(/^\s*|\s*$/g, '') === '') {
      return true;
    }
    return bValid;
  }

Exemple funcional d'aquesta tècnica implementat amb PHP, JavaScript, CSS i HTML: Form Validation Example (exemple de validació de formularis).

Proves

Procediment

Crear els missatges d'error amb etiquetes d'ancoratge i els scripts adequats segons la tècnica anterior.

  1. Carregar la pàgina.
  2. Introduir un valor vàlid als camps associats a un missatge d'error i comprovar que no es mostra cap missatge d'error.
  3. Introduir un valor no vàlid als camps associats a un missatge d'error i comprovar que es mostra el missatge d'error correcte per al camp.
  4. Comprovar que els missatges d'error reben el focus.
  5. Introduir un valor vàlid als camps associats al missatge d'error mostrat i comprovar que el missatge d'error desapareix.
  6. Repetir el procés amb tots els camps que tinguin associats missatges d'error creats amb etiquetes d'ancoratge.

Es recomana repetir també el procediment anterior utilitzant una tecnologia de suport.

Resultats esperats

  • Les comprovacions núm. 2, núm. 3, núm. 4 i núm. 5 són totes 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 SCR32 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.