2024-03-25 13:03:57 +00:00
|
|
|
---
|
|
|
|
sidebar_label: SerializedAXNode
|
|
|
|
---
|
|
|
|
|
|
|
|
# SerializedAXNode interface
|
|
|
|
|
|
|
|
Represents a Node and the properties of it that are relevant to Accessibility.
|
|
|
|
|
|
|
|
#### Signature:
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
export interface SerializedAXNode
|
|
|
|
```
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
<table><thead><tr><th>
|
|
|
|
|
|
|
|
Property
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Modifiers
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Type
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
|
|
|
</th><th>
|
|
|
|
|
|
|
|
Default
|
|
|
|
|
|
|
|
</th></tr></thead>
|
|
|
|
<tbody><tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="autocomplete">autocomplete</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="checked">checked</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean \| 'mixed'
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether the checkbox is checked, or in a [mixed state](https://www.w3.org/TR/wai-aria-practices/examples/checkbox/checkbox-2/checkbox-2.html).
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="children">children</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
[SerializedAXNode](./puppeteer.serializedaxnode.md)\[\]
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Children of this node, if there are any.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="description">description</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
An additional human readable description of the node.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="disabled">disabled</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="expanded">expanded</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="focused">focused</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="haspopup">haspopup</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="invalid">invalid</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether and in what way this node's value is invalid.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="keyshortcuts">keyshortcuts</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Any keyboard shortcuts associated with this node.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="level">level</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
The level of a heading.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="modal">modal</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="multiline">multiline</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="multiselectable">multiselectable</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether more than one child can be selected.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="name">name</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
A human readable name for the node.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="orientation">orientation</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="pressed">pressed</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean \| 'mixed'
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
Whether the node is checked or in a mixed state.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="readonly">readonly</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="required">required</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="role">role</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
The [role](https://www.w3.org/TR/wai-aria/#usage_intro) of the node.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="roledescription">roledescription</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
A human readable alternative to the role.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="selected">selected</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
boolean
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="value">value</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string \| number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
The current value of the node.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="valuemax">valuemax</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="valuemin">valuemin</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
number
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
<tr><td>
|
|
|
|
|
2024-04-11 16:51:07 +00:00
|
|
|
<span id="valuetext">valuetext</span>
|
2024-03-25 13:03:57 +00:00
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
`optional`
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
string
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
A description of the current value.
|
|
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
|
|
</td></tr>
|
|
|
|
</tbody></table>
|