Accessibility

非推奨

このクラスは非推奨です。ページのアクセシビリティをテストする必要がある場合は、Axeのような他のライブラリを使用してください。Axeとの統合については、Node.jsのガイドを参照してください。

Accessibilityクラスは、Chromiumのアクセシビリティツリーを検査するメソッドを提供します。アクセシビリティツリーは、スクリーンリーダーやスイッチなどの支援技術によって使用されます。

アクセシビリティは非常にプラットフォーム固有のものです。異なるプラットフォームでは、出力が大きく異なる可能性のあるさまざまなスクリーンリーダーがあります。

Chromium、Firefox、WebKitのレンダリングエンジンには「アクセシビリティツリー」の概念があり、これは異なるプラットフォーム固有のAPIに変換されます。Accessibility名前空間は、このアクセシビリティツリーへのアクセスを提供します。

ほとんどのアクセシビリティツリーは、内部ブラウザのAXツリーからプラットフォーム固有のAXツリーに変換する際、または支援技術自体によってフィルタリングされます。デフォルトでは、Playwrightはこのフィルタリングを近似しようとし、ツリーの「興味深い」ノードのみを公開します。

非推奨

スナップショット

v1.9より前に追加

accessibility.snapshot

非推奨

このメソッドは非推奨です。ページのアクセシビリティをテストする必要がある場合は、Axeのような他のライブラリを使用してください。Axeとの統合については、Node.jsのガイドを参照してください。

アクセシビリティツリーの現在の状態をキャプチャします。返されるオブジェクトは、ページのルートアクセシブルノードを表します。

注

Chromiumアクセシビリティツリーには、ほとんどのプラットフォームやほとんどのスクリーンリーダーで利用されないノードが含まれています。Playwrightは、interestingOnlyがfalseに設定されていない限り、処理しやすいツリーにするためにそれらを破棄します。

使用法

アクセシビリティツリー全体をダンプする例

const snapshot = await page.accessibility.snapshot();
console.log(snapshot);

フォーカスされているノードの名前をログに記録する例

const snapshot = await page.accessibility.snapshot();
const node = findFocusedNode(snapshot);
console.log(node && node.name);

function findFocusedNode(node) {
  if (node.focused)
    return node;
  for (const child of node.children || []) {
    const foundNode = findFocusedNode(child);
    if (foundNode)
      return foundNode;
  }
  return null;
}

引数

options Object (optional)
- interestingOnly boolean (オプション)#
  
  ツリーから興味のないノードを削除します。デフォルトはtrueです。
- root ElementHandle (オプション)#
  
  スナップショットのルートDOM要素。デフォルトはページ全体です。

戻り値

Promise<null | Object>#
- role string
  
  role。
- name string
  
  ノードの人間が読める名前。
- value string | number
  
  該当する場合、ノードの現在の値。
- description string
  
  該当する場合、ノードの追加の人間が読める説明。
- keyshortcuts string
  
  該当する場合、このノードに関連付けられたキーボードショートカット。
- roledescription string
  
  該当する場合、ロールの人間が読める代替。
- valuetext string
  
  該当する場合、現在の値の説明。
- disabled boolean
  
  該当する場合、ノードが無効であるかどうか。
- expanded boolean
  
  該当する場合、ノードが展開されているか折りたたまれているか。
- focused boolean
  
  該当する場合、ノードがフォーカスされているかどうか。
- modal boolean
  
  該当する場合、ノードがモーダルであるかどうか。
- multiline boolean
  
  該当する場合、ノードのテキスト入力が複数行をサポートしているかどうか。
- multiselectable boolean
  
  該当する場合、複数の子が選択可能であるかどうか。
- readonly boolean
  
  該当する場合、ノードが読み取り専用であるかどうか。
- required boolean
  
  該当する場合、ノードが必要であるかどうか。
- selected boolean
  
  該当する場合、ノードが親ノードで選択されているかどうか。
- checked boolean | "mixed"
  
  該当する場合、チェックボックスがチェックされているか、「mixed」であるか。
- pressed boolean | "mixed"
  
  該当する場合、トグルボタンがチェックされているか、「mixed」であるか。
- level number
  
  該当する場合、見出しのレベル。
- valuemin number
  
  該当する場合、ノードの最小値。
- valuemax number
  
  該当する場合、ノードの最大値。
- autocomplete string
  
  該当する場合、コントロールがサポートするオートコンプリートの種類。
- haspopup string
  
  該当する場合、ノードに現在表示されているポップアップの種類。
- invalid string
  
  該当する場合、このノードの値が無効であるかどうか、およびその方法。
- orientation string
  
  該当する場合、ノードが水平方向か垂直方向か。
- children Array<Object>
  
  該当する場合、子ノード。

非推奨​

スナップショット​

非推奨

スナップショット