mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
e13e9647fc
🤖 I have created a release *beep* *boop* --- <details><summary>puppeteer: 19.6.0</summary> ## [19.6.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-v19.5.2...puppeteer-v19.6.0) (2023-01-23) ### Miscellaneous Chores * **puppeteer:** Synchronize puppeteer versions ### Dependencies * The following workspace dependencies were updated * dependencies * puppeteer-core bumped from 19.5.2 to 19.6.0 </details> <details><summary>puppeteer-core: 19.6.0</summary> ## [19.6.0](https://github.com/puppeteer/puppeteer/compare/puppeteer-core-v19.5.2...puppeteer-core-v19.6.0) (2023-01-23) ### Features * **chromium:** roll to Chromium 110.0.5479.0 (r1083080) ([#9500](https://github.com/puppeteer/puppeteer/issues/9500)) ([06e816b
](06e816bbfa
)), closes [#9470](https://github.com/puppeteer/puppeteer/issues/9470) * **page:** Adding support for referrerPolicy in `page.goto` ([#9561](https://github.com/puppeteer/puppeteer/issues/9561)) ([e3d69ec
](e3d69ec554
)) ### Bug Fixes * firefox revision resolution should not update chrome revision ([#9507](https://github.com/puppeteer/puppeteer/issues/9507)) ([f59bbf4
](f59bbf4014
)), closes [#9461](https://github.com/puppeteer/puppeteer/issues/9461) * improve screenshot method types ([#9529](https://github.com/puppeteer/puppeteer/issues/9529)) ([6847f88
](6847f8835f
)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
60 lines
1.5 KiB
Markdown
60 lines
1.5 KiB
Markdown
---
|
|
sidebar_label: Accessibility.snapshot
|
|
---
|
|
|
|
# Accessibility.snapshot() method
|
|
|
|
Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Accessibility {
|
|
snapshot(options?: SnapshotOptions): Promise<SerializedAXNode | null>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------------------------------------- | ----------------- |
|
|
| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | <i>(Optional)</i> |
|
|
|
|
**Returns:**
|
|
|
|
Promise<[SerializedAXNode](./puppeteer.serializedaxnode.md) \| null>
|
|
|
|
An AXNode object representing the snapshot.
|
|
|
|
## Remarks
|
|
|
|
**NOTE** The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`.
|
|
|
|
## Example 1
|
|
|
|
An example of dumping the entire accessibility tree:
|
|
|
|
```ts
|
|
const snapshot = await page.accessibility.snapshot();
|
|
console.log(snapshot);
|
|
```
|
|
|
|
## Example 2
|
|
|
|
An example of logging the focused node's name:
|
|
|
|
```ts
|
|
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;
|
|
}
|
|
```
|