ARIA: document ロール

{{ariaref}}複雑な複合ウィジェットアプリケーションで一般的に使用される document ロールは、コンテキストを読み取りモードに切り替えることを支援技術を知らせることができます。 document ロールは、ドキュメントモードを使用して、この要素に含まれるコンテンツを読み取るための読み取りモードまたはブラウズモードを支援技術に指示します。

<div role="dialog">
 ...
 <div id="InfoText" role="document" tabindex="0">
  <p>いくつかの情報テキストがここに入ります。</p>
 </div>
 ...
 <button>閉じる</button>
</div>

この例は、いくつかのコントロールと、支援技術のユーザーがタブを当てて(Tab キーによる移動で)読むことができる情報テキストを含むセクションを含むダイアログウィジェットを示しています。

説明

デフォルトでは、ウェブページはドキュメント(document)として扱われ、支援技術(AT)は、新しいウェブページに入るときブラウズモードまたは読み取りモードにします。 このモードは、ウィジェットロールや application ロールなど、さまざまなロールを通じて変更できます。 document ロールは、AT をブラウズモードまたは読み取りモードに戻します。

一般に、application ロールまたは他のインタラクティブなウィジェットロール内に配置される document ロールは、利用可能な場合、支援技術のユーザがブラウズモードまたは仮想読み取りモードを使用して読むべきである複雑な複合ウィジェットのセクションを示すために使用します。

読み取りモードの AT は、ウィジェットロールまたは application ロールのセットを持つ要素を除くすべての要素に対してそのモードをデフォルトとしているため、document ロールは、静的リッチテキストとして読むべきであるウィジェットまたはアプリケーション内のフォーカス可能な要素に対してのみ役に立ちます。 ウィジェット内のテキストを含む要素に role="document"tabindex="0" を追加すると、スクリーンリーダーのユーザーは Tab キーを押してドキュメント要素にフォーカスを合わせ、スクリーンリーダーの読み取りカーソルでテキストを読み取ることができます。

支援技術は、親の動的コンテキストのために再配線されたコントロールを遮り、上矢印または下矢印キーボードイベントなどの標準入力イベントを再度有効にして、読み取りカーソルを制御するために、コンテキストをドキュメントモードに戻すべきです。

article ロールとは対照的に、document ロールは、document ロールを持つ他の要素との関係はなく、単にそれ含む複合ウィジェットとの関係を持っています。 記事(article)は関連記事を持つことができます。

関連する WAI-ARIA のロール、ステート、プロパティ

aria-expanded
ドキュメント要素が折りたたみ可能である場合は、true または false の値を含み、ドキュメントが現在展開されているか折りたたまれているかを示します。 他の値には、ドキュメントが折りたたまれないことを意味するデフォルトの undefined が含まれます。
tabindex="0"
支援技術のユーザーがそれにタブを当ててすぐに読むことができるように、それをフォーカス可能にするために使用します。

 

キーボードインタラクション

tabindex="0" 属性/値のペアを設定することで、要素をフォーカス可能にするべきです。 これにより、ユーザーはタブを当てることができ、読み取りモードが自動的に呼び出され、コンテンツをすぐに読むことができます。

必要な JavaScript 機能

なし(任意の属性が必要とする場合を除く。 例えば、document が折りたたみ可能である場合、aria-expanded のステートと値を維持する必要があります。)

例えば、Gmail と1つの会話ビューがあります。 GMail はウェブアプリケーションです。 Gmail の場合、ほとんどのユーザーエージェントのインタラクションは、ほとんどの場合、アプリケーションによって奪われます。 ただし、会話の件名を含む1つの会話の開始見出しにキーボードフォーカスが設定されている場合、スクリーンリーダーのユーザーは読み取りモードのコマンドを使用してメッセージを読んだり、展開したり、折りたたんだり、彼らがどんなやり方でも操作できるようにします。 Back ボタンをアクティブにするか、関連するキーを押すことによって、フォーカスがメッセージリストに戻ると、直接アプリケーションのインタラクションモードが再度呼び出され、矢印キーを使用してリスト内の別の会話に移動できます。

ベストプラクティス

tabindex 属性に値 0 を設定することにより、document ロールを持つ項目がフォーカス可能であることを常に確認します。 これはタブ順にも含まれます。

追加の利点

document ロールは、ユーザーが標準のスクリーンリーダーのコマンドで読むべき内容であることを明白に明示することによって、支援技術の動作を間接的に制御する簡単な方法です。

仕様

仕様 状態
Accessible Rich Internet Applications (WAI-ARIA) 1.1
document の定義
勧告

スクリーンリーダーのサポート

 

関連情報