@puppeteer/replay / Schema / WaitForElementStep
Schema.WaitForElementStep
waitForElement
allows waiting for the presence (or absence) of the number
of elements identified by the selector.
For example, the following step would wait for less than three elements
to be on the page that match the selector .my-class
.
{
"type": "waitForElement",
"selectors": [".my-class"],
"operator": "<=",
"count": 2,
}
-
↳
WaitForElementStep
• Optional
assertedEvents: NavigationEvent
[]
StepWithSelectors.assertedEvents
• Optional
attributes: Object
Whether to also check the element(s) for the given attributes.
▪ [name: string
]: string
• Optional
count: number
Default Value
1
• Optional
frame: FrameSelector
Defaults to main frame
• Optional
operator: ">="
| "=="
| "<="
Default Value
'=='
• Optional
properties: Partial
<JSONSerializable
<HTMLElement
>> & { [key: string]
: JSONValue
; }
Whether to also check the element(s) for the given properties.
• 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.
• Optional
target: string
Defaults to main
• Optional
timeout: number
• type: WaitForElement
• Optional
visible: boolean
Whether to wait for elements matching this step to be hidden. This can be thought of as an inversion of this step.
Default Value
true