Tutorial formulir yang aksesibel

Pola yang diikuti setiap formulir Lily, apa pun kerangka kerjanya: beri label setiap kontrol, periksa saat dikirim, taruh setiap galat di samping isiannya, dan ringkas galat di tempat fokus mendarat.

Yang akan Anda buat

Formulir dua isian yang, bila dikirim dengan kesalahan, mengatakan apa yang salah, di samping setiap isian dan dalam ringkasan di atas, lalu memindahkan fokus ke sana, sehingga pengguna papan ketik atau pembaca layar langsung menemukan galatnya. Ditampilkan dalam HTML biasa dengan kelas Lily; setiap katalog kerangka kerja menghasilkan markah yang sama dari komponennya sendiri, Field, Hint, ErrorMessage dan ErrorSummary . Sekitar 20 menit; tutorial HTML membantu bila dikerjakan lebih dulu.

Langkah 1 — Beri label setiap kontrol, dan katakan apa yang Anda harapkan

<form class="form" novalidate>
  <div class="field">
    <label class="label" for="name">Full name</label>
    <input class="text-input" type="text" id="name" name="name" autocomplete="name" required />
  </div>
  <div class="field">
    <label class="label" for="email">Email</label>
    <p class="hint" id="email-hint">We only use this to send your appointment.</p>
    <input class="email-input" type="email" id="email" name="email"
      autocomplete="email" aria-describedby="email-hint" required />
  </div>
  <button class="button" type="submit">Continue</button>
</form>
  • Sebuah <label for> yang terlihat pada setiap kontrol, jangan pernah teks contoh sebagai gantinya: teks contoh hilang saat mengetik.
  • Petunjuk bergabung dengan nama isian melalui aria-describedby, sehingga pembaca layar membacanya bersama isian.
  • autocomplete membiarkan peramban mengisi apa yang diketahuinya (WCAG 1.3.5).
  • novalidate mematikan gelembung bawaan peramban, karena Anda akan menampilkan galat sendiri, dengan kata-kata dan bahasa Anda. Atribut required dan type tetap ada: skrip Anda membacanya.

Langkah 2 — Periksa saat dikirim, bukan saat orang mengetik

Memberi tahu seseorang bahwa surelnya salah setelah satu huruf hanyalah gangguan. Periksa saat dikirim. Ke-63 tema sudah menandai isian tidak valid hanya setelah diubah dan ditinggalkan (:user-invalid), atau saat Anda menetapkan aria-invalid="true", sehingga tidak ada yang memerah saat halaman dimuat.

Jangan pernah menonaktifkan tombol kirim sampai formulir valid: tombol nonaktif tidak bisa menjelaskan alasannya.

Langkah 3 — Taruh setiap galat di samping isiannya

<div class="field">
  <label class="label" for="email">Email</label>
  <p class="hint" id="email-hint">We only use this to send your appointment.</p>
  <p class="error-message" id="email-error">Enter an email address in the right format, like name@example.com</p>
  <input class="email-input" type="email" id="email" name="email" autocomplete="email"
    aria-invalid="true" aria-describedby="email-hint email-error" required />
</div>
  • aria-invalid="true" mengatakan isian itu salah; pesannya mengatakan mengapa dan cara memperbaikinya.
  • Pesan ada di aria-describedby, setelah petunjuk, sehingga dibaca saat isian menerima fokus.
  • Katakan apa yang harus dilakukan, bukan hanya apa yang salah: "Masukkan alamat surel dengan format yang benar", bukan "Tidak valid".
  • Jangan pernah hanya warna: teksnya adalah galat; garis merah hanya mengulanginya (WCAG 1.4.1).

Langkah 4 — Ringkas galat di tempat fokus mendarat

<div class="error-summary" role="alert" tabindex="-1" aria-labelledby="error-summary-title">
  <h2 id="error-summary-title">There is a problem</h2>
  <ul>
    <li><a href="#name">Enter your full name</a></li>
    <li><a href="#email">Enter an email address in the right format, like name@example.com</a></li>
  </ul>
</div>

Taruh di atas formulir dan pindahkan fokus ke sana saat dikirim. Setiap tautan langsung menuju isiannya. tabindex="-1" membuat ringkasan bisa menerima fokus tanpa menambah perhentian tab.

Langkah 5 — Skrip yang menyatukan semuanya

const messages = {
  name: { valueMissing: "Enter your full name" },
  email: {
    valueMissing: "Enter your email address",
    typeMismatch: "Enter an email address in the right format, like name@example.com",
  },
};

const form = document.querySelector("form");
form.addEventListener("submit", (event) => {
  form.querySelector(".error-summary")?.remove();
  const errors = [];
  for (const field of form.querySelectorAll("input")) {
    const old = document.getElementById(field.id + "-error");
    old?.remove();
    const describedBy = (field.getAttribute("aria-describedby") ?? "")
      .split(" ").filter((id) => id && id !== field.id + "-error");
    const problem = Object.keys(messages[field.name] ?? {}).find((key) => field.validity[key]);
    if (!problem) {
      field.removeAttribute("aria-invalid");
      field.setAttribute("aria-describedby", describedBy.join(" "));
      continue;
    }
    const text = messages[field.name][problem];
    const message = document.createElement("p");
    message.className = "error-message";
    message.id = field.id + "-error";
    message.textContent = text;
    field.before(message);
    field.setAttribute("aria-invalid", "true");
    field.setAttribute("aria-describedby", [...describedBy, message.id].join(" "));
    errors.push({ id: field.id, text });
  }
  if (errors.length === 0) return; // valid: let it submit
  event.preventDefault();
  const summary = document.createElement("div");
  summary.className = "error-summary";
  summary.setAttribute("role", "alert");
  summary.tabIndex = -1;
  summary.setAttribute("aria-labelledby", "error-summary-title");
  summary.innerHTML = '<h2 id="error-summary-title">There is a problem</h2><ul></ul>';
  for (const { id, text } of errors) {
    const link = document.createElement("a");
    link.href = "#" + id;
    link.textContent = text;
    const item = document.createElement("li");
    item.append(link);
    summary.querySelector("ul").append(item);
  }
  form.prepend(summary);
  summary.focus();
});

Pesannya milik Anda, dalam bahasa Anda: properti validity milik peramban mengatakan aturan mana yang gagal, dan tabel Anda mengatakan apa yang disampaikan kepada orangnya. Lily tidak membawa teks bahasa Inggris untuk diterjemahkan.

Periksa hasil kerja Anda: kirim formulir kosong dengan papan ketik. Fokus pindah ke ringkasan dan pembaca layar membaca "There is a problem" serta kedua galat. Ikuti tautan: fokus mendarat di isian, yang dibaca bersama petunjuk dan galatnya. Perbaiki keduanya lalu kirim: formulir terkirim, tanpa galat yang tersisa.

Yang perlu dihindari

  • Membatasi atau mengoreksi ketikan seseorang tanpa memberi tahu; beri tahu mereka.
  • Mengosongkan formulir saat ada galat: simpan semua yang dimasukkan.
  • Galat yang hanya muncul saat penunjuk diarahkan, atau hanya di tooltip.
  • Formulir yang kedaluwarsa tanpa peringatan; gunakan timeout-dialog untuk memperingatkan dan memperpanjang.

Langkah berikutnya