ElementHandle
Added in: v1.8Extends: JSHandle
- extends: JSHandle
ElementHandle represents an in-page DOM element. ElementHandles can be created with the Page.QuerySelectorAsync() method.
:::warning[Discouraged]
The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead. :::
var handle = await page.QuerySelectorAsync("a");
await handle.ClickAsync();ElementHandle prevents DOM element from garbage collection unless the handle is disposed with JsHandle.DisposeAsync(). ElementHandles are auto-disposed when their origin frame gets navigated.
ElementHandle instances can be used as an argument in Page.EvalOnSelectorAsync() and Page.EvaluateAsync() methods.
The difference between the Locator and ElementHandle is that the ElementHandle points to a particular element, while Locator captures the logic of how to retrieve an element.
In the example below, handle points to a particular DOM element on page. If that element changes text or is used by React to render an entirely different component, handle is still pointing to that very DOM element. This can lead to unexpected behaviors.
var handle = await page.QuerySelectorAsync("text=Submit");
await handle.HoverAsync();
await handle.ClickAsync();With the locator, every time the element is used, up-to-date DOM element is located in the page using the selector. So in the snippet below, underlying DOM element is going to be located twice.
var locator = page.GetByText("Submit");
await locator.HoverAsync();
await locator.ClickAsync();Methods
ElementHandle.AsElement()
Added in: v1.8Returns either null or the object handle itself, if the object handle is an instance of ElementHandle.
Returns
null | ElementHandle
ElementHandle.BoundingBoxAsync()
Added in: v1.8This method returns the bounding box of the element, or null if the element is not visible. The bounding box is calculated relative to the main frame viewport - which is usually the same as the browser window.
Scrolling affects the returned bounding box, similarly to Element.getBoundingClientRect. That means x and/or y may be negative.
Elements from child frames return the bounding box relative to the main frame, unlike the Element.getBoundingClientRect.
Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following snippet should click the center of the element.
Usage
var box = await elementHandle.BoundingBoxAsync();
await page.Mouse.ClickAsync(box.X + box.Width / 2, box.Y + box.Height / 2);Returns
null | Object
ElementHandle.CheckAsync()
Added in: v1.8Discouraged
Use locator-based Locator.CheckAsync() instead. Read more about locators.
This method checks the element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now checked. If not, this method throws.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
positionObject(optional) Added in: v1.11A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatAdded in: v1.11yfloatAdded in: v1.11
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.ClickAsync()
Added in: v1.8Discouraged
Use locator-based Locator.ClickAsync() instead. Read more about locators.
This method clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element, or the specifiedposition. - Wait for initiated navigations to either succeed or fail, unless
noWaitAfteroption is set.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
button"left" | "right" | "middle"(optional)Defaults to
left.defaults to 1. See [UIEvent.detail].
Time to wait between
mousedownandmouseupin milliseconds. Defaults to 0.Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift">(optional)Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfterboolean(optional)Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to
false.A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.stepsint(optional) Added in: v1.57Defaults to 1. Sends
ninterpolatedmousemoveevents to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a singlemousemoveevent at the destination location.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.ContentFrameAsync()
Added in: v1.8Returns the content frame for element handles referencing iframe nodes, or null otherwise
Returns
null | Frame
ElementHandle.DblClickAsyncAsync()
Added in: v1.8Discouraged
Use locator-based Locator.DblClickAsyncAsync() instead. Read more about locators.
This method double clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto double click in the center of the element, or the specifiedposition.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
INFO
elementHandle.dblclick() dispatches two click events and a single dblclick event.
Arguments
button"left" | "right" | "middle"(optional)Defaults to
left.Time to wait between
mousedownandmouseupin milliseconds. Defaults to 0.Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift">(optional)Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfterboolean(optional)This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.stepsint(optional) Added in: v1.57Defaults to 1. Sends
ninterpolatedmousemoveevents to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a singlemousemoveevent at the destination location.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.DispatchEventAsync()
Added in: v1.8Discouraged
Use locator-based Locator.DispatchEventAsync() instead. Read more about locators.
The snippet below dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().
Usage
await elementHandle.DispatchEventAsync("click");Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default.
Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:
- DeviceMotionEvent
- DeviceOrientationEvent
- DragEvent
- Event
- FocusEvent
- KeyboardEvent
- MouseEvent
- PointerEvent
- TouchEvent
- WheelEvent
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
var dataTransfer = await page.EvaluateHandleAsync("() => new DataTransfer()");
await elementHandle.DispatchEventAsync("dragstart", new Dictionary<string, object>
{
{ "dataTransfer", dataTransfer }
});Arguments
DOM event type:
"click","dragstart", etc.eventInitEvaluationArgument(optional)Optional event-specific initialization properties.
ElementHandle.DisposeAsync()
Added in: v1.8The jsHandle.dispose method stops referencing the element handle.
ElementHandle.EvalOnSelectorAsync()
Added in: v1.9Discouraged
This method does not wait for the element to pass actionability↵checks and therefore can lead to the flaky tests. Use Locator.EvaluateAsync(),↵other Locator helper methods or web-first assertions instead.
Returns the return value of expression.
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a first argument to expression. If no elements match the selector, the method throws an error.
If expression returns a [Promise], then ElementHandle.EvalOnSelectorAsync() would wait for the promise to resolve and return its value.
Usage
var tweetHandle = await page.QuerySelectorAsync(".tweet");
Assert.AreEqual("100", await tweetHandle.EvalOnSelectorAsync(".like", "node => node.innerText"));
Assert.AreEqual("10", await tweetHandle.EvalOnSelectorAsync(".retweets", "node => node.innerText"));Arguments
A selector to query for.
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
Serializable
ElementHandle.EvalOnSelectorAllAsync()
Added in: v1.9Discouraged
In most cases, Locator.EvaluateAllAsync(),↵other Locator helper methods and web-first assertions do a better job.
Returns the return value of expression.
The method finds all elements matching the specified selector in the ElementHandle's subtree and passes an array of matched elements as a first argument to expression.
If expression returns a [Promise], then ElementHandle.EvalOnSelectorAllAsync() would wait for the promise to resolve and return its value.
Usage
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>var feedHandle = await page.QuerySelectorAsync(".feed");
Assert.AreEqual(new [] { "Hello!", "Hi!" }, await feedHandle.EvalOnSelectorAllAsync<string[]>(".tweet", "nodes => nodes.map(n => n.innerText)"));Arguments
A selector to query for.
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
Serializable
ElementHandle.EvaluateAsync()
Added in: v1.8Returns the return value of expression.
This method passes this handle as the first argument to expression.
If expression returns a [Promise], then handle.evaluate would wait for the promise to resolve and return its value.
Usage
var tweetHandle = await page.QuerySelectorAsync(".tweet .retweets");
Assert.AreEqual("10 retweets", await tweetHandle.EvaluateAsync("node => node.innerText"));Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
Serializable
ElementHandle.EvaluateHandleAsync()
Added in: v1.8Returns the return value of expression as a JSHandle.
This method passes this handle as the first argument to expression.
The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle returns JSHandle.
If the function passed to the jsHandle.evaluateHandle returns a [Promise], then jsHandle.evaluateHandle would wait for the promise to resolve and return its value.
See Page.EvaluateHandleAsync() for more details.
Arguments
JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
argEvaluationArgument(optional)Optional argument to pass to
expression.
Returns
JSHandle
ElementHandle.FillAsync()
Added in: v1.8Discouraged
Use locator-based Locator.FillAsync() instead. Read more about locators.
This method waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.
If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.
To send fine-grained keyboard events, use Locator.PressSequentiallyAsync().
Arguments
Value to set for the
<input>,<textarea>or[contenteditable]element.forceboolean(optional) Added in: v1.13Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.FocusAsync()
Added in: v1.8Discouraged
Use locator-based Locator.FocusAsync() instead. Read more about locators.
Calls focus on the element.
ElementHandle.GetAttributeAsync()
Added in: v1.8Discouraged
Use locator-based Locator.GetAttributeAsync() instead. Read more about locators.
Returns element attribute value.
Arguments
Returns
null | string
ElementHandle.GetPropertiesAsync()
Added in: v1.8The method returns a map with own property names as keys and JSHandle instances for the property values.
Usage
var handle = await page.EvaluateHandleAsync("() => ({ window, document })");
var properties = await handle.GetPropertiesAsync();
var windowHandle = properties["window"];
var documentHandle = properties["document"];
await handle.DisposeAsync();Returns
Map<string, JSHandle>
ElementHandle.GetPropertyAsync()
Added in: v1.8Fetches a single property from the referenced object.
Arguments
Returns
JSHandle
ElementHandle.HoverAsync()
Added in: v1.8Discouraged
Use locator-based Locator.HoverAsync() instead. Read more about locators.
This method hovers over the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto hover over the center of the element, or the specifiedposition.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift">(optional)Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfterboolean(optional) Added in: v1.28This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.InnerHTMLAsync()
Added in: v1.8Discouraged
Use locator-based Locator.InnerHTMLAsync() instead. Read more about locators.
Returns the element.innerHTML.
Returns
string
ElementHandle.InnerTextAsync()
Added in: v1.8Discouraged
Use locator-based Locator.InnerTextAsync() instead. Read more about locators.
Returns the element.innerText.
Returns
string
ElementHandle.InputValueAsync()
Added in: v1.13Discouraged
Use locator-based Locator.InputValueAsync() instead. Read more about locators.
Returns input.value for the selected <input> or <textarea> or <select> element.
Throws for non-input elements. However, if the element is inside the <label> element that has an associated control, returns the value of the control.
Arguments
Returns
string
ElementHandle.IsCheckedAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsCheckedAsync() instead. Read more about locators.
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
Returns
boolean
ElementHandle.IsDisabledAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsDisabledAsync() instead. Read more about locators.
Returns whether the element is disabled, the opposite of enabled.
Returns
boolean
ElementHandle.IsEditableAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsEditableAsync() instead. Read more about locators.
Returns whether the element is editable.
Returns
boolean
ElementHandle.IsEnabledAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsEnabledAsync() instead. Read more about locators.
Returns whether the element is enabled.
Returns
boolean
ElementHandle.IsHiddenAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsHiddenAsync() instead. Read more about locators.
Returns whether the element is hidden, the opposite of visible.
Returns
boolean
ElementHandle.IsVisibleAsync()
Added in: v1.8Discouraged
Use locator-based Locator.IsVisibleAsync() instead. Read more about locators.
Returns whether the element is visible.
Returns
boolean
ElementHandle.JsonValueAsync()
Added in: v1.8Returns a JSON representation of the object. If the object has a toJSON function, it will not be called.
INFO
The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.
Returns
Serializable
ElementHandle.OwnerFrameAsync()
Added in: v1.8Returns the frame containing the given element.
Returns
null | Frame
ElementHandle.PressAsync()
Added in: v1.8Discouraged
Use locator-based Locator.PressAsync() instead. Read more about locators.
Focuses the element, and then uses Keyboard.DownAsync() and Keyboard.UpAsync().
key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:
F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.
Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta.
Holding down Shift will type the text that corresponds to the key in the upper case.
If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.
Shortcuts such as key: "Control+o", key: "Control++ or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Arguments
Name of the key to press or a character to generate, such as
ArrowLeftora.Time to wait between
keydownandkeyupin milliseconds. Defaults to 0.noWaitAfterboolean(optional)Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to
false.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.QuerySelectorAsync()
Added in: v1.9Discouraged
Use locator-based Page.Locator() instead. Read more about locators.
The method finds an element matching the specified selector in the ElementHandle's subtree. If no elements match the selector, returns null.
Arguments
Returns
null | ElementHandle
ElementHandle.QuerySelectorAllAsync()
Added in: v1.9Discouraged
Use locator-based Page.Locator() instead. Read more about locators.
The method finds all elements matching the specified selector in the ElementHandles subtree. If no elements match the selector, returns empty array.
Arguments
Returns
Array<ElementHandle>
ElementHandle.ScreenshotAsync()
Added in: v1.8Discouraged
Use locator-based Locator.ScreenshotAsync() instead. Read more about locators.
This method captures a screenshot of the page, clipped to the size and position of this particular element. If the element is covered by other elements, it will not be actually visible on the screenshot. If the element is a scrollable container, only the currently scrolled content will be visible on the screenshot.
This method waits for the actionability checks, then scrolls element into view before taking a screenshot. If the element is detached from DOM, the method throws an error.
Returns the buffer with the captured screenshot.
Arguments
animations"disabled" | "allow"(optional)When set to
"disabled", stops CSS animations, CSS transitions and Web Animations. Animations get different treatment depending on their duration:- finite animations are fast-forwarded to completion, so they'll fire
transitionendevent. - infinite animations are canceled to initial state, and then played over after the screenshot.
Defaults to
"allow"that leaves animations untouched.- finite animations are fast-forwarded to completion, so they'll fire
caret"hide" | "initial"(optional)When set to
"hide", screenshot will hide text caret. When set to"initial", text caret behavior will not be changed. Defaults to"hide".maskArray<Locator>(optional)Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box
#FF00FF(customized bymaskColor) that completely covers its bounding box. The mask is also applied to invisible elements, see Matching only visible elements to disable that.maskColorstring(optional) Added in: v1.35Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink
#FF00FF.omitBackgroundboolean(optional)Hides default white background and allows capturing screenshots with transparency. Not applicable to
jpegimages. Defaults tofalse.The file path to save the image to. The screenshot type will be inferred from file extension. If
pathis a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk.The quality of the image, between 0-100. Not applicable to
pngimages. Forjpegthe default is80. Forwebp, a quality of100(the default) produces a lossless image, while lower values use lossy compression.scale"css" | "device"(optional)When set to
"css", screenshot will have a single pixel per each css pixel on the page. For high-dpi devices, this will keep screenshots small. Using"device"option will produce a single pixel per each device pixel, so screenshots of high-dpi devices will be twice as large or even larger.Defaults to
"device".stylestring(optional) Added in: v1.41Text of the stylesheet to apply while making the screenshot. This is where you can hide dynamic elements, make elements invisible or change their properties to help you creating repeatable screenshots. This stylesheet pierces the Shadow DOM and applies to the inner frames.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.type"png" | "jpeg" | "webp"(optional)Specify screenshot type, defaults to
png.
Returns
Buffer
ElementHandle.ScrollIntoViewIfNeededAsync()
Added in: v1.8Discouraged
Use locator-based Locator.ScrollIntoViewIfNeededAsync() instead. Read more about locators.
This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's ratio.
Throws when elementHandle does not point to an element connected to a Document or a ShadowRoot.
See scrolling for alternative ways to scroll.
Arguments
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.SelectOptionAsync()
Added in: v1.8Discouraged
Use locator-based Locator.SelectOptionAsync() instead. Read more about locators.
This method waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.
If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.
Returns the array of option values that have been successfully selected.
Triggers a change and input event once all the provided options have been selected.
Usage
// Single selection matching the value or label
await handle.SelectOptionAsync(new[] { "blue" });
// single selection matching the label
await handle.SelectOptionAsync(new[] { new SelectOptionValue() { Label = "blue" } });
// multiple selection
await handle.SelectOptionAsync(new[] { "red", "green", "blue" });
// multiple selection for blue, red and second option
await handle.SelectOptionAsync(new[] {
new SelectOptionValue() { Label = "blue" },
new SelectOptionValue() { Index = 2 },
new SelectOptionValue() { Value = "red" }});Arguments
valuesnull | string | ElementHandle | Array<string> | Object | Array<ElementHandle> | Array<Object>Options to select. If the
<select>has themultipleattribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are matching both values and labels. Option is considered matching if all specified properties match.valuestring(optional)Matches by
option.value. Optional.labelstring(optional)Matches by
option.label. Optional.indexint(optional)Matches by the index. Optional.
forceboolean(optional) Added in: v1.13Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
Array<string>
ElementHandle.SelectTextAsync()
Added in: v1.8Discouraged
Use locator-based Locator.SelectTextAsync() instead. Read more about locators.
This method waits for actionability checks, then focuses the element and selects all its text content.
If the element is inside the <label> element that has an associated control, focuses and selects text in the control instead.
Arguments
forceboolean(optional) Added in: v1.13Whether to bypass the actionability checks. Defaults to
false.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.SetCheckedAsync()
Added in: v1.15Discouraged
Use locator-based Locator.SetCheckedAsync() instead. Read more about locators.
This method checks or unchecks an element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method throws.
- If the element already has the right checked state, this method returns immediately.
- Wait for actionability checks on the matched element, unless
forceoption is set. If the element is detached during the checks, the whole action is retried. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now checked or unchecked. If not, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to check or uncheck the checkbox.
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.SetInputFilesAsync()
Added in: v1.8Discouraged
Use locator-based Locator.SetInputFilesAsync() instead. Read more about locators.
Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.
This method expects ElementHandle to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.
Arguments
filespath | Array<path> | Object | Array<Object>namestringFile name
mimeTypestringFile type
bufferBufferFile content
noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.TapAsync()
Added in: v1.8Discouraged
Use locator-based Locator.TapAsync() instead. Read more about locators.
This method taps the element by performing the following steps:
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Touchscreento tap the center of the element, or the specifiedposition.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
INFO
elementHandle.tap() requires that the hasTouch option of the browser context be set to true.
Arguments
Whether to bypass the actionability checks. Defaults to
false.modifiersArray<"Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift">(optional)Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.
noWaitAfterboolean(optional)This option has no effect.
A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatyfloat
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.TextContentAsync()
Added in: v1.8Discouraged
Use locator-based Locator.TextContentAsync() instead. Read more about locators.
Returns the node.textContent.
Returns
null | string
ElementHandle.UncheckAsync()
Added in: v1.8Discouraged
Use locator-based Locator.UncheckAsync() instead. Read more about locators.
This method checks the element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
- Wait for actionability checks on the element, unless
forceoption is set. - Scroll the element into view if needed.
- Use
Page.Mouseto click in the center of the element. - Ensure that the element is now unchecked. If not, this method throws.
If the element is detached from the DOM at any moment during the action, this method throws.
When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.
Arguments
Whether to bypass the actionability checks. Defaults to
false.noWaitAfterboolean(optional)This option has no effect.
positionObject(optional) Added in: v1.11A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
xfloatAdded in: v1.11yfloatAdded in: v1.11
scroll"auto" | "none"(optional) Added in: v1.62Controls whether Playwright scrolls the element into view before performing the action. Defaults to
"auto", which scrolls the element into view when necessary, including scrolling nested scrollable containers. When set to"none", Playwright does not scroll the element and the action fails if the element is not already in the viewport. This is useful to assert that an element is reachable by the user without additional scrolling.Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.trialboolean(optional) Added in: v1.11When set, this method only performs the actionability checks and skips the action. Defaults to
false. Useful to wait until the element is ready for the action without performing it.
ElementHandle.WaitForElementStateAsync()
Added in: v1.8Returns when the element satisfies the state.
Depending on the state parameter, this method waits for one of the actionability checks to pass. This method throws when the element is detached while waiting, unless waiting for the "hidden" state.
"visible"Wait until the element is visible."hidden"Wait until the element is not visible or not attached. Note that waiting for hidden does not throw when the element detaches."stable"Wait until the element is both visible and stable."enabled"Wait until the element is enabled."disabled"Wait until the element is not enabled."editable"Wait until the element is editable.
If the element does not satisfy the condition for the timeout milliseconds, this method will throw.
Arguments
state"visible" | "hidden" | "stable" | "enabled" | "disabled" | "editable"A state to wait for, see below for more details.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
ElementHandle.WaitForSelectorAsync()
Added in: v1.8Discouraged
Use web assertions that assert visibility or a locator-based Locator.WaitForAsync() instead.
Returns element specified by selector when it satisfies state option. Returns null if waiting for hidden or detached.
Wait for the selector relative to the element handle to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.
Usage
await page.SetContentAsync("<div><span></span></div>");
var div = await page.QuerySelectorAsync("div");
// Waiting for the "span" selector relative to the div.
var span = await div.WaitForSelectorAsync("span", new() { State = WaitForSelectorState.Attached });INFO
This method does not work across navigations, use Page.WaitForSelectorAsync() instead.
Arguments
A selector to query for.
state"attached" | "detached" | "visible" | "hidden"(optional)Defaults to
'visible'. Can be either:'attached'- wait for element to be present in DOM.'detached'- wait for element to not be present in DOM.'visible'- wait for element to have non-empty bounding box and novisibility:hidden. Note that element without any content or withdisplay:nonehas an empty bounding box and is not considered visible.'hidden'- wait for element to be either detached from DOM, or have an empty bounding box orvisibility:hidden. This is opposite to the'visible'option.
strictboolean(optional) Added in: v1.15When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.
Returns
null | ElementHandle
Deprecated
ElementHandle.TypeAsync()
Added in: v1.8Deprecated
In most cases, you should use Locator.FillAsync() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use Locator.PressSequentiallyAsync().
Focuses the element, and then sends a keydown, keypress/input, and keyup event for each character in the text.
To press a special key, like Control or ArrowDown, use ElementHandle.PressAsync().
Usage
Arguments
A text to type into a focused element.
Time to wait between key presses in milliseconds. Defaults to 0.
noWaitAfterboolean(optional)This option has no effect.
Maximum time in milliseconds. Defaults to
30000(30 seconds). Pass0to disable timeout. The default value can be changed by using theBrowserContext.SetDefaultTimeout()orPage.SetDefaultTimeout()methods.