Teknika Bezero-scriptak WCAG 2.2
SCR32Formularioak JavaScript bidez balidatzea eta erroreak zerrenda batean erakustea
Izen ofiziala W3Cn: Bezeroaren aldeko balidazioa ematea eta erroreen testua DOMaren bidez gehitzea
Laburbilduz
Formulario bat bidaltzean, script batek eremuak berrikusten ditu bidali aurretik. Erroreak badaude, formularioaren gainean mezu-zerrenda bat erakusten du, arazo bakoitza azaltzen duena. Mezu bakoitza eraginpeko eremura daraman esteka bat da. Gainera, fokua zerrenda horretara mugitzen da, inork abisua gal ez dezan.
Zergatik da garrantzitsua
Errore bat ertz gorri batekin soilik markatzen bada, pertsona askok ez dute ikusten. Pantaila-irakurgailua (pantailan dagoena ozen irakurtzen duen programa) erabiltzen duenak ere ez du jakingo, ezer iragartzen ez bada.
Adibidez, aurretiazko hitzordua eskatzeko formulario batean NANa gaizki idatzita badago, pertsonak «Eskatu hitzordua» sakatzen du eta ez da ezer gertatzen. Ez daki zer dagoen gaizki, ezta non ere. Erroreen zerrenda argi batek, eremu bakoitzerako estekekin, konpontzen du hori.
Nola egiten da
- Bidaltzean, egiaztatu JavaScript bidez derrigorrezko eremuak eta formatuak (data, NANa, posta elektronikoa...).
- Erroreak badaude, gelditu bidalketa eta txertatu mezu-zerrenda bat formularioaren hasieran.
- Idatzi mezu bakoitza testu bidez. Adierazi eremua eta zer egin behar den: «Jaiotze-data: erabili ee/hh/uuuu formatua».
- Bihurtu mezu bakoitza bere eremurako esteka,
<a href="#dni">, adibidez. Horrela, zuzenean iristen da zuzentzeko lekura. - Mugitu fokua erroreen blokera, pantaila-irakurgailuak irakur dezan.
- Eremu bat zuzentzen denean, kendu haren mezua. Balidatu zerbitzarian ere, scripta agian ez delako exekutatuko.
Nola egiaztatu
- Bidali formularioa eremu guztiak ondo beteta. Ez du errorerik agertu behar.
- Bidali eremu bat hutsik edo gaizki idatzita. Eremu horretarako mezu zuzenak agertu behar du.
- Egiaztatu fokua erroreen zerrendara jauzi egiten duela eta pantaila-irakurgailuak irakurtzen duela.
- Aktibatu mezu bat eta egiaztatu bere eremura eramaten duela. Zuzendu, bidali berriro eta egiaztatu mezua desagertzen dela.
Adibidea
Aurretiazko hitzordua eskatzeko formulario bat, NANaren errorea eremurako esteka batekin zerrendatzen duena eta fokua zerrenda horretara eramaten duena.
<form id="cita" novalidate>
<div id="errores" tabindex="-1"></div>
<label for="dni">NANa</label>
<input id="dni" name="dni">
<button>Eskatu hitzordua</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>Berrikusi datu hauek:</p><ul><li><a href="#dni">NANa: idatzi 8 zenbaki eta letra bat.</a></li></ul>';
caja.focus();
}
});
</script>
Ikusi W3Cren testu osoa (euskarazko itzulpena)
W3Cren Techniques for WCAG 2.2 dokumentuko SCR32 teknikaren euskarazko itzulpen ez-ofiziala da hau. Akatsak izan ditzake. Dokumentu ofizial eta arauemaile bakarra jatorrizko bertsioa da, ingelesez, W3Cren webgunean argitaratua.
Aplikagarritasuna
HTMLrekin erabiltzen diren scriptak.
Deskribapena
Teknika honen helburua da erakustea nola aurkeztu errore-mezu bat formulario-eremu baten bezeroaren aldeko balidazioak huts egiten duenean. Aingura-elementuak erabiltzen dira errore-mezuak zerrenda batean erakusteko, eta zerrenda hori balidatu beharreko eremuen gainean txertatzen da. Errore-mezuetan aingura-elementuak erabiltzen dira, fokua haietan jarri ahal izateko eta, horrela, erabiltzailearen arreta erakartzeko. Aingura-elementuen hrefak orri barneko esteka bat dauka, erroreak detektatu diren eremuei erreferentzia egiten diena.
Ekoizpenean dagoen aplikazio batean, JavaScript desaktibatuta badago, bezeroaren aldeko balidazioa ez da gertatuko. Beraz, teknika hau nahikoa izango litzateke betetzeko scriptetan konfiantza izan daitekeen egoeretan soilik, edo zerbitzariaren aldeko balidazio-teknikak ere erabiltzen direnean, erroreak detektatu eta orria eremu okerrei buruzko informazioarekin itzultzen dutenak.
Adibideak
Erroreak formularioaren hasierako bloke batean zerrendatzea
Adibide honek derrigorrezko eremuak eta formatu jakin bat eskatzen duten eremuak balidatzen ditu. Errore bat detektatzen denean, scriptak errore-mezuen zerrenda bat txertatzen du DOMean eta fokua haietara mugitzen du.
Formularioaren HTMLa
<!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>
Balidazioa egiten duen eta errore-mezuak txertatzen dituen JavaScript kodea
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;
}
Teknika honen adibide funtzionala, PHP, JavaScript, CSS eta HTML bidez inplementatua: Form Validation Example (formularioak balidatzeko adibidea).
Probak
Prozedura
Errore-mezuak aingura-etiketekin eta script egokiekin sortzea, aurreko teknikaren arabera.
- Orria kargatzea.
- Errore-mezu bati lotutako eremuetan balio baliodun bat sartzea eta egiaztatzea ez dela errore-mezurik erakusten.
- Errore-mezu bati lotutako eremuetan balio baliogabe bat sartzea eta egiaztatzea eremurako errore-mezu zuzena erakusten dela.
- Egiaztatzea errore-mezuek fokua jasotzen dutela.
- Erakutsitako errore-mezuari lotutako eremuetan balio baliodun bat sartzea eta egiaztatzea errore-mezua desagertzen dela.
- Prozesua errepikatzea aingura-etiketekin sortutako errore-mezuak lotuta dituzten eremu guztiekin.
Gomendagarria da aurreko prozedura laguntza-teknologia bat erabiliz ere errepikatzea.
Espero diren emaitzak
- 2., 3., 4. eta 5. egiaztapenak egiazkoak dira guztiak.
Nola egiaztatzen dugun ADDAWn
ADDAWren auditoria bakoitzean teknika hau orriz orri berrikusten dugu, eta akatsak pantaila-argazkiekin eta zuzentzeko moduarekin ematen dizkizugu.
W3Cren SCR32 teknikan oinarritua (WCAG 2.2). Azalpena eta adibideak: ADDAW. W3Cren testuaren itzulpen ez-ofiziala © W3C, W3Cren dokumentu-lizentzia. Akatsen bat ikusi duzu? Idatzi iezaguzu.