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

Tècnica HTML WCAG 2.2

H102Crear finestres modals amb l'element dialog d'HTML

Nom oficial al W3C: Crear diàlegs modals amb l'element dialog d'HTML

Versión en castellano

En poques paraules

Una finestra modal és un quadre que s'obre a sobre de la pàgina i bloqueja la resta fins que es tanca. Si es crea amb l'element dialog d'HTML i s'obre amb showModal(), el navegador gestiona sol el focus del teclat. Així s'eviten els errors típics de les finestres fetes a mà.

Per què és important

Qui utilitza el teclat o un lector de pantalla necessita que, quan s'obre la finestra, el focus (el punt on actua el teclat) hi entri. També necessita que no se'n pugui sortir cap a la pàgina del darrere i que, quan la tanqui, torni al botó que l'ha obert.

Si alguna d'aquestes coses falla, la persona es perd. Pot continuar tabulant per la pàgina oculta o quedar-se al principi del document després de tancar la finestra. Amb dialog el navegador ho fa tot per vosaltres.

Com es fa

  1. Poseu el contingut de la finestra dins de <dialog> i doneu-li un títol amb aria-labelledby.
  2. Obriu-la des d'un <button type="button"> amb el mètode showModal(). El mètode show() obre una finestra no modal i no bloqueja la resta.
  3. Per tancar-la, utilitzeu un botó dins d'un <form method="dialog">, o crideu close(). El navegador torna el focus al botó que l'ha oberta.
  4. Tingueu en compte que el focus va al primer element enfocable. Si voleu que vagi al títol, poseu-li tabindex="-1" i col·loqueu-lo abans del botó de tancar al codi.
  5. No anul·leu el tancament amb la tecla Esc, que el navegador ja ofereix.

Com comprovar-ho

  1. Obriu la finestra amb el teclat: arribeu al botó amb Tab i premeu Retorn o la barra espaiadora.
  2. Comproveu que el focus passa a la finestra o a un element de dins.
  3. Premeu Tab diverses vegades. El focus no ha d'arribar a enllaços o botons de la pàgina del darrere.
  4. Tanqueu amb Esc i amb el botó de tancar. El focus ha de tornar al botó que ha obert la finestra.

Exemple

Finestra modal per subscriure's al butlletí de notícies.

<button type="button" id="abrir">Subscriu-te al butlletí</button>

<dialog id="boletin" aria-labelledby="tit-boletin">
  <h2 id="tit-boletin" tabindex="-1">Butlletí de notícies</h2>
  <!-- formulari de subscripció -->
  <form method="dialog">
    <button>Tanca</button>
  </form>
</dialog>

<script>
  const boletin = document.getElementById('boletin');
  document.getElementById('abrir')
    .addEventListener('click', () => boletin.showModal());
</script>
Veure el text complet del W3C (traducció al català)

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

HTML

Descripció

Els qui desenvolupen llocs web solen utilitzar diàlegs modals per centrar l'atenció de l'usuari en una informació o en una activitat relacionada amb una tasca que queda fora de l'àmbit del contingut principal de la pàgina. Els diàlegs modals es poden construir al marcatge mitjançant la funció dialog d'ARIA i els seus atributs relacionats, o mitjançant l'element dialog d'HTML. A més de complir la primera regla d'ARIA, l'element dialog d'HTML ofereix diversos avantatges davant del seu equivalent en ARIA, ja que el navegador s'encarrega d'aquestes funcions:

  • el focus del teclat es mou al dialog modal que s'acaba d'obrir;
  • el focus del teclat torna a l'element que ha invocat el diàleg (suposant que l'element continuï a la pàgina) quan es tanca el dialog modal;
  • el focus del teclat es limita al contingut del dialog modal i a la interfície del mateix navegador (és a dir, la interfície d'usuari específica del navegador, com la barra d'adreces, etc.);
  • el contingut de la pàgina «fora» del diàleg modal passa a ser inert, cosa que fa que quedi ocult per a les tecnologies de suport i inoperable per a tots els usuaris mentre el dialog modal continuï obert;
  • l'ús de la tecla Escape per tancar el dialog modal.

Aquesta tècnica utilitza l'element dialog d'HTML en lloc d'una implementació ARIA a mida, cosa que redueix l'esforç necessari per crear un diàleg modal accessible.

Exemples

Un diàleg per subscriure's a una llista de correu

Aquest és un exemple d'ús d'un element dialog modal per mostrar a l'usuari un formulari de subscripció a una llista de correu. La part principal de la pàgina conté un element button que, quan s'activa, invoca el dialog modal. El button utilitza l'atribut type per indicar al navegador que no es tracta d'un button de tipus submit.

Quan s'obre el dialog modal, el navegador tracta tot el contingut que queda fora del diàleg modal com a inert, de manera que el fa inoperable i l'oculta a les tecnologies de suport. Per exemple, un lector de pantalla no podrà arribar a cap part del contingut inert ni anunciar-la. A més, com que el contingut de la pàgina és inert, el focus del teclat només podrà arribar als elements enfocables que siguin dins de l'element dialog i als controls del navegador. En invocar-lo, el navegador col·loca automàticament el focus al primer element enfocable del DOM del diàleg. En aquest exemple, l'element h1 rebrà el focus perquè té un atribut tabindex="-1". Tingueu en compte que, encara que el button de tancament del dialog apareix visualment abans de l'h1, és l'últim element del DOM del dialog. Si el button fos el primer, seria el que rebria el focus en obrir-se el diàleg.

L'HTML

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,
     initial-scale=1, shrink-to-fit=no">
    <title>Turbo Encabulator News</title>
  </head>
  <body>
    <main>
      <h1>All The News About Turbo Encabulators</h1>
      <button class="open-modal" type="button">Sign up to our mailing list!</button>
    </main>
    <dialog aria-labelledby="dialog-heading" id="mailing-list-dialog">
      <h1 id="dialog-heading" tabindex="-1">Sign up to our mailing list</h1>
      <form>
        <p class="req-note">All form fields are required.</p>
        <div>
          <label for="fname">First Name</label>
          <input aria-required="true" autocomplete="given-name" id="fname" type="text">
        </div>
        <div>
          <label for="lname">Last Name</label>
          <input aria-required="true" autocomplete="family-name" id="lname" type="text">
        </div>
        <div>
          <label for="email">Email address</label>
          <input aria-required="true" autocomplete="email" id="email" type="text">
        </div>
        <button class="sign-up" type="submit">Sign up</button>
      </form>
     <form method="dialog">
        <button aria-label="close" class="close-modal">&times;</button>
      </form>
    </dialog>
  </body>
</html>

El CSS

*, *::after, *::before {
  box-sizing: inherit;
}
body {
  background:#fff;
  color:#000;
  font:1rem/1.5 system-ui, Helvetica, Roboto, sans-serif;
}
*:focus-visible {
  outline:1px solid #0054AE;
  outline-offset:1px;
}
dialog {
  border:1px solid #000;
  padding:2rem;
  position:relative;
}
dialog::backdrop {
  background-color:hsla(0, 0%, 0%, .5);
}
.close-modal {
  inset-block-start:1.5rem;  
  inset-inline-end:1.5rem;  
  line-height:1.3;
  padding:0.25em 0.5em;
  position:absolute;
}
.sign-up {
  background:#000;
  color:#fff;
  padding:0.25em;
}
dialog h1 {
  display:inline-block;
  line-height:1.3333;
  margin:0;
  max-inline-size:95%;
}
form {
  display:grid;
  grid-gap:20px;
  grid-template-columns:repeat(auto-fit, minmax(150px, 1fr));
}
.req-note, .sign-up {
  grid-column:1 / -1;
}
label {
  display:block;
}
input {
  border:1px solid hsl(0, 0%, 50%);
  font:inherit;
  inline-size:calc(100% - 4px);
}
button {
  background:#fff;
  border:1px solid hsl(0, 0%, 50%);
  border-radius:3px;
  color:inherit;
  font:inherit;
  margin:0;
}

El JavaScript

L'script és necessari per mostrar el dialog quan s'invoca. L'element dialog d'HTML es pot obrir amb dues ordres diferents: show() (per a dialog no modals) i showModal() (per a dialog modals), que és la que s'utilitza en aquest exemple.

Nota: en lloc d'escriure una funció per tancar el dialog, el botó de tancament està niat dins d'un element form independent amb un atribut method="dialog". Aquest mètode permet tancar el diàleg en activar aquest botó, i el navegador s'encarregarà de tornar el focus del teclat a l'element que l'ha invocat.

document.addEventListener("DOMContentLoaded", function(e){
  const d = document.querySelector("dialog");
  const btnOpen = document.querySelector(".open-modal");
  btnOpen.addEventListener("click", function(){
    d.showModal();
  }, false);
});

Proves

Procediment

  1. Localitzar els components de la pàgina que invoquen elements dialog modals.
  2. Comprovar que cada dialog es pot obrir utilitzant el teclat per activar l'element que l'invoca (per exemple, activar un button prement la tecla Retorn o la barra espaiadora).
  3. Quan s'obre el dialog modal, comprovar que el focus s'hi ha mogut o s'ha mogut a un dels seus descendents enfocables.
  4. Mentre el dialog modal és obert, comprovar que el focus del teclat no es pot moure als elements del document principal.
  5. Quan es tanca el dialog modal, comprovar que el focus torna a l'element que l'ha invocat, si aquest element encara existeix a la pàgina.

Resultats esperats

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