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

Tècnica ARIA WCAG 2.2

ARIA16Donar nom als controls amb aria-labelledby

Nom oficial al W3C: Utilitzar aria-labelledby per proporcionar un nom als controls d'interfície d'usuari

Versión en castellano

En poques paraules

De vegades un camp o un control no té etiqueta pròpia, però a prop hi ha un text visible que explica per a què serveix. Amb aria-labelledby es fa servir aquest text com a nom del control. També es poden ajuntar diversos textos de la pàgina per formar un nom complet.

Per què és important

Qui veu la pàgina endevina per a què serveix un camp pel que té al voltant. Un lector de pantalla (programa que llegeix en veu alta la pantalla) no pot: necessita que el camp tingui un nom propi.

Sense nom, la persona sent «camp de text» i no sap què ha d'escriure. Amb aria-labelledby, sent el mateix text que veuen els altres.

Com es fa

  1. Sempre que pugueu, utilitzeu <label>: en prémer l'etiqueta, el focus va al camp. Amb aria-labelledby això no passa.
  2. Utilitzeu aria-labelledby quan no hi hagi lloc per a una etiqueta o quan el nom surti d'un text que ja existeix: un títol, el text d'un botó, una cel·la de taula.
  3. Doneu un id únic al text que farà de nom.
  4. Afegiu al control aria-labelledby amb aquest id. Si són diversos textos, poseu els id separats per espais, en l'ordre en què s'han de llegir.
  5. Tingueu en compte que aria-labelledby té prioritat sobre <label> i aria-label. Si els combineu, només es llegeix el seu.

Exemple pràctic

Cercador de la capçalera del web d'un ajuntament. Per disseny, no té etiqueta visible. L'únic text que explica el camp és el del botó «Cerca», que és al costat.

Així no: Camp de cerca sense nom

A la vista s'entén gràcies al botó. Però el camp no té etiqueta ni nom per al lector de pantalla. Només se sent «edició» o «camp de text», sense dir per a què serveix. Per notar-ho, activeu NVDA o VoiceOver i arribeu al camp amb el tabulador.

Captura de pantalla de l'exemple incorrecte: Camp de cerca sense nom
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 role="search" action="#" class="buscador">
  <input type="search" id="q" name="q">
  <button type="submit" id="btn-buscar">Cerca</button>
</form>
<style>
  .buscador { display: flex; gap: .5em; }
  .buscador input { flex: 1; padding: .4em; border: 1px solid #555; }
  .buscador button { background: #744E9A; color: #fff; border: 0; padding: .4em 1em; }
  .buscador :focus-visible { outline: 3px solid #0B2239; outline-offset: 2px; }
</style>

Així sí: Camp que pren el nom del botó amb aria-labelledby

S'afegeix aria-labelledby="btn-buscar" al camp. El seu nom passa a ser el text del botó: «Cerca». No cal repetir text a la pantalla. A més, el nom coincideix amb el que es veu (criteri 2.5.3).

Proveu-ho aquí:

Mostra el codi de l'exemple correcte
<form role="search" action="#" class="buscador">
  <input type="search" id="q" name="q" aria-labelledby="btn-buscar">
  <button type="submit" id="btn-buscar">Cerca</button>
</form>
<style>
  .buscador { display: flex; gap: .5em; }
  .buscador input { flex: 1; padding: .4em; border: 1px solid #555; }
  .buscador button { background: #744E9A; color: #fff; border: 0; padding: .4em 1em; }
  .buscador :focus-visible { outline: 3px solid #0B2239; outline-offset: 2px; }
</style>

Com comprovar-ho

Lector de pantalla (NVDA o VoiceOver)

  1. Arribar al camp de cerca amb el tabulador i escoltar com s'anuncia.
  2. Comprovar que el nom anunciat coincideix amb el text visible a què apunta.

Hauria d'anunciar: «Cerca, camp de cerca» (VoiceOver) o «Cerca, edició» (NVDA)

Eines del navegador

  1. Obrir les eines de desenvolupament (F12) i triar la pestanya Accessibilitat.
  2. Seleccionar el camp i comprovar que el seu nom («Name») és «Cerca» i que ve d'aria-labelledby.
  3. Verificar que cada id d'aria-labelledby existeix a la pàgina i no està repetit.

Teclat

  1. Recórrer el cercador amb Tab. El camp i el botó han de rebre el focus amb un indicador visible.
  2. Tenir en compte que, a diferència de label, prémer el text a què apunta aria-labelledby no porta el focus al camp.

Validació automàtica

  1. axe DevTools detecta el camp sense nom de l'exemple incorrecte (regla label). WAVE el marca com a «Missing form label».
  2. No detecten si el text triat descriu bé el control. Un aria-labelledby que apunta al text equivocat passa la revisió automàtica.

Errors freqüents en auditories

  • Apuntar a un id que no existeix o està repetit. El control es queda sense nom o amb un nom equivocat.
  • Utilitzar aria-labelledby en un div o span sense funció. Allà no es permet donar nom i els lectors de pantalla l'ignoren.
  • Apuntar a un text diferent del que es veu al costat del control. Així s'incompleix el criteri 2.5.3 (Etiqueta en el nom).
  • Combinar aria-labelledby amb un label visible diferent. aria-labelledby té prioritat i substitueix el label.
Veure el text complet del W3C (traducció al català)

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

Tecnologies que admeten Accessible Rich Internet Applications (WAI-ARIA).

Descripció

El propòsit d'aquesta tècnica és proporcionar noms per als controls d'interfície d'usuari que puguin ser llegits per les tecnologies de suport. WAI-ARIA ofereix una manera d'associar un text a una secció, un dibuix, un element de formulari, una fotografia, etc., mitjançant la propietat aria-labelledby. Aquesta tècnica utilitza l'atribut aria-labelledby per associar un control d'interfície d'usuari, com ara un camp de formulari, amb un text de la pàgina que l'etiqueta.

Igual que aria-describedby, aria-labelledby pot acceptar diversos id per apuntar a altres elements de la pàgina mitjançant una llista separada per espais. Aquesta capacitat fa que aria-labelledby sigui especialment útil en situacions en què les persones que hi veuen utilitzen informació del context circumdant per identificar un control. Utilitzar aria-labelledby per concatenar una etiqueta a partir de diversos nodes de text conté més exemples de situacions en què els noms es creen a partir de diversos altres elements de text de la pàgina.

Encara que la funció d'aria-labelledby sembla similar a la de l'element label natiu d'HTML, hi ha algunes diferències:

  • aria-labelledby pot fer referència a més d'un element de text; label només pot fer referència a un.
  • aria-labelledby es pot utilitzar en una gran varietat d'elements, mentre que l'element label només es pot utilitzar en elements de formulari.
  • En fer clic en un label, el camp de formulari associat rep el focus. Això no passa amb aria-labelledby. Si cal aquest comportament, utilitzeu label o implementeu aquesta funcionalitat mitjançant scripts.

Exemples

Etiquetar un camp de text senzill

El següent és un exemple d'aria-labelledby utilitzat en un camp de text senzill per proporcionar una etiqueta en una situació en què no hi ha text disponible per a una etiqueta dedicada, però sí que hi ha un altre text a la pàgina que es pot utilitzar per etiquetar amb precisió el control.

<input name="searchtxt" type="text" aria-labelledby="searchbtn">
<input name="searchbtn" id="searchbtn" type="submit" value="Search">

Etiquetar un control lliscant

A continuació es mostra un exemple d'aria-labelledby utilitzat per proporcionar una etiqueta a un control lliscant. En aquest cas, el text de l'etiqueta se selecciona dins d'una cadena de text adjacent més llarga. Tingueu en compte que aquest exemple està simplificat per mostrar únicament la relació d'etiquetatge; qui implementi controls personalitzats també s'ha d'assegurar que els controls compleixen els altres criteris de conformitat.

<p>Please select the <span id="mysldr-lbl">number of days for your trip</span></p>
<div id="mysldr" role="slider" aria-labelledby="mysldr-lbl"></div>

Una etiqueta a partir de diverses fonts

L'exemple següent d'aria-labelledby amb diverses referències utilitza l'element label. Per a més detalls sobre com concatenar diverses fonts d'informació en una etiqueta amb aria-labelledby, consulteu la tècnica Utilitzar aria-labelledby d'ARIA per concatenar una etiqueta a partir de diversos nodes de text.

<label id="l1" for="f3">Notify me</label>
<select name="amt" id="f3" aria-labelledby="l1 f3 l2">
  <option value="1">1</option>
  <option value="2">2</option>
</select>
<span id="l2">days in advance</span>

Nota: l'ús de l'element label s'inclou per diverses raons. Si l'usuari fa clic en el text de l'element label, el camp de formulari corresponent rep el focus, cosa que fa que l'objectiu del clic sigui més gran per a les persones amb problemes de destresa. A més, l'element label sempre s'exposa a través de l'API d'accessibilitat. S'hauria pogut utilitzar un span; tanmateix, un span perdria l'avantatge de la zona de clic més àmplia.

Proves

Procediment

Per a cada element de control d'interfície d'usuari en què hi hagi un atribut aria-labelledby:

  1. Comprovar que el valor de l'atribut aria-labelledby és l'id d'un element o una llista d'id separats per espais de la pàgina web.
  2. Comprovar que el text de l'element o els elements referenciats etiqueta amb precisió el control d'interfície d'usuari.

Resultats esperats

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

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