Skip to main content
Version: 22.12.0

SerializedAXNode interface

Represents a Node and the properties of it that are relevant to Accessibility.

Signature:

export interface SerializedAXNode

Properties

Property

Modifiers

Type

Description

Default

autocomplete

optional

string

checked

optional

boolean | 'mixed'

Whether the checkbox is checked, or in a mixed state.

children

optional

SerializedAXNode[]

Children of this node, if there are any.

description

optional

string

An additional human readable description of the node.

disabled

optional

boolean

expanded

optional

boolean

focused

optional

boolean

haspopup

optional

string

invalid

optional

string

Whether and in what way this node's value is invalid.

keyshortcuts

optional

string

Any keyboard shortcuts associated with this node.

level

optional

number

The level of a heading.

modal

optional

boolean

multiline

optional

boolean

multiselectable

optional

boolean

Whether more than one child can be selected.

name

optional

string

A human readable name for the node.

orientation

optional

string

pressed

optional

boolean | 'mixed'

Whether the node is checked or in a mixed state.

readonly

optional

boolean

required

optional

boolean

role

string

The role of the node.

roledescription

optional

string

A human readable alternative to the role.

selected

optional

boolean

value

optional

string | number

The current value of the node.

valuemax

optional

number

valuemin

optional

number

valuetext

optional

string

A description of the current value.

Methods

Method

Description

elementHandle()

Get an ElementHandle for this AXNode if available.

If the underlying DOM element has been disposed, the method might return an error.