-
Notifications
You must be signed in to change notification settings - Fork 9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(new-docs): add TSDoc comments to
Accessibility
(#5971)
* feat(new-docs): add tsdoc to `Accessibility`
- Loading branch information
1 parent
086c089
commit 0b3d52a
Showing
36 changed files
with
590 additions
and
34 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [autocomplete](./puppeteer.serializedaxnode.autocomplete.md) | ||
|
||
## SerializedAXNode.autocomplete property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
autocomplete?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [checked](./puppeteer.serializedaxnode.checked.md) | ||
|
||
## SerializedAXNode.checked property | ||
|
||
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)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
checked?: boolean | 'mixed'; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [children](./puppeteer.serializedaxnode.children.md) | ||
|
||
## SerializedAXNode.children property | ||
|
||
Children of this node, if there are any. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
children?: SerializedAXNode[]; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [description](./puppeteer.serializedaxnode.description.md) | ||
|
||
## SerializedAXNode.description property | ||
|
||
An additional human readable description of the node. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
description?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [disabled](./puppeteer.serializedaxnode.disabled.md) | ||
|
||
## SerializedAXNode.disabled property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
disabled?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [expanded](./puppeteer.serializedaxnode.expanded.md) | ||
|
||
## SerializedAXNode.expanded property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
expanded?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [focused](./puppeteer.serializedaxnode.focused.md) | ||
|
||
## SerializedAXNode.focused property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
focused?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [haspopup](./puppeteer.serializedaxnode.haspopup.md) | ||
|
||
## SerializedAXNode.haspopup property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
haspopup?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [invalid](./puppeteer.serializedaxnode.invalid.md) | ||
|
||
## SerializedAXNode.invalid property | ||
|
||
Whether and in what way this node's value is invalid. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
invalid?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [keyshortcuts](./puppeteer.serializedaxnode.keyshortcuts.md) | ||
|
||
## SerializedAXNode.keyshortcuts property | ||
|
||
Any keyboard shortcuts associated with this node. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
keyshortcuts?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [level](./puppeteer.serializedaxnode.level.md) | ||
|
||
## SerializedAXNode.level property | ||
|
||
The level of a heading. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
level?: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) | ||
|
||
## SerializedAXNode interface | ||
|
||
Represents a Node and the properties of it that are relevant to Accessibility. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface SerializedAXNode | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [autocomplete](./puppeteer.serializedaxnode.autocomplete.md) | string | | | ||
| [checked](./puppeteer.serializedaxnode.checked.md) | boolean \| 'mixed' | 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)<!-- -->. | | ||
| [children](./puppeteer.serializedaxnode.children.md) | [SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- -->\[\] | Children of this node, if there are any. | | ||
| [description](./puppeteer.serializedaxnode.description.md) | string | An additional human readable description of the node. | | ||
| [disabled](./puppeteer.serializedaxnode.disabled.md) | boolean | | | ||
| [expanded](./puppeteer.serializedaxnode.expanded.md) | boolean | | | ||
| [focused](./puppeteer.serializedaxnode.focused.md) | boolean | | | ||
| [haspopup](./puppeteer.serializedaxnode.haspopup.md) | string | | | ||
| [invalid](./puppeteer.serializedaxnode.invalid.md) | string | Whether and in what way this node's value is invalid. | | ||
| [keyshortcuts](./puppeteer.serializedaxnode.keyshortcuts.md) | string | Any keyboard shortcuts associated with this node. | | ||
| [level](./puppeteer.serializedaxnode.level.md) | number | The level of a heading. | | ||
| [modal](./puppeteer.serializedaxnode.modal.md) | boolean | | | ||
| [multiline](./puppeteer.serializedaxnode.multiline.md) | boolean | | | ||
| [multiselectable](./puppeteer.serializedaxnode.multiselectable.md) | boolean | Whether more than one child can be selected. | | ||
| [name](./puppeteer.serializedaxnode.name.md) | string | A human readable name for the node. | | ||
| [orientation](./puppeteer.serializedaxnode.orientation.md) | string | | | ||
| [pressed](./puppeteer.serializedaxnode.pressed.md) | boolean \| 'mixed' | Whether the node is checked or in a mixed state. | | ||
| [readonly](./puppeteer.serializedaxnode.readonly.md) | boolean | | | ||
| [required](./puppeteer.serializedaxnode.required.md) | boolean | | | ||
| [role](./puppeteer.serializedaxnode.role.md) | string | The [role](https://www.w3.org/TR/wai-aria/#usage_intro) of the node. | | ||
| [roledescription](./puppeteer.serializedaxnode.roledescription.md) | string | A human readable alternative to the role. | | ||
| [selected](./puppeteer.serializedaxnode.selected.md) | boolean | | | ||
| [value](./puppeteer.serializedaxnode.value.md) | string \| number | The current value of the node. | | ||
| [valuemax](./puppeteer.serializedaxnode.valuemax.md) | number | | | ||
| [valuemin](./puppeteer.serializedaxnode.valuemin.md) | number | | | ||
| [valuetext](./puppeteer.serializedaxnode.valuetext.md) | string | A description of the current value. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [modal](./puppeteer.serializedaxnode.modal.md) | ||
|
||
## SerializedAXNode.modal property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
modal?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [multiline](./puppeteer.serializedaxnode.multiline.md) | ||
|
||
## SerializedAXNode.multiline property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
multiline?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [multiselectable](./puppeteer.serializedaxnode.multiselectable.md) | ||
|
||
## SerializedAXNode.multiselectable property | ||
|
||
Whether more than one child can be selected. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
multiselectable?: boolean; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [name](./puppeteer.serializedaxnode.name.md) | ||
|
||
## SerializedAXNode.name property | ||
|
||
A human readable name for the node. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
name?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [SerializedAXNode](./puppeteer.serializedaxnode.md) > [orientation](./puppeteer.serializedaxnode.orientation.md) | ||
|
||
## SerializedAXNode.orientation property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
orientation?: string; | ||
``` |
Oops, something went wrong.