diff --git a/api-extractor.json b/api-extractor.json index 8cc8240aa41e6..b388a148a4906 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -1,7 +1,7 @@ { "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", "mainEntryPointFilePath": "/lib/cjs/api-docs-entry.d.ts", - "bundledPackages": [ ], + "bundledPackages": [ "devtools-protocol" ], "apiReport": { "enabled": false diff --git a/new-docs/puppeteer.browsercontext.overridepermissions.md b/new-docs/puppeteer.browsercontext.overridepermissions.md index cebc0666c3017..afa5105d68f04 100644 --- a/new-docs/puppeteer.browsercontext.overridepermissions.md +++ b/new-docs/puppeteer.browsercontext.overridepermissions.md @@ -15,7 +15,7 @@ overridePermissions(origin: string, permissions: Protocol.Browser.PermissionType | Parameter | Type | Description | | --- | --- | --- | | origin | string | The origin to grant permissions to, e.g. "https://example.com". | -| permissions | Protocol.Browser.PermissionType\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. | +| permissions | [Protocol.Browser.PermissionType](./puppeteer.protocol.browser.permissiontype.md)\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. | Returns: diff --git a/new-docs/puppeteer.dialog.type.md b/new-docs/puppeteer.dialog.type.md index a598c1c43a406..9e737aa6676bd 100644 --- a/new-docs/puppeteer.dialog.type.md +++ b/new-docs/puppeteer.dialog.type.md @@ -11,7 +11,7 @@ type(): Protocol.Page.DialogType; ``` Returns: -Protocol.Page.DialogType +[Protocol.Page.DialogType](./puppeteer.protocol.page.dialogtype.md) The type of the dialog. diff --git a/new-docs/puppeteer.md b/new-docs/puppeteer.md index f8c728372ee88..5e64b8e168171 100644 --- a/new-docs/puppeteer.md +++ b/new-docs/puppeteer.md @@ -81,6 +81,12 @@ | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | | +## Namespaces + +| Namespace | Description | +| --- | --- | +| [Protocol](./puppeteer.protocol.md) | \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* | + ## Variables | Variable | Description | diff --git a/new-docs/puppeteer.page.cookies.md b/new-docs/puppeteer.page.cookies.md index 1f7cb6fcaf6f8..8fb2452d0692c 100644 --- a/new-docs/puppeteer.page.cookies.md +++ b/new-docs/puppeteer.page.cookies.md @@ -20,5 +20,5 @@ cookies(...urls: string[]): Promise; Returns: -Promise<Protocol.Network.Cookie\[\]> +Promise<[Protocol.Network.Cookie](./puppeteer.protocol.network.cookie.md)\[\]> diff --git a/new-docs/puppeteer.page.deletecookie.md b/new-docs/puppeteer.page.deletecookie.md index edb0e6c4fb490..cb8d1a357175d 100644 --- a/new-docs/puppeteer.page.deletecookie.md +++ b/new-docs/puppeteer.page.deletecookie.md @@ -14,7 +14,7 @@ deleteCookie(...cookies: Protocol.Network.DeleteCookiesRequest[]): Promise | Parameter | Type | Description | | --- | --- | --- | -| cookies | Protocol.Network.DeleteCookiesRequest\[\] | | +| cookies | [Protocol.Network.DeleteCookiesRequest](./puppeteer.protocol.network.deletecookiesrequest.md)\[\] | | Returns: diff --git a/new-docs/puppeteer.page.setcookie.md b/new-docs/puppeteer.page.setcookie.md index d461a055c4a9b..97858a5f0d7ed 100644 --- a/new-docs/puppeteer.page.setcookie.md +++ b/new-docs/puppeteer.page.setcookie.md @@ -14,7 +14,7 @@ setCookie(...cookies: Protocol.Network.CookieParam[]): Promise; | Parameter | Type | Description | | --- | --- | --- | -| cookies | Protocol.Network.CookieParam\[\] | | +| cookies | [Protocol.Network.CookieParam](./puppeteer.protocol.network.cookieparam.md)\[\] | | Returns: diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.backenddomnodeid.md b/new-docs/puppeteer.protocol.accessibility.axnode.backenddomnodeid.md new file mode 100644 index 0000000000000..8fa85f1e7be14 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.backenddomnodeid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md) + +## Protocol.Accessibility.AXNode.backendDOMNodeId property + +The backend ID for the associated DOM node, if any. + +Signature: + +```typescript +backendDOMNodeId?: DOM.BackendNodeId; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.childids.md b/new-docs/puppeteer.protocol.accessibility.axnode.childids.md new file mode 100644 index 0000000000000..eea5a47c075b1 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.childids.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [childIds](./puppeteer.protocol.accessibility.axnode.childids.md) + +## Protocol.Accessibility.AXNode.childIds property + +IDs for each of this node's child nodes. + +Signature: + +```typescript +childIds?: AXNodeId[]; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.description.md b/new-docs/puppeteer.protocol.accessibility.axnode.description.md new file mode 100644 index 0000000000000..c658d03eae023 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.description.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [description](./puppeteer.protocol.accessibility.axnode.description.md) + +## Protocol.Accessibility.AXNode.description property + +The accessible description for this `Node`. + +Signature: + +```typescript +description?: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.ignored.md b/new-docs/puppeteer.protocol.accessibility.axnode.ignored.md new file mode 100644 index 0000000000000..9593d5438e6ed --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.ignored.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md) + +## Protocol.Accessibility.AXNode.ignored property + +Whether this node is ignored for accessibility + +Signature: + +```typescript +ignored: boolean; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.ignoredreasons.md b/new-docs/puppeteer.protocol.accessibility.axnode.ignoredreasons.md new file mode 100644 index 0000000000000..a91710902da3f --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.ignoredreasons.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md) + +## Protocol.Accessibility.AXNode.ignoredReasons property + +Collection of reasons why this node is hidden. + +Signature: + +```typescript +ignoredReasons?: AXProperty[]; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.md b/new-docs/puppeteer.protocol.accessibility.axnode.md new file mode 100644 index 0000000000000..d26b4fb6f6beb --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) + +## Protocol.Accessibility.AXNode interface + +A node in the accessibility tree. + +Signature: + +```typescript +export interface AXNode +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The backend ID for the associated DOM node, if any. | +| [childIds](./puppeteer.protocol.accessibility.axnode.childids.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md)\[\] | IDs for each of this node's child nodes. | +| [description](./puppeteer.protocol.accessibility.axnode.description.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible description for this Node. | +| [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md) | boolean | Whether this node is ignored for accessibility | +| [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)\[\] | Collection of reasons why this node is hidden. | +| [name](./puppeteer.protocol.accessibility.axnode.name.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible name for this Node. | +| [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md) | Unique identifier for this node. | +| [properties](./puppeteer.protocol.accessibility.axnode.properties.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)\[\] | All other properties | +| [role](./puppeteer.protocol.accessibility.axnode.role.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | This Node's role, whether explicit or implicit. | +| [value](./puppeteer.protocol.accessibility.axnode.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value for this Node. | + diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.name.md b/new-docs/puppeteer.protocol.accessibility.axnode.name.md new file mode 100644 index 0000000000000..6600291aa859b --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [name](./puppeteer.protocol.accessibility.axnode.name.md) + +## Protocol.Accessibility.AXNode.name property + +The accessible name for this `Node`. + +Signature: + +```typescript +name?: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md b/new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md new file mode 100644 index 0000000000000..d362a6c9602f2 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md) + +## Protocol.Accessibility.AXNode.nodeId property + +Unique identifier for this node. + +Signature: + +```typescript +nodeId: AXNodeId; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.properties.md b/new-docs/puppeteer.protocol.accessibility.axnode.properties.md new file mode 100644 index 0000000000000..2b4f210ab8fd6 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.properties.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [properties](./puppeteer.protocol.accessibility.axnode.properties.md) + +## Protocol.Accessibility.AXNode.properties property + +All other properties + +Signature: + +```typescript +properties?: AXProperty[]; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.role.md b/new-docs/puppeteer.protocol.accessibility.axnode.role.md new file mode 100644 index 0000000000000..c5ae2315e042d --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.role.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [role](./puppeteer.protocol.accessibility.axnode.role.md) + +## Protocol.Accessibility.AXNode.role property + +This `Node`'s role, whether explicit or implicit. + +Signature: + +```typescript +role?: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnode.value.md b/new-docs/puppeteer.protocol.accessibility.axnode.value.md new file mode 100644 index 0000000000000..c358a367c49f4 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnode.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [value](./puppeteer.protocol.accessibility.axnode.value.md) + +## Protocol.Accessibility.AXNode.value property + +The value for this `Node`. + +Signature: + +```typescript +value?: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axnodeid.md b/new-docs/puppeteer.protocol.accessibility.axnodeid.md new file mode 100644 index 0000000000000..b94b250ca08c7 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axnodeid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md) + +## Protocol.Accessibility.AXNodeId type + +Unique accessibility node identifier. + +Signature: + +```typescript +export type AXNodeId = string; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axproperty.md b/new-docs/puppeteer.protocol.accessibility.axproperty.md new file mode 100644 index 0000000000000..a65767ec7a8b4 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axproperty.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) + +## Protocol.Accessibility.AXProperty interface + +Signature: + +```typescript +export interface AXProperty +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [name](./puppeteer.protocol.accessibility.axproperty.name.md) | [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md) | The name of this property. | +| [value](./puppeteer.protocol.accessibility.axproperty.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of this property. | + diff --git a/new-docs/puppeteer.protocol.accessibility.axproperty.name.md b/new-docs/puppeteer.protocol.accessibility.axproperty.name.md new file mode 100644 index 0000000000000..8c656d53a3fd0 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axproperty.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) > [name](./puppeteer.protocol.accessibility.axproperty.name.md) + +## Protocol.Accessibility.AXProperty.name property + +The name of this property. + +Signature: + +```typescript +name: AXPropertyName; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axproperty.value.md b/new-docs/puppeteer.protocol.accessibility.axproperty.value.md new file mode 100644 index 0000000000000..b853425f04431 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axproperty.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) > [value](./puppeteer.protocol.accessibility.axproperty.value.md) + +## Protocol.Accessibility.AXProperty.value property + +The value of this property. + +Signature: + +```typescript +value: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axpropertyname.md b/new-docs/puppeteer.protocol.accessibility.axpropertyname.md new file mode 100644 index 0000000000000..abd54961ecb59 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axpropertyname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md) + +## Protocol.Accessibility.AXPropertyName type + +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. + +Signature: + +```typescript +export type AXPropertyName = ('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'); +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md b/new-docs/puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md new file mode 100644 index 0000000000000..45ffb0fab37b9 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md) + +## Protocol.Accessibility.AXRelatedNode.backendDOMNodeId property + +The BackendNodeId of the related DOM node. + +Signature: + +```typescript +backendDOMNodeId: DOM.BackendNodeId; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axrelatednode.idref.md b/new-docs/puppeteer.protocol.accessibility.axrelatednode.idref.md new file mode 100644 index 0000000000000..747eae8d9eb79 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axrelatednode.idref.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md) + +## Protocol.Accessibility.AXRelatedNode.idref property + +The IDRef value provided, if any. + +Signature: + +```typescript +idref?: string; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axrelatednode.md b/new-docs/puppeteer.protocol.accessibility.axrelatednode.md new file mode 100644 index 0000000000000..7b36aa44696da --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axrelatednode.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) + +## Protocol.Accessibility.AXRelatedNode interface + +Signature: + +```typescript +export interface AXRelatedNode +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The BackendNodeId of the related DOM node. | +| [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md) | string | The IDRef value provided, if any. | +| [text](./puppeteer.protocol.accessibility.axrelatednode.text.md) | string | The text alternative of this node in the current context. | + diff --git a/new-docs/puppeteer.protocol.accessibility.axrelatednode.text.md b/new-docs/puppeteer.protocol.accessibility.axrelatednode.text.md new file mode 100644 index 0000000000000..fdef94d5fe329 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axrelatednode.text.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [text](./puppeteer.protocol.accessibility.axrelatednode.text.md) + +## Protocol.Accessibility.AXRelatedNode.text property + +The text alternative of this node in the current context. + +Signature: + +```typescript +text?: string; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvalue.md b/new-docs/puppeteer.protocol.accessibility.axvalue.md new file mode 100644 index 0000000000000..cb30641587449 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvalue.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) + +## Protocol.Accessibility.AXValue interface + +A single computed AX property. + +Signature: + +```typescript +export interface AXValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [relatedNodes](./puppeteer.protocol.accessibility.axvalue.relatednodes.md) | [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md)\[\] | One or more related nodes, if applicable. | +| [sources](./puppeteer.protocol.accessibility.axvalue.sources.md) | [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md)\[\] | The sources which contributed to the computation of this property. | +| [type](./puppeteer.protocol.accessibility.axvalue.type.md) | [AXValueType](./puppeteer.protocol.accessibility.axvaluetype.md) | The type of this value. | +| [value](./puppeteer.protocol.accessibility.axvalue.value.md) | any | The computed value of this property. | + diff --git a/new-docs/puppeteer.protocol.accessibility.axvalue.relatednodes.md b/new-docs/puppeteer.protocol.accessibility.axvalue.relatednodes.md new file mode 100644 index 0000000000000..d477960d0bc11 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvalue.relatednodes.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [relatedNodes](./puppeteer.protocol.accessibility.axvalue.relatednodes.md) + +## Protocol.Accessibility.AXValue.relatedNodes property + +One or more related nodes, if applicable. + +Signature: + +```typescript +relatedNodes?: AXRelatedNode[]; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvalue.sources.md b/new-docs/puppeteer.protocol.accessibility.axvalue.sources.md new file mode 100644 index 0000000000000..8de5c58f33d1c --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvalue.sources.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [sources](./puppeteer.protocol.accessibility.axvalue.sources.md) + +## Protocol.Accessibility.AXValue.sources property + +The sources which contributed to the computation of this property. + +Signature: + +```typescript +sources?: AXValueSource[]; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvalue.type.md b/new-docs/puppeteer.protocol.accessibility.axvalue.type.md new file mode 100644 index 0000000000000..a5867b161a8bb --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvalue.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [type](./puppeteer.protocol.accessibility.axvalue.type.md) + +## Protocol.Accessibility.AXValue.type property + +The type of this value. + +Signature: + +```typescript +type: AXValueType; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvalue.value.md b/new-docs/puppeteer.protocol.accessibility.axvalue.value.md new file mode 100644 index 0000000000000..c91483afc313d --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvalue.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [value](./puppeteer.protocol.accessibility.axvalue.value.md) + +## Protocol.Accessibility.AXValue.value property + +The computed value of this property. + +Signature: + +```typescript +value?: any; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluenativesourcetype.md b/new-docs/puppeteer.protocol.accessibility.axvaluenativesourcetype.md new file mode 100644 index 0000000000000..1753c27dfa91b --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluenativesourcetype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueNativeSourceType](./puppeteer.protocol.accessibility.axvaluenativesourcetype.md) + +## Protocol.Accessibility.AXValueNativeSourceType type + +Enum of possible native property sources (as a subtype of a particular AXValueSourceType). + +Signature: + +```typescript +export type AXValueNativeSourceType = ('figcaption' | 'label' | 'labelfor' | 'labelwrapped' | 'legend' | 'tablecaption' | 'title' | 'other'); +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluesource.attribute.md b/new-docs/puppeteer.protocol.accessibility.axvaluesource.attribute.md new file mode 100644 index 0000000000000..4e977a08642ec --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluesource.attribute.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [attribute](./puppeteer.protocol.accessibility.axvaluesource.attribute.md) + +## Protocol.Accessibility.AXValueSource.attribute property + +The name of the relevant attribute, if any. + +Signature: + +```typescript +attribute?: string; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluesource.attributevalue.md b/new-docs/puppeteer.protocol.accessibility.axvaluesource.attributevalue.md new file mode 100644 index 0000000000000..9d0156064bf7d --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluesource.attributevalue.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [attributeValue](./puppeteer.protocol.accessibility.axvaluesource.attributevalue.md) + +## Protocol.Accessibility.AXValueSource.attributeValue property + +The value of the relevant attribute, if any. + +Signature: + +```typescript +attributeValue?: AXValue; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalid.md b/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalid.md new file mode 100644 index 0000000000000..1b5dcb72ef519 --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [invalid](./puppeteer.protocol.accessibility.axvaluesource.invalid.md) + +## Protocol.Accessibility.AXValueSource.invalid property + +Whether the value for this property is invalid. + +Signature: + +```typescript +invalid?: boolean; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalidreason.md b/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalidreason.md new file mode 100644 index 0000000000000..3f5b959ff0afb --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluesource.invalidreason.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [invalidReason](./puppeteer.protocol.accessibility.axvaluesource.invalidreason.md) + +## Protocol.Accessibility.AXValueSource.invalidReason property + +Reason for the value being invalid, if it is. + +Signature: + +```typescript +invalidReason?: string; +``` diff --git a/new-docs/puppeteer.protocol.accessibility.axvaluesource.md b/new-docs/puppeteer.protocol.accessibility.axvaluesource.md new file mode 100644 index 0000000000000..a9f1785772acd --- /dev/null +++ b/new-docs/puppeteer.protocol.accessibility.axvaluesource.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) + +## Protocol.Accessibility.AXValueSource interface + +A single source for a computed AX property. + +Signature: + +```typescript +export interface AXValueSource +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [attribute](./puppeteer.protocol.accessibility.axvaluesource.attribute.md) | string | The name of the relevant attribute, if any. | +| [attributeValue](./puppeteer.protocol.accessibility.axvaluesource.attributevalue.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of the relevant attribute, if any. | +| [invalid](./puppeteer.protocol.accessibility.axvaluesource.invalid.md) | boolean | Whether the value for this property is invalid. | +| [invalidReason](./puppeteer.protocol.accessibility.axvaluesource.invalidreason.md) | string | Reason for the value being invalid, if it is. | +| [nativeSource](./puppeteer.protocol.accessibility.axvaluesource.nativesource.md) | [AXValueNativeSourceType](./puppeteer.protocol.accessibility.axvaluenativesourcetype.md) | The native markup source for this value, e.g. a