ARIA: aria-invalid 属性
aria-invalid 状態は、入力された値がアプリケーションで想定される形式に従っていないことを示します。
解説
aria-invalid 属性は、入力フィールドに入力された値が、アプリケーションが受け入れる形式または値ではないことを示すために使用されます。これには、電子メールアドレスや電話番号などの形式が含まれる場合があります。また、aria-invalid は必須フィールドが空であることを示すためにも使用できます。
aria-invalid 属性は、一般的な HTML フォーム要素で使用でき、ARIA ロールが割り当てられている要素に限定されません。
この属性は、検証プロセスの結果として JavaScript で設定する必要があります。値が無効または範囲外であると判断された場合は、aria-invalid="true" を設定して、さらにユーザーにエラーがあることを伝えます。ユーザー体験を向上させるには、エラーを修正する方法を提案します。ユーザーがフォームの送信を試みるまで、値が入力されていない必須フィールドに aria-invalid="true" を設定しないでください。ユーザーがまだフォームに入力中である可能性があります。
メモ:
aria-invalid を aria-required 属性と組み合わせて使用する場合、フォームが送信される前に aria-invalid を true に設定しないでください。検証の結果としてのみ設定してください。
現在、4 つの値があります。true と false に加えて、文法エラーが検出された場合に使用できる grammar とスペルミスに使用できる spelling があります。属性が存在しない場合、値が false の場合、または値が空の文字列の場合は、デフォルト値の false が適用されます。その他の値は、true が設定されているものとして扱われます。
ネイティブ HTML 検証
HTML にはネイティブのフォーム検証機能があります。ユーザーがエラーのあるコントロールを含むフォームを送信すると、無効な値を持つ最初のフォームコントロールにネイティブでエラーメッセージが表示されます。
入力されていないフォームコントロールに required 属性がある場合、フォームは送信されず、「このフィールドを入力してください」などのエラーメッセージが表示されます。ネイティブ検証のメッセージはブラウザーによって異なり、スタイルを設定することはできません。
<input type="number" step="2" min="0" max="100" required />
前述の入力例で、ユーザーが最大値を超える値、最小値未満の値、またはステップ値と一致しない値を入力した場合、エラーメッセージが表示されます。例えばユーザーが「3」を入力した場合、ネイティブエラーメッセージは「有効な値を入力してください」のようになります。
独自のフォーム検証スクリプトを作成する場合は、無効なフォームコントロールに aria-invalid を設定してください。また、[aria-invalid="true"] を使ったスタイルと、aria-errormessage を使ったメッセージを用意し、どこに誤りがあり、どう修正すればよいかをユーザーが理解できるようにします。
値
grammar-
文法エラーが検出されました。
false(デフォルト)-
値にエラーは検出されませんでした。
spelling-
スペルミスが検出されました。
true-
ユーザーが入力した値は検証に失敗しました。
このリストにない値はすべて true として扱われます。
関連インターフェイス
Element.ariaInvalid-
ariaInvalidプロパティはElementインターフェイスの一部で、aria-invalid属性の値を反映します。この属性は、要素がアクセシビリティ API に公開されているかどうかを示します。 ElementInternals.ariaInvalid-
ariaInvalidプロパティはElementInternalsインターフェイスの一部で、aria-invalid属性の値を反映します。
関連付けられたロール
使用するロール:
継承先のロール:
例
次のスニペットは、blur イベントに検証関数が設定された 2 つのフォームフィールドの簡略版です。aria-invalid のデフォルト値は false なので、input 要素にこの属性を追加する必要は必ずしもありません。
<ul>
<li>
<label for="name">氏名</label>
<input
type="text"
name="name"
id="name"
aria-required="true"
aria-invalid="false" />
</li>
<li>
<label for="email">メールアドレス</label>
<input
type="email"
name="email"
id="email"
aria-required="true"
aria-invalid="false" />
</li>
</ul>
document.getElementById("name").addEventListener("blur", () => {
checkValidity(
"name",
" ",
"無効な名前が入力されました(名と姓の両方が必要です)",
);
});
document.getElementById("email").addEventListener("blur", () => {
checkValidity("email", "@", "無効なメールアドレスです");
});
blur 時にすぐにフィールドを検証する必要はありません。アプリケーションはフォームが送信されるまで待つこともできます(ただし、これは必ずしも推奨されません)。
次のスニペットは、特定の文字が存在するかどうかだけを確認する検証関数を示しています(実際の検証は、これより複雑になるでしょう)。
function checkValidity(id, searchTerm, msg) {
const elem = document.getElementById(id);
if (elem.value.includes(searchTerm)) {
elem.setAttribute("aria-invalid", "false");
updateAlert();
} else {
elem.setAttribute("aria-invalid", "true");
updateAlert(msg);
}
}
次のスニペットは、エラーメッセージを追加または削除するアラート関数を示しています。
function updateAlert(msg) {
const oldAlert = document.getElementById("alert");
if (oldAlert) {
oldAlert.remove();
}
if (msg) {
const newAlert = document.createElement("div");
newAlert.setAttribute("role", "alert");
newAlert.setAttribute("id", "alert");
const content = document.createTextNode(msg);
newAlert.appendChild(content);
document.body.appendChild(newAlert);
}
}
アラートの ARIA ロール属性が alert に設定されていることに注意してください。
仕様書
| 仕様書 |
|---|
| Accessible Rich Internet Applications (WAI-ARIA)> # aria-invalid> |
関連情報
aria-errormessage- CSS
:valid擬似クラス - CSS
:invalid擬似クラス - フォーム検証 チュートリアル