Chrome DevTools

Accessibility Domain

Experimental

Methods

Events

Types

Methods

Chrome DevTools

Accessibility.disable #

Disables the accessibility domain.

Chrome DevTools

Accessibility.enable #

Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.

Chrome DevTools

Accessibility.getAXNodeAndAncestors Experimental#

Fetches a node and all ancestors up to and including the root. Requires enable() to have been called previously.

Parameters

nodeId
Optional
DOM.NodeId

Identifier of the node to get.

backendNodeId
Optional
DOM.BackendNodeId

Identifier of the backend node to get.

objectId
Optional
Runtime.RemoteObjectId

JavaScript object id of the node wrapper to get.

Return object

nodes
array[ AXNode ]
Chrome DevTools

Accessibility.getChildAXNodes Experimental#

Fetches a particular accessibility node by AXNodeId. Requires enable() to have been called previously.

Parameters

id
AXNodeId
frameId
Optional
Page.FrameId

The frame in whose document the node resides. If omitted, the root frame is used.

Return object

nodes
array[ AXNode ]
Chrome DevTools

Accessibility.getFullAXTree Experimental#

Fetches the entire accessibility tree for the root Document

Parameters

depth
Optional
integer

The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned.

frameId
Optional
Page.FrameId

The frame for whose document the AX tree should be retrieved. If omitted, the root frame is used.

Return object

nodes
array[ AXNode ]
Chrome DevTools

Accessibility.getPartialAXTree Experimental#

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

Parameters

nodeId
Optional
DOM.NodeId

Identifier of the node to get the partial accessibility tree for.

backendNodeId
Optional
DOM.BackendNodeId

Identifier of the backend node to get the partial accessibility tree for.

objectId
Optional
Runtime.RemoteObjectId

JavaScript object id of the node wrapper to get the partial accessibility tree for.

fetchRelatives
Optional
boolean

Whether to fetch this node's ancestors, siblings and children. Defaults to true.

Return object

nodes
array[ AXNode ]

The Accessibility.AXNode for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.

Chrome DevTools

Accessibility.getRootAXNode Experimental#

Fetches the root node. Requires enable() to have been called previously.

Parameters

frameId
Optional
Page.FrameId

The frame in whose document the node resides. If omitted, the root frame is used.

Return object

node
AXNode
Chrome DevTools

Accessibility.queryAXTree Experimental#

Query a DOM node's accessibility subtree for accessible name and role. This command computes the name and role for all nodes in the subtree, including those that are ignored for accessibility, and returns those that match the specified name and role. If no DOM node is specified, or the DOM node does not exist, the command returns an error. If neither accessibleName or role is specified, it returns all the accessibility nodes in the subtree.

Parameters

nodeId
Optional
DOM.NodeId

Identifier of the node for the root to query.

backendNodeId
Optional
DOM.BackendNodeId

Identifier of the backend node for the root to query.

objectId
Optional
Runtime.RemoteObjectId

JavaScript object id of the node wrapper for the root to query.

accessibleName
Optional
string

Find nodes with this computed name.

role
Optional
string

Find nodes with this computed role.

Return object

nodes
array[ AXNode ]

A list of Accessibility.AXNode matching the specified attributes, including nodes that are ignored for accessibility.

Events

Chrome DevTools

Accessibility.loadComplete Experimental#

The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.

Parameters

root
AXNode

New document root node.

Chrome DevTools

Accessibility.nodesUpdated Experimental#

The nodesUpdated event is sent every time a previously requested node has changed the in tree.

Parameters

nodes
array[ AXNode ]

Updated node data.

Types

Chrome DevTools

Accessibility.AXNode #

A node in the accessibility tree.

Type: object

Properties

nodeId
AXNodeId

Unique identifier for this node.

ignored
boolean

Whether this node is ignored for accessibility

ignoredReasons
Optional
array[ AXProperty ]

Collection of reasons why this node is hidden.

role
Optional
AXValue

This Node's role, whether explicit or implicit.

chromeRole
Optional
AXValue

This Node's Chrome raw role.

name
Optional
AXValue

The accessible name for this Node.

description
Optional
AXValue

The accessible description for this Node.

value
Optional
AXValue

The value for this Node.

properties
Optional
array[ AXProperty ]

All other properties

parentId
Optional
AXNodeId

ID for this node's parent.

childIds
Optional
array[ AXNodeId ]

IDs for each of this node's child nodes.

backendDOMNodeId
Optional
DOM.BackendNodeId

The backend ID for the associated DOM node, if any.

frameId
Optional
Page.FrameId

The frame ID for the frame associated with this nodes document.

Chrome DevTools

Accessibility.AXNodeId #

Unique accessibility node identifier.

Type: string

Chrome DevTools

Accessibility.AXProperty #

Type: object

Properties

name
AXPropertyName

The name of this property.

value
AXValue

The value of this property.

Chrome DevTools

Accessibility.AXPropertyName #

Values of AXProperty name:

  • from 'busy' to 'roledescription': states which apply to every AX node
  • from 'live' to 'root': attributes which apply to nodes in live regions
  • from 'autocomplete' to 'valuetext': attributes which apply to widgets
  • from 'checked' to 'selected': states which apply to widgets
  • from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.

Type: string

Allowed values: busy, disabled, editable, focusable, focused, hidden, hiddenRoot, invalid, keyshortcuts, settable, roledescription, live, atomic, relevant, root, autocomplete, hasPopup, level, multiselectable, orientation, multiline, readonly, required, valuemin, valuemax, valuetext, checked, expanded, modal, pressed, selected, activedescendant, controls, describedby, details, errormessage, flowto, labelledby, owns, url

Chrome DevTools

Accessibility.AXRelatedNode #

Type: object

Properties

backendDOMNodeId
DOM.BackendNodeId

The BackendNodeId of the related DOM node.

idref
Optional
string

The IDRef value provided, if any.

text
Optional
string

The text alternative of this node in the current context.

Chrome DevTools

Accessibility.AXValue #

A single computed AX property.

Type: object

Properties

type
AXValueType

The type of this value.

value
Optional
any

The computed value of this property.

relatedNodes
Optional
array[ AXRelatedNode ]

One or more related nodes, if applicable.

sources
Optional
array[ AXValueSource ]

The sources which contributed to the computation of this property.

Chrome DevTools

Accessibility.AXValueNativeSourceType #

Enum of possible native property sources (as a subtype of a particular AXValueSourceType).

Type: string

Allowed values: description, figcaption, label, labelfor, labelwrapped, legend, rubyannotation, tablecaption, title, other

Chrome DevTools

Accessibility.AXValueSource #

A single source for a computed AX property.

Type: object

Properties

type
AXValueSourceType

What type of source this is.

value
Optional
AXValue

The value of this property source.

attribute
Optional
string

The name of the relevant attribute, if any.

attributeValue
Optional
AXValue

The value of the relevant attribute, if any.

superseded
Optional
boolean

Whether this source is superseded by a higher priority source.

nativeSource
Optional
AXValueNativeSourceType

The native markup source for this value, e.g. a <label> element.

nativeSourceValue
Optional
AXValue

The value, such as a node or node list, of the native source.

invalid
Optional
boolean

Whether the value for this property is invalid.

invalidReason
Optional
string

Reason for the value being invalid, if it is.

Chrome DevTools

Accessibility.AXValueSourceType #

Enum of possible property sources.

Type: string

Allowed values: attribute, implicit, style, contents, placeholder, relatedElement

Chrome DevTools

Accessibility.AXValueType #

Enum of possible property types.

Type: string

Allowed values: boolean, tristate, booleanOrUndefined, idref, idrefList, integer, node, nodeList, number, string, computedString, token, tokenList, domRelation, role, internalRole, valueUndefined