Skip to content

Latest commit

 

History

History
133 lines (76 loc) · 3.44 KB

Schema.StepWithSelectors.md

File metadata and controls

133 lines (76 loc) · 3.44 KB

@puppeteer/replay / Schema / StepWithSelectors

Interface: StepWithSelectors

Schema.StepWithSelectors

Hierarchy

Table of contents

Properties

Properties

assertedEvents

Optional assertedEvents: NavigationEvent[]

Inherited from

StepWithFrame.assertedEvents

Defined in

Schema.ts:64


frame

Optional frame: FrameSelector

Defaults to main frame

Inherited from

StepWithFrame.frame

Defined in

Schema.ts:78


selectors

selectors: Selector[]

A list of alternative selectors that lead to selection of a single element to perform the step on. Currently, we support CSS selectors, ARIA selectors (start with 'aria/'), XPath selectors (start with xpath/) and text selectors (start with text/). Each selector could be a string or an array of strings. If it's a string, it means that the selector points directly to the target element. If it's an array, the last element is the selector for the target element and the preceding selectors point to the ancestor elements. If the parent element is a shadow root host, the subsequent selector is evaluated only against the shadow DOM of the host (i.e., parent.shadowRoot.querySelector). If the parent element is not a shadow root host, the subsequent selector is evaluated in the regular DOM (i.e., parent.querySelector).

During the execution, it's recommended that the implementation tries out all of the alternative selectors to improve reliability of the replay as some selectors might get outdated over time.

Defined in

Schema.ts:100


target

Optional target: string

Defaults to main

Inherited from

StepWithFrame.target

Defined in

Schema.ts:71


timeout

Optional timeout: number

Inherited from

StepWithFrame.timeout

Defined in

Schema.ts:63


type

type: StepType

Inherited from

StepWithFrame.type

Defined in

Schema.ts:62