Accessibility.snapshot() メソッド

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

シグネチャ:

class Accessibility {
  snapshot(options?: SnapshotOptions): Promise<SerializedAXNode | null>;
}

パラメーター

パラメーター	型	説明
オプション	SnapshotOptions	(オプション)

返り値

Promise<SerializedAXNode | null>

スナップショットを表す AXNode オブジェクト。

備考

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

例 1

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

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

例 2

フォーカスされたノードの名前を記録する例

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);
    return foundNode;
  }
  return null;
}