2022-07-05 13:41:43 +00:00
---
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.
2022-10-24 07:07:05 +00:00
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Accessibility {
snapshot(options?: SnapshotOptions): Promise< SerializedAXNode | null > ;
}
```
## Parameters
2024-03-20 15:03:14 +00:00
< table > < thead > < tr > < th >
2022-07-05 13:41:43 +00:00
2024-03-20 15:03:14 +00:00
Parameter
< / th > < th >
Type
< / th > < th >
Description
< / th > < / tr > < / thead >
< tbody > < tr > < td >
options
< / td > < td >
[SnapshotOptions ](./puppeteer.snapshotoptions.md )
< / td > < td >
_(Optional)_
< / td > < / tr >
< / tbody > < / table >
2022-07-05 13:41:43 +00:00
**Returns:**
Promise< [SerializedAXNode](./puppeteer.serializedaxnode.md) \| null>
An AXNode object representing the snapshot.
## Remarks
2023-05-02 06:53:40 +00:00
**NOTE** The Chrome 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` .
2022-07-05 13:41:43 +00:00
## 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;
}
```