Handles
Introduction
Playwright can create handles to the page DOM elements or any other objects inside the page. These handles live in the Playwright process, whereas the actual objects live in the browser. There are two types of handles:
- JSHandle to reference any JavaScript objects in the page
- ElementHandle to reference DOM elements in the page, it has extra methods that allow performing actions on the elements and asserting their properties.
Since any DOM element in the page is also a JavaScript object, any ElementHandle is a JSHandle as well.
Handles are used to perform operations on those actual objects in the page. You can evaluate on a handle, get handle properties, pass handle as an evaluation parameter, serialize page object into JSON etc. See the JSHandle class API for these and methods.
API reference
Here is the easiest way to obtain a JSHandle.
JSHandle jsHandle = page.evaluateHandle("window");
// Use jsHandle for evaluations.
Element Handles
The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead.
When ElementHandle is required, it is recommended to fetch it with the Page.waitForSelector() or Frame.waitForSelector() methods. These APIs wait for the element to be attached and visible.
// Get the element handle
JSHandle jsHandle = page.waitForSelector("#box");
ElementHandle elementHandle = jsHandle.asElement();
// Assert bounding box for the element
BoundingBox boundingBox = elementHandle.boundingBox();
assertEquals(100, boundingBox.width);
// Assert attribute for the element
String classNames = elementHandle.getAttribute("class");
assertTrue(classNames.contains("highlighted"));
Handles as parameters
Handles can be passed into the Page.evaluate() and similar methods. The following snippet creates a new array in the page, initializes it with data and returns a handle to this array into Playwright. It then uses the handle in subsequent evaluations:
// Create new array in page.
JSHandle myArrayHandle = page.evaluateHandle("() => {\n" +