puppeteer.elementhandle.md

sidebar_label
ElementHandle

ElementHandle class

ElementHandle represents an in-page DOM element.

Signature:

export declare class ElementHandle<ElementType extends Node = Element> extends JSHandle<ElementType>

Extends: JSHandle<ElementType>

Remarks

ElementHandles can be created with the Page.$() method.

import puppeteer from 'puppeteer';

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  const hrefElement = await page.$('a');
  await hrefElement.click();
  // ...
})();

ElementHandle prevents the DOM element from being garbage-collected unless the handle is disposed. ElementHandles are auto-disposed when their origin frame gets navigated.

ElementHandle instances can be used as arguments in Page.$eval() and Page.evaluate() methods.

If you're using TypeScript, ElementHandle takes a generic argument that denotes the type of element the handle is holding within. For example, if you have a handle to a <select> element, you can type it as ElementHandle<HTMLSelectElement> and you get some nicer type checks.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ElementHandle class.

Properties

Property	Modifiers	Type	Description
frame	readonly	Frame

Methods

Method	Modifiers	Description
$(selector)		Queries the current element for an element matching the given selector.
$$(selector)		Queries the current element for all elements matching the given selector.
$$eval(selector, pageFunction, args)		Runs the given function on an array of elements matching the given selector in the current element. If the given function returns a promise, then this method will wait till the promise resolves.
$eval(selector, pageFunction, args)		Runs the given function on the first element matching the given selector in the current element. If the given function returns a promise, then this method will wait till the promise resolves.
$x(expression)
asElement()
boundingBox()		This method returns the bounding box of the element (relative to the main frame), or null if the element is not visible.
boxModel()		This method returns boxes of the element, or null if the element is not visible.
click(this, options)		This method scrolls element into view if needed, and then uses Page.mouse to click in the center of the element. If the element is detached from DOM, the method throws an error.
clickablePoint(offset)		Returns the middle point within an element unless a specific offset is provided.
contentFrame()		Resolves to the content frame for element handles referencing iframe nodes, or null otherwise
drag(this, target)		This method creates and captures a dragevent from the element.
dragAndDrop(this, target, options)		This method triggers a dragenter, dragover, and drop on the element.
dragEnter(this, data)		This method creates a dragenter event on the element.
dragOver(this, data)		This method creates a dragover event on the element.
drop(this, data)		This method triggers a drop on the element.
focus()		Calls focus on the element.
hover(this)		This method scrolls element into view if needed, and then uses Page to hover over the center of the element. If the element is detached from DOM, the method throws an error.
isHidden()		Checks if an element is hidden using the same mechanism as ElementHandle.waitForSelector().
isIntersectingViewport(this, options)		Resolves to true if the element is visible in the current viewport. If an element is an SVG, we check if the svg owner element is in the viewport instead. See https://crbug.com/963246.
isVisible()		Checks if an element is visible using the same mechanism as ElementHandle.waitForSelector().
press(key, options)		Focuses the element, and then uses Keyboard.down() and Keyboard.up().
screenshot(this, options)		This method scrolls element into view if needed, and then uses Page.screenshot() to take a screenshot of the element. If the element is detached from DOM, the method throws an error.
scrollIntoView(this)		Scrolls the element into view using either the automation protocol client or by calling element.scrollIntoView.
select(values)		Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.
tap(this)		This method scrolls element into view if needed, and then uses Touchscreen.tap() to tap in the center of the element. If the element is detached from DOM, the method throws an error.
toElement(tagName)		Converts the current handle to the given element type.
touchEnd(this)
touchMove(this)
touchStart(this)
type(text, options)		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.press().
uploadFile(this, paths)		Sets the value of an input element to the given file paths.
waitForSelector(selector, options)		Wait for an element matching the given selector to appear in the current element. Unlike Frame.waitForSelector(), this method does not work across navigations or if the element is detached from DOM.
waitForXPath(xpath, options)