Addaw, joan hasierara Egin dohaintza

Teknika Bezero-scriptak WCAG 2.2 zaharkitua

SCR21Orriari edukia DOMaren funtzioekin gehitzea (teknika zaharkitua)

Izen ofiziala W3Cn: Document Object Model (DOM) funtzioak erabiltzea orri bati edukia gehitzeko

Versión en castellano · Versió en català

Teknika zaharkitua: W3Ck ez du gehiago gomendatzen. |

Laburbilduz

Teknika zaharkitua. Eduki berria DOMaren funtzioekin sortzea gomendatzen zuen, createElement, adibidez, document.write edo innerHTML erabili beharrean. Gaur egun, nabigatzaileek berdin erakusten dute edozein bidetatik gehitutako edukia. Garrantzitsuena da eduki berriak egitura ona izatea eta pertsona agertu dela jabetzea.

Zergatik da garrantzitsua

W3Ck zaharkitutzat jotzen du, eta jada ez du egungo WCAGen inongo irizpiderekin lotzen. Idatzi zenean, nabigatzaile eta pantaila-irakurgailu batzuek ez zuten hautematen innerHTML edo document.write bidez sortutako edukia.

Arazo hori jada ez dago. Hala ere, ohikoa izaten jarraitzen du JavaScript bidez gehitutako edukia oharkabean pasatzeak. Adibidez, orriaren beste leku batean agertzen den errore-mezu bat.

Nola egiten da

  1. Edukia gehitzeko nahiago duzun metodoa erabil dezakezu: createElement, innerHTML edo framework bat.
  2. Erabili esanahia duen HTMLa: benetako izenburuak, zerrendak, estekak eta botoiak.
  3. Gehitu eduki berria irakurketa-ordenako leku logiko batean, normalean hura eragiten duenaren ondoan.
  4. Aldaketa garrantzitsua bada, abisatu: eraman fokua eduki berrira edo erabili eskualde bizi bat (pantaila-irakurgailuak bertako aldaketak irakurtzen dituen gunea).
  5. Ez jarri tabindex positiborik elementu berrietan. Utzi tabulazio-ordena naturala.
  6. Saihestu document.write, baina errendimenduagatik, ez irisgarritasunagatik.

Nola egiaztatu

  1. Eragin eduki berria agertzea, errore-mezu bat edo panel zabalgarri bat, adibidez.
  2. Pantaila-irakurgailu batekin, egiaztatu edukia iragartzen dela edo hara modu logikoan iristen dela.
  3. Ikuskatu kodea F12 teklarekin eta egiaztatu esanahia duten HTML elementuak erabiltzen dituela eta tabindex positiborik gabe.
Ikusi W3Cren testu osoa (euskarazko itzulpena)

W3Cren Techniques for WCAG 2.2 dokumentuko SCR21 teknikaren euskarazko itzulpen ez-ofiziala da hau. Akatsak izan ditzake. Dokumentu ofizial eta arauemaile bakarra jatorrizko bertsioa da, ingelesez, W3Cren webgunean argitaratua.

Aplikagarritasuna

HTMLaren barruan erabilitako ECMAScript

Deskribapena

Teknika honen helburua da erakustea nola erabili Document Object Model (DOM) funtzioak orri bati edukia gehitzeko. Edukia gehitzeko DOMaren funtzioak erabiltzen badira, erabiltzaile-agenteek DOMera sar daitezke hura berreskuratzeko. createElement() funtzioa DOMaren barruan elementuak sortzeko erabil daiteke. createTextNode() funtzioa elementuei lotutako testua sortzeko erabiltzen da. appendChild(), removeChild(), insertBefore() eta replaceChild() funtzioak elementuak eta nodoak gehitzeko eta ezabatzeko erabiltzen dira. DOMaren beste funtzio batzuk sortutako elementuei atributuak esleitzeko erabiltzen dira.

Dokumentuan fokua jaso dezaketen elementuak gehitzean, ez gehitu tabindex atributurik tabulazio-ordena esplizituki finkatzeko; izan ere, horrek arazoak eragin ditzake fokua jasotzen duten elementuak dokumentu baten erdian txertatzean. Utzi elementu berriari lehenetsitako tabulazio-ordena esleitzen, tabindex atributurik esplizituki ezarri gabe.

Adibideak

Adibide honek erakusten du nola erabiltzen diren bezeroaren aldeko scriptak formulario bat balidatzeko. Erroreak aurkitzen badira, dagozkien errore-mezuak erakusten dira. Adibideak DOMaren funtzioak erabiltzen ditu errore-jakinarazpen bat gehitzeko, honako hauek osatua: izenburu bat, errore bat gertatu dela azaltzen duen paragrafo labur bat eta erroreen zerrenda bat, zerrenda ordenatu baten moduan. Izenburuaren edukia esteka gisa idazten da, focus metodoarekin erabili ahal izateko eta, horrela, erabiltzailearen arreta errorera erakartzeko. Zerrendako elementu bakoitza ere esteka gisa idazten da, eta esteka hori jarraitzean, fokua errorea duen formulario-eremuan jartzen da.

Sinpletasunagatik, adibideak bi testu-eremu soilik balidatzen ditu, baina erraz zabal daiteke formularioen kudeatzaile generiko bihurtzeko. Bezeroaren aldeko balidazioak ez du balidazio-bide bakarra izan behar, eta zerbitzariaren aldeko balidazio batek babestu behar du. Bezeroaren aldeko balidazioaren abantaila da erabiltzaileari berehalako erantzuna emateko aukera ematen duela, erroreak zerbitzaritik itzuli arte itxaron beharrik gabe, eta zerbitzarirako alferrikako trafikoa murrizten laguntzen duela.

Hau da formularioari gertaera-kudeatzaileak gehitzen dizkion scripta. Scriptak aktibatuta badaude, validateNumbers() funtzioari deituko zaio bezeroaren aldeko balidazioa egiteko, formularioa zerbitzarira bidali aurretik. Scriptak aktibatuta ez badaude, formularioa berehala bidaliko da zerbitzarira; beraz, balidazioa zerbitzarian ere inplementatu behar da.

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

Hau da balidazio-funtzioa. Ikus nola erabiltzen diren DOMaren createElement(), createTextNode() eta appendChild() funtzioak errore-mezuaren elementuak sortzeko.

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+$/, '') !== '');
}

Jarraian daude errore-mezua sortzeko eta fokua lotutako formulario-eremuan jartzeko funtzio laguntzaileak.

// 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;
}

Hau da adibideko formularioaren HTMLa.

<!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>

Adibide hau bezeroaren aldeko scriptetara mugatzen da, eta zerbitzariaren aldeko balidazio batek babestu behar du. Adibidea bezeroaren aldeko scriptak eskuragarri daudenean errore-mezuak sortzera mugatzen da.

Hona hemen adibide praktiko baterako esteka bat: Form Validation (formularioaren balidazioa)

Probak

Prozedura

Eduki berria modu dinamikoan sortzen duten orrietarako:

  1. Aztertu iturburu-kodea eta egiaztatu eduki berria ez dela sortzen document.write(), innerHTML, outerHTML, innerText edo outerText bidez.

Espero diren emaitzak

  • 1. egiaztapena egiazkoa da.

Baliabideak

Nola egiaztatzen dugun ADDAWn

ADDAWren auditoria bakoitzean teknika hau orriz orri berrikusten dugu, eta akatsak pantaila-argazkiekin eta zuzentzeko moduarekin ematen dizkizugu.

Eskatu auditoria bat

W3Cren SCR21 teknikan oinarritua (WCAG 2.2). Azalpena eta adibideak: ADDAW. W3Cren testuaren itzulpen ez-ofiziala © W3C, W3Cren dokumentu-lizentzia. Akatsen bat ikusi duzu? Idatzi iezaguzu.