- extends: [JSHandle]
ElementHandle represents an in-page DOM element. ElementHandles can be created with the [method: Page.$] method.
const { chromium } = require('playwright'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
const hrefElement = await page.$('a');
await hrefElement.click();
// ...
})();ElementHandle prevents DOM element from garbage collection unless the handle is disposed with [method: JSHandle.dispose]. ElementHandles are auto-disposed when their origin frame gets navigated.
ElementHandle instances can be used as an argument in [method: Page.$eval] and [method: Page.evaluate] methods.
- returns: <[null]|[ElementHandle]>
The method finds an element matching the specified selector in the ElementHandle's subtree. See Working with
selectors for more details. If no elements match the selector, returns null.
- returns: <[Array]<[ElementHandle]>>
The method finds all elements matching the specified selector in the ElementHandles subtree. See Working with
selectors for more details. If no elements match the selector, returns empty array.
- returns: <[Serializable]>
Returns the return value of [param: pageFunction]
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a first
argument to [param: pageFunction]. See Working with selectors for more details. If no
elements match the selector, the method throws an error.
If [param: pageFunction] returns a [Promise], then frame.$eval would wait for the promise to resolve and return
its value.
Examples:
const tweetHandle = await page.$('.tweet');
expect(await tweetHandle.$eval('.like', node => node.innerText)).toBe('100');
expect(await tweetHandle.$eval('.retweets', node => node.innerText)).toBe('10');pageFunction<[function]([Element])>
Function to be evaluated in browser context
arg<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction]
- returns: <[Serializable]>
Returns the return value of [param: pageFunction]
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 [param: pageFunction]. See Working with selectors
for more details.
If [param: pageFunction] returns a [Promise], then frame.$$eval would wait for the promise to resolve and return
its value.
Examples:
<div class="feed">
<div class="tweet">Hello!</div>
<div class="tweet">Hi!</div>
</div>const feedHandle = await page.$('.feed');
expect(await feedHandle.$$eval('.tweet', nodes => nodes.map(n => n.innerText))).toEqual(['Hello!', 'Hi!']);pageFunction<[function]([Array]<[Element]>)>
Function to be evaluated in browser context
arg<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction]
- returns: <[null]|[Object]>
x<[float]> the x coordinate of the element in pixels.y<[float]> the y coordinate of the element in pixels.width<[float]> the width of the element in pixels.height<[float]> the height of the element in pixels.
This 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 bonding 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.
const box = await elementHandle.boundingBox();
await page.mouse.click(box.x + box.width / 2, box.y + box.height / 2);This method checks the element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.mouse] to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter] option is set. - Ensure that the element is now checked. If not, this method rejects.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
This method clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.mouse] to click in the center of the element, or the specified [option: position]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter] option is set.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
- returns: <[null]|[Frame]>
Returns the content frame for element handles referencing iframe nodes, or null otherwise
This method double clicks the element by performing the following steps:
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.mouse] to double click in the center of the element, or the specified [option: position]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter] option is set. Note that if the first click of thedblclick()triggers a navigation event, this method will reject.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
NOTE
elementHandle.dblclick()dispatches twoclickevents and a singledblclickevent.
The snippet below dispatches the click event on the element. Regardless of the visibility state of the elment, click
is dispatched. This is equivalend to calling
element.click().
await elementHandle.dispatchEvent('click');Under the hood, it creates an instance of an event based on the given [param: type], initializes it with [param: eventInit] properties and dispatches it on the element. Events are composed, cancelable and bubble by default.
Since [param: eventInit] is event-specific, please refer to the events documentation for the lists of initial
properties:
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await elementHandle.dispatchEvent('dragstart', { dataTransfer });type<[string]>
DOM event type: "click", "dragstart", etc.
eventInit<[EvaluationArgument]>
Optional event-specific initialization properties.
This method waits for actionability checks, focuses the element, fills it and triggers an input
event after filling. If the element is not an <input>, <textarea> or [contenteditable] element, this method throws
an error. Note that you can pass an empty string to clear the input field.
value<[string]>
Value to set for the <input>, <textarea> or [contenteditable] element.
Calls focus on the element.
- returns: <[null]|[string]>
Returns element attribute value.
name<[string]>
Attribute name to get the value for.
This method hovers over the element by performing the following steps:
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.mouse] to hover over the center of the element, or the specified [option: position]. - 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 rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
- returns: <[string]>
Returns the element.innerHTML.
- returns: <[string]>
Returns the element.innerText.
- returns: <[boolean]>
Returns whether the element is disabled, the opposite of enabled.
- returns: <[boolean]>
Returns whether the element is editable.
- returns: <[boolean]>
Returns whether the element is enabled.
async method: ElementHandle.isHidden
- returns: <[boolean]>
Returns whether the element is hidden, the opposite of visible.
- returns: <[boolean]>
Returns whether the element is visible.
- returns: <[null]|[Frame]>
Returns the frame containing the given element.
Focuses the element, and then uses [method: Keyboard.down] and [method: Keyboard.up].
[param: key] can specify the intended
keyboardEvent.key value or a single character to
generate the text for. A superset of the [param: 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.
Holding down Shift will type the text that corresponds to the [param: key] in the upper case.
If [param: 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" or key: "Control+Shift+T" are supported as well. When speficied with the
modifier, modifier is pressed and being held while the subsequent key is being pressed.
key<[string]>
Name of the key to press or a character to generate, such as ArrowLeft or a.
delay<[float]>
Time to wait between keydown and keyup in milliseconds. Defaults to 0.
- returns: <[Buffer]>
Returns the buffer with the captured 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.
path<[path]>
The file path to save the image to. The screenshot type will be inferred from file extension. If [option: path] is 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.
type<"png"|"jpeg">
Specify screenshot type, defaults to png.
quality<[int]>
The quality of the image, between 0-100. Not applicable to png images.
omitBackground<[boolean]>
Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images.
Defaults to false.
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.
- returns: <[Array]<[string]>>
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. If element is not a <select>
element, the method throws an error.
// single selection matching the value
handle.selectOption('blue');
// single selection matching both the value and the label
handle.selectOption({ label: 'Blue' });
// multiple selection
handle.selectOption('red', 'green', 'blue');
// multiple selection for blue, red and second option
handle.selectOption({ value: 'blue' }, { index: 2 }, 'red');This method waits for actionability checks, then focuses the element and selects all its text content.
This method expects elementHandle to point to an input
element.
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 the current working directory. For empty array, clears the selected files.
This method taps the element by performing the following steps:
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.touchscreen] to tap the center of the element, or the specified [option: position]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter] option is set.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
NOTE
elementHandle.tap()requires that thehasTouchoption of the browser context be set to true.
- returns: <[null]|[string]>
Returns the node.textContent.
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 [method: ElementHandle.press].
await elementHandle.type('Hello'); // Types instantly
await elementHandle.type('World', {delay: 100}); // Types slower, like a userAn example of typing into a text field and then submitting the form:
const elementHandle = await page.$('input');
await elementHandle.type('some text');
await elementHandle.press('Enter');text<[string]>
A text to type into a focused element.
delay<[float]>
Time to wait between key presses in milliseconds. Defaults to 0.
This method checks the element by performing the following steps:
- Ensure that element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.
- Wait for actionability checks on the element, unless [
option: force] option is set. - Scroll the element into view if needed.
- Use [
property: Page.mouse] to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter] option is set. - Ensure that the element is now unchecked. If not, this method rejects.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified [option: timeout], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
Returns when the element satisfies the [param: state].
Depending on the [param: 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 [option: timeout] milliseconds, this method will throw.
state<"visible"|"hidden"|"stable"|"enabled"|"disabled"|"editable">
A state to wait for, see below for more details.
- returns: <[null]|[ElementHandle]>
Returns element specified by selector when it satisfies [option: state] option. Returns null if waiting for hidden or
detached.
Wait for the [param: selector] relative to the element handle to satisfy [option: state] option (either
appear/disappear from dom, or become visible/hidden). If at the moment of calling the method [param: selector]
already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for
the [option: timeout] milliseconds, the function will throw.
await page.setContent(`<div><span></span></div>`);
const div = await page.$('div');
// Waiting for the 'span' selector relative to the div.
const span = await div.waitForSelector('span', { state: 'attached' });NOTE This method does not work across navigations, use [
method: Page.waitForSelector] instead.