Struct Accessibility 

pub struct Accessibility {
    inner: Weak<Page>,
}

The Accessibility class provides methods for inspecting Chromium’s accessibility tree. The accessibility tree is used by assistive technology such as screen readers or switches.

Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output.

Rendering engines of Chromium, Firefox and WebKit have a concept of “accessibility tree”, which is then translated into different platform-specific APIs. Accessibility namespace gives access to this Accessibility Tree.

Most of the accessibility tree gets filtered out when converting from internal browser AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Playwright tries to approximate this filtering, exposing only the “interesting” nodes of the tree.

Fields

inner: Weak<Page>

Implementations

impl Accessibility

pub(crate) fn new(inner: Weak<PageImpl>) -> Self

pub fn snapshot_builder(&self) -> SnapshotBuilder

Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.

NOTE: The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Playwright will discard them as well for an easier to process tree, unless interestingOnly is set to false.

An example of dumping the entire accessibility tree:

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

An example of logging the focused node’s name:

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;
}
var accessibilitySnapshot = await Page.Accessibility.SnapshotAsync();
var focusedNode = findFocusedNode(accessibilitySnapshot);
if(focusedNode != null)
 Console.WriteLine(focusedNode.Name);

Trait Implementations

impl Clone for Accessibility

fn clone(&self) -> Accessibility

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Accessibility

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.