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

Tècnica Scripts de client WCAG 2.2 obsoleta

SCR21Afegir contingut a la pàgina amb les funcions del DOM (tècnica obsoleta)

Nom oficial al W3C: Utilitzar funcions del Document Object Model (DOM) per afegir contingut a una pàgina

Versión en castellano

Tècnica obsoleta: el W3C ja no la recomana. |

En poques paraules

Tècnica obsoleta. Recomanava crear el contingut nou amb funcions del DOM, com ara createElement, en lloc de document.write o innerHTML. Avui els navegadors exposen igual el contingut afegit per qualsevol via. El que importa és que el contingut nou tingui una bona estructura i que la persona s'adoni que ha aparegut.

Per què és important

El W3C la considera obsoleta i ja no l'associa a cap criteri de les WCAG actuals. Quan es va escriure, alguns navegadors i lectors de pantalla no detectaven el contingut creat amb innerHTML o document.write.

Aquest problema ja no existeix. Tanmateix, continua sent habitual que el contingut afegit amb JavaScript passi desapercebut. Per exemple, un missatge d'error que apareix en una altra part de la pàgina.

Com es fa

  1. Podeu utilitzar el mètode que preferiu per afegir contingut: createElement, innerHTML o un framework.
  2. Utilitzeu HTML amb significat: encapçalaments, llistes, enllaços i botons reals.
  3. Afegiu el contingut nou en un lloc lògic de l'ordre de lectura, normalment a prop del que el provoca.
  4. Si el canvi és important, aviseu-ne: porteu el focus al contingut nou o utilitzeu una regió viva (zona els canvis de la qual llegeix el lector de pantalla).
  5. No poseu tabindex positius als elements nous. Deixeu l'ordre de tabulació natural.
  6. Eviteu document.write, però per motius de rendiment, no d'accessibilitat.

Com comprovar-ho

  1. Feu que aparegui contingut nou, com un missatge d'error o un tauler desplegable.
  2. Amb un lector de pantalla, comproveu que el contingut s'anuncia o que s'hi arriba de manera lògica.
  3. Inspeccioneu el codi amb F12 i verifiqueu que utilitza elements HTML amb significat i sense tabindex positius.
Veure el text complet del W3C (traducció al català)

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

ECMAScript utilitzat dins d'HTML

Descripció

L'objectiu d'aquesta tècnica és demostrar com utilitzar funcions del Document Object Model (DOM) per afegir contingut a una pàgina. Si s'utilitzen les funcions del DOM per afegir el contingut, els agents d'usuari poden accedir al DOM per recuperar-lo. La funció createElement() es pot utilitzar per crear elements dins del DOM. La funció createTextNode() s'utilitza per crear el text associat als elements. Les funcions appendChild(), removeChild(), insertBefore() i replaceChild() s'utilitzen per afegir i eliminar elements i nodes. Altres funcions del DOM s'utilitzen per assignar atributs als elements creats.

En afegir al document elements que poden rebre el focus, no hi afegiu atributs tabindex per fixar explícitament l'ordre de tabulació, ja que això pot causar problemes en inserir elements que reben el focus al mig d'un document. Deixeu que al nou element se li assigni l'ordre de tabulació predeterminat, sense establir explícitament un atribut tabindex.

Exemples

Aquest exemple demostra l'ús d'scripts al costat del client per validar un formulari. Si es troben errors, es mostren els missatges d'error corresponents. L'exemple utilitza les funcions del DOM per afegir una notificació d'error composta per un títol, un paràgraf breu que explica que s'ha produït un error i una llista d'errors en forma de llista ordenada. El contingut del títol s'escriu com un enllaç, per poder-lo utilitzar amb el mètode focus i cridar així l'atenció de l'usuari sobre l'error. Cada element de la llista també s'escriu com un enllaç que, quan se segueix, situa el focus al camp de formulari amb error.

Per simplicitat, l'exemple només valida dos camps de text, però es pot ampliar fàcilment per convertir-lo en un gestor genèric de formularis. La validació al costat del client no ha de ser l'únic mitjà de validació, i s'ha de reforçar amb una validació al costat del servidor. L'avantatge de la validació al costat del client és que permet oferir a l'usuari una resposta immediata, de manera que no ha d'esperar que els errors tornin del servidor, i ajuda a reduir el trànsit innecessari cap al servidor.

Aquest és l'script que afegeix els gestors d'esdeveniments al formulari. Si els scripts estan activats, es cridarà la funció validateNumbers() per dur a terme la validació al costat del client abans d'enviar el formulari al servidor. Si els scripts no estan activats, el formulari s'enviarà immediatament al servidor, per la qual cosa la validació també s'ha d'implementar al servidor.

window.onload = initialise;
function initialise() {
  // Add an event handler for the number form
  var objForm = document.getElementById('numberform');
  objForm.onsubmit= function(){return validateNumbers(this);};
}

Aquesta és la funció de validació. Observeu l'ús de les funcions del DOM createElement(), createTextNode() i appendChild() per crear els elements del missatge d'error.

function validateNumbers(objForm) {
  // Test whether fields are valid
  var bFirst = isNumber(document.getElementById('num1').value);
  var bSecond = isNumber(document.getElementById('num2').value);
  // If not valid, display errors
  if (!bFirst || !bSecond) {
    var objExisting = document.getElementById('validationerrors');
    var objNew = document.createElement('div');
    var objTitle = document.createElement('h2');
    var objParagraph = document.createElement('p');
    var objList = document.createElement('ol');
    var objAnchor = document.createElement('a');
    var strID = 'firsterror';
    var strError;
    // The heading element will contain a link so that screen readers
    // can use it to place focus - the destination for the link is 
    // the first error contained in a list
    objAnchor.appendChild(document.createTextNode('Errors in Submission'));
    objAnchor.setAttribute('href', '#firsterror');
    objTitle.appendChild(objAnchor);
    objParagraph.appendChild(document.createTextNode('Please review the following'));
    objNew.setAttribute('id', 'validationerrors');
    objNew.appendChild(objTitle);
    objNew.appendChild(objParagraph);
    // Add each error found to the list of errors
    if (!bFirst) {
      strError = 'Please provide a numeric value for the first number';
      objList.appendChild(addError(strError, '#num1', objForm, strID));
      strID = '';
    }
    if (!bSecond) {
      strError = 'Please provide a numeric value for the second number';
      objList.appendChild(addError(strError, '#num2', objForm, strID));
      strID = '';
    }
    // Add the list to the error information
    objNew.appendChild(objList);
    // If there were existing errors, 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 {
      var objPosition = objForm.firstChild;
      objForm.insertBefore(objNew, objPosition);
    }
    // Place focus on the anchor in the heading to alert
    // screen readers that the submission is in error
    objAnchor.focus();
    // Do not submit the form
    objForm.submitAllowed = false;
    return false;
  }
  return true;
}
// Function to validate a number
function isNumber(strValue) {
  return (!isNaN(strValue) && strValue.replace(/^\s+|\s+$/, '') !== '');
}

A continuació figuren les funcions auxiliars per crear el missatge d'error i per situar el focus al camp de formulari associat.

// Function to create a list item containing a link describing the error
// that points to the appropriate form field
function addError(strError, strFragment, objForm, strID) {
  var objAnchor = document.createElement('a');
  var objListItem = document.createElement('li');
  objAnchor.appendChild(document.createTextNode(strError));
  objAnchor.setAttribute('href', strFragment);
  objAnchor.onclick = function(event){return focusFormField(this, event, objForm);};
  objAnchor.onkeypress = function(event){return focusFormField(this, event, objForm);};
  // If strID has a value, this is the first error in the list
  if (strID.length > 0){
    objAnchor.setAttribute('id', strID);
  }
  objListItem.appendChild(objAnchor);
  return objListItem;
}
// Function to place focus to the form field in error
function focusFormField(objAnchor, objEvent, 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
  var strFormField = objAnchor.href.match(/[^#]\w*$/);
  objForm[strFormField].focus();
  return false;
}

Aquest és l'HTML del formulari d'exemple.

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>ECMAScript Form Validation</title>
  <script src="validate.js"></script>
</head>
<body>
  <h1>Form Validation</h1>
  <form id="numberform">
    <fieldset>
      <legend>Numeric Fields</legend>
      <div>
        <label for="num1">Enter first number</label>
        <input type="text" size="20" name="num1" id="num1">
      </div>
      <div>
        <label for="num2">Enter second number</label>
        <input type="text" size="20" name="num2" id="num2">
      </div>
    </fieldset>
    <div>
      <input type="submit" name="submit" value="Submit Form">
    </div>
  </form>
</body>
</html>

Aquest exemple es limita als scripts al costat del client i s'ha de reforçar amb una validació al costat del servidor. L'exemple es limita a la creació de missatges d'error quan els scripts al costat del client estan disponibles.

Aquí hi ha un enllaç a un exemple pràctic: Form Validation (validació de formulari)

Proves

Procediment

Per a les pàgines que creen contingut nou de manera dinàmica:

  1. Examinar el codi font i comprovar que el contingut nou no es crea mitjançant document.write(), innerHTML, outerHTML, innerText ni outerText.

Resultats esperats

  • La comprovació núm. 1 és certa.

Recursos

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 SCR21 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.