Руководство по доступным формам
Схема, которой следует каждая форма Lily в любом фреймворке: подписать каждый элемент, проверять при отправке, показывать каждую ошибку рядом с её полем и собирать ошибки в сводку там, куда переходит фокус.
Что вы создадите
Форму из двух полей, которая при отправке с ошибками сообщает, что не так, рядом с каждым полем и в сводке вверху, и переносит туда фокус, чтобы человек с клавиатурой или программой экранного доступа сразу нашёл ошибки. Она показана на простом HTML с классами Lily; каждый каталог фреймворка выводит ту же разметку из своих компонентов Field, Hint,
ErrorMessage и ErrorSummary . Около 20 минут; сначала полезно пройти руководство по HTML .
Шаг 1 — Подпишите каждый элемент и скажите, чего вы ждёте
<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>
- Видимый
<label for>у каждого элемента, а не текст-заполнитель вместо него: заполнитель исчезает, как только начинаешь печатать. - Подсказка присоединяется к имени поля через
aria-describedby, поэтому программа экранного доступа читает её вместе с полем. autocompleteпозволяет браузеру заполнить то, что он знает (WCAG 1.3.5).-
novalidateотключает собственные всплывающие сообщения браузера: ошибки вы покажете сами, своими словами и на своём языке. Атрибутыrequiredиtypeостаются: их читает ваш скрипт.
Шаг 2 — Проверяйте при отправке, а не во время ввода
Говорить человеку, что адрес почты неверен, после первой буквы — это шум. Проверяйте при отправке. Все 63 темы уже показывают поле как ошибочное только после того, как его изменили и покинули (:user-invalid), или когда вы задаёте
aria-invalid="true", так что при загрузке страницы ничего не становится красным.
Никогда не отключайте кнопку отправки, пока форма не станет верной: отключённая кнопка не может объяснить почему.
Шаг 3 — Показывайте каждую ошибку рядом с её полем
<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"сообщает, что поле заполнено неверно; сообщение объясняет почему и как исправить.- Сообщение указано в
aria-describedbyпосле подсказки, поэтому его читают, когда поле получает фокус. - Говорите, что делать, а не только что не так: «Введите адрес почты в правильном формате», а не «Неверно».
- Никогда не полагайтесь только на цвет: ошибка — это текст; красная рамка лишь повторяет его (WCAG 1.4.1).
Шаг 4 — Соберите ошибки там, куда переходит фокус
<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>
Разместите её вверху формы и переносите на неё фокус при отправке. Каждая ссылка ведёт прямо к своему полю. tabindex="-1" позволяет сводке получать фокус, не добавляя лишней остановки табуляции.
Шаг 5 — Скрипт, который всё связывает
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();
});
Сообщения ваши, на вашем языке: свойство браузера
validity говорит, какое правило нарушено, а ваша таблица — что сказать человеку. В Lily нет английского текста, который нужно переводить.
Проверьте работу: отправьте пустую форму с клавиатуры. Фокус переходит на сводку, и программа экранного доступа читает «There is a problem» и обе ошибки. Перейдите по ссылке: фокус попадает в поле, которое читается с подсказкой и ошибкой. Исправьте обе и отправьте: форма уходит, и ошибок не остаётся.
Чего избегать
- Ограничивать или исправлять введённое, не сообщая об этом; лучше скажите человеку.
- Очищать форму при ошибке: сохраняйте всё введённое.
- Ошибку, которая видна только при наведении или только во всплывающей подсказке.
- Истечение времени формы без предупреждения; используйте
timeout-dialog, чтобы предупредить и продлить.
Что дальше
- Обучение — восемь модулей, в каждом упражнение и самопроверка.
- ErrorSummary, Field и ErrorMessage в каталоге.
- Форма, которая работает по всему миру — имена, адреса, даты и направление письма.
- Темы — состояние ошибки, которое рисует каждая тема.