Skip to main content

ElementHandle

ElementHandle represents an in-page DOM element. ElementHandles can be created with the Page.querySelector() method.

Discouraged

The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead.

ElementHandle hrefElement = page.querySelector("a");
hrefElement.click();

ElementHandle prevents DOM element from garbage collection unless the handle is disposed with JSHandle.dispose(). ElementHandles are auto-disposed when their origin frame gets navigated.

ElementHandle instances can be used as an argument in Page.evalOnSelector() and Page.evaluate() 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.

ElementHandle handle = page.querySelector("text=Submit");
handle.hover();
handle.click();

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.

Locator locator = page.getByText("Submit");
locator.hover();
locator.click();

Methods​

boundingBox​

Added before v1.9 elementHandle.boundingBox

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 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

BoundingBox box = elementHandle.boundingBox();
page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);

Returns

  • null | BoundingBox#

    • x double

      the x coordinate of the element in pixels.

    • y double

      the y coordinate of the element in pixels.

    • width double

      the width of the element in pixels.

    • height double

      the height of the element in pixels.

contentFrame​

Added before v1.9 elementHandle.contentFrame

Returns the content frame for element handles referencing iframe nodes, or null otherwise

Usage

ElementHandle.contentFrame();

Returns

ownerFrame​

Added before v1.9 elementHandle.ownerFrame

Returns the frame containing the given element.

Usage

ElementHandle.ownerFrame();

Returns

waitForElementState​

Added before v1.9 elementHandle.waitForElementState

Returns 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 setTimeout milliseconds, this method will throw.

Usage

ElementHandle.waitForElementState(state);
ElementHandle.waitForElementState(state, options);

Arguments

  • state enum ElementState { VISIBLE, HIDDEN, STABLE, ENABLED, DISABLED, EDITABLE }#

    A state to wait for, see below for more details.

  • options ElementHandle.WaitForElementStateOptions (optional)

Returns

Deprecated​

check​

Added before v1.9 elementHandle.check
Discouraged

Use locator-based Locator.check() instead. Read more about locators.

This method checks the element by performing the following steps:

  1. 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.
  2. Wait for actionability checks on the element, unless setForce option is set.
  3. Scroll the element into view if needed.
  4. Use Page.mouse() to click in the center of the element.
  5. 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

ElementHandle.check();
ElementHandle.check(options);

Arguments

  • options ElementHandle.CheckOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional) Added in: v1.11#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

click​

Added before v1.9 elementHandle.click
Discouraged

Use locator-based Locator.click() instead. Read more about locators.

This method clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless setForce option is set.
  2. Scroll the element into view if needed.
  3. Use Page.mouse() to click in the center of the element, or the specified setPosition.
  4. Wait for initiated navigations to either succeed or fail, unless setNoWaitAfter option 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

ElementHandle.click();
ElementHandle.click(options);

Arguments

  • options ElementHandle.ClickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setClickCount int (optional)#

      defaults to 1. See UIEvent.detail.

    • setDelay double (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { 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.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option will default to true in the future.

      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.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

dblclick​

Added before v1.9 elementHandle.dblclick
Discouraged

Use locator-based Locator.dblclick() instead. Read more about locators.

This method double clicks the element by performing the following steps:

  1. Wait for actionability checks on the element, unless setForce option is set.
  2. Scroll the element into view if needed.
  3. Use Page.mouse() to double click in the center of the element, or the specified setPosition.

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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

elementHandle.dblclick() dispatches two click events and a single dblclick event.

Usage

ElementHandle.dblclick();
ElementHandle.dblclick(options);

Arguments

  • options ElementHandle.DblclickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setDelay double (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { 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.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

dispatchEvent​

Added before v1.9 elementHandle.dispatchEvent
Discouraged

Use locator-based Locator.dispatchEvent() 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

elementHandle.dispatchEvent("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:

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
JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
elementHandle.dispatchEvent("dragstart", arg);

Arguments

  • type String#

    DOM event type: "click", "dragstart", etc.

  • eventInit EvaluationArgument (optional)#

    Optional event-specific initialization properties.

Returns

evalOnSelector​

Added in: v1.9 elementHandle.evalOnSelector
Discouraged

This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use Locator.evaluate(), 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.evalOnSelector() would wait for the promise to resolve and return its value.

Usage

ElementHandle tweetHandle = page.querySelector(".tweet");
assertEquals("100", tweetHandle.evalOnSelector(".like", "node => node.innerText"));
assertEquals("10", tweetHandle.evalOnSelector(".retweets", "node => node.innerText"));

Arguments

  • selector String#

    A selector to query for.

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

Returns

evalOnSelectorAll​

Added in: v1.9 elementHandle.evalOnSelectorAll
Discouraged

In most cases, Locator.evaluateAll(), 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.evalOnSelectorAll() 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>
ElementHandle feedHandle = page.querySelector(".feed");
assertEquals(Arrays.asList("Hello!", "Hi!"), feedHandle.evalOnSelectorAll(".tweet", "nodes => nodes.map(n => n.innerText)"));

Arguments

  • selector String#

    A selector to query for.

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

Returns

fill​

Added before v1.9 elementHandle.fill
Discouraged

Use locator-based Locator.fill() 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.pressSequentially().

Usage

ElementHandle.fill(value);
ElementHandle.fill(value, options);

Arguments

  • value String#

    Value to set for the <input>, <textarea> or [contenteditable] element.

  • options ElementHandle.FillOptions (optional)

Returns

focus​

Added before v1.9 elementHandle.focus
Discouraged

Use locator-based Locator.focus() instead. Read more about locators.

Calls focus on the element.

Usage

ElementHandle.focus();

Returns

getAttribute​

Added before v1.9 elementHandle.getAttribute
Discouraged

Use locator-based Locator.getAttribute() instead. Read more about locators.

Returns element attribute value.

Usage

ElementHandle.getAttribute(name);

Arguments

  • name String#

    Attribute name to get the value for.

Returns

hover​

Added before v1.9 elementHandle.hover
Discouraged

Use locator-based Locator.hover() instead. Read more about locators.

This method hovers over the element by performing the following steps:

  1. Wait for actionability checks on the element, unless setForce option is set.
  2. Scroll the element into view if needed.
  3. Use Page.mouse() to hover over the center of the element, or the specified setPosition.

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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

ElementHandle.hover();
ElementHandle.hover(options);

Arguments

  • options ElementHandle.HoverOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { 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.

    • setNoWaitAfter boolean (optional) Added in: v1.28#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

innerHTML​

Added before v1.9 elementHandle.innerHTML
Discouraged

Use locator-based Locator.innerHTML() instead. Read more about locators.

Returns the element.innerHTML.

Usage

ElementHandle.innerHTML();

Returns

innerText​

Added before v1.9 elementHandle.innerText
Discouraged

Use locator-based Locator.innerText() instead. Read more about locators.

Returns the element.innerText.

Usage

ElementHandle.innerText();

Returns

inputValue​

Added in: v1.13 elementHandle.inputValue
Discouraged

Use locator-based Locator.inputValue() 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.

Usage

ElementHandle.inputValue();
ElementHandle.inputValue(options);

Arguments

Returns

isChecked​

Added before v1.9 elementHandle.isChecked
Discouraged

Use locator-based Locator.isChecked() instead. Read more about locators.

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

Usage

ElementHandle.isChecked();

Returns

isDisabled​

Added before v1.9 elementHandle.isDisabled
Discouraged

Use locator-based Locator.isDisabled() instead. Read more about locators.

Returns whether the element is disabled, the opposite of enabled.

Usage

ElementHandle.isDisabled();

Returns

isEditable​

Added before v1.9 elementHandle.isEditable
Discouraged

Use locator-based Locator.isEditable() instead. Read more about locators.

Returns whether the element is editable.

Usage

ElementHandle.isEditable();

Returns

isEnabled​

Added before v1.9 elementHandle.isEnabled
Discouraged

Use locator-based Locator.isEnabled() instead. Read more about locators.

Returns whether the element is enabled.

Usage

ElementHandle.isEnabled();

Returns

isHidden​

Added before v1.9 elementHandle.isHidden
Discouraged

Use locator-based Locator.isHidden() instead. Read more about locators.

Returns whether the element is hidden, the opposite of visible.

Usage

ElementHandle.isHidden();

Returns

isVisible​

Added before v1.9 elementHandle.isVisible
Discouraged

Use locator-based Locator.isVisible() instead. Read more about locators.

Returns whether the element is visible.

Usage

ElementHandle.isVisible();

Returns

press​

Added before v1.9 elementHandle.press
Discouraged

Use locator-based Locator.press() instead. Read more about locators.

Focuses the element, and then uses Keyboard.down() and Keyboard.up().

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.

Usage

ElementHandle.press(key);
ElementHandle.press(key, options);

Arguments

  • key String#

    Name of the key to press or a character to generate, such as ArrowLeft or a.

  • options ElementHandle.PressOptions (optional)

    • setDelay double (optional)#

      Time to wait between keydown and keyup in milliseconds. Defaults to 0.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option will default to true in the future.

      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.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

querySelector​

Added in: v1.9 elementHandle.querySelector
Discouraged

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.

Usage

ElementHandle.querySelector(selector);

Arguments

  • selector String#

    A selector to query for.

Returns

querySelectorAll​

Added in: v1.9 elementHandle.querySelectorAll
Discouraged

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.

Usage

ElementHandle.querySelectorAll(selector);

Arguments

  • selector String#

    A selector to query for.

Returns

screenshot​

Added before v1.9 elementHandle.screenshot
Discouraged

Use locator-based Locator.screenshot() 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.

Usage

ElementHandle.screenshot();
ElementHandle.screenshot(options);

Arguments

  • options ElementHandle.ScreenshotOptions (optional)

    • setAnimations enum ScreenshotAnimations { 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 transitionend event.
      • infinite animations are canceled to initial state, and then played over after the screenshot.

      Defaults to "allow" that leaves animations untouched.

    • setCaret enum ScreenshotCaret { 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".

    • setMask List<Locator> (optional)#

      Specify locators that should be masked when the screenshot is taken. Masked elements will be overlaid with a pink box #FF00FF (customized by setMaskColor) that completely covers its bounding box.

    • setMaskColor String (optional) Added in: v1.35#

      Specify the color of the overlay box for masked elements, in CSS color format. Default color is pink #FF00FF.

    • setOmitBackground boolean (optional)#

      Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.

    • setPath Path (optional)#

      The file path to save the image to. The screenshot type will be inferred from file extension. If setPath 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.

    • setQuality int (optional)#

      The quality of the image, between 0-100. Not applicable to png images.

    • setScale enum ScreenshotScale { 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".

    • setStyle String (optional) Added in: v1.41#

      Text 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.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setType enum ScreenshotType { PNG, JPEG } (optional)#

      Specify screenshot type, defaults to png.

Returns

scrollIntoViewIfNeeded​

Added before v1.9 elementHandle.scrollIntoViewIfNeeded
Discouraged

Use locator-based Locator.scrollIntoViewIfNeeded() 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.

Usage

ElementHandle.scrollIntoViewIfNeeded();
ElementHandle.scrollIntoViewIfNeeded(options);

Arguments

Returns

selectOption​

Added before v1.9 elementHandle.selectOption
Discouraged

Use locator-based Locator.selectOption() 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
handle.selectOption("blue");
// single selection matching the label
handle.selectOption(new SelectOption().setLabel("Blue"));
// multiple selection
handle.selectOption(new String[] {"red", "green", "blue"});

Arguments

  • values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue String (optional)

      Matches by option.value. Optional.

    • setLabel String (optional)

      Matches by option.label. Optional.

    • setIndex int (optional)

      Matches by the index. Optional.

    Options to select. If the <select> has the multiple attribute, 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.
  • options ElementHandle.SelectOptionOptions (optional)

Returns

selectText​

Added before v1.9 elementHandle.selectText
Discouraged

Use locator-based Locator.selectText() 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.

Usage

ElementHandle.selectText();
ElementHandle.selectText(options);

Arguments

Returns

setChecked​

Added in: v1.15 elementHandle.setChecked
Discouraged

Use locator-based Locator.setChecked() instead. Read more about locators.

This method checks or unchecks an element by performing the following steps:

  1. Ensure that element is a checkbox or a radio input. If not, this method throws.
  2. If the element already has the right checked state, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless setForce option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use Page.mouse() to click in the center of the element.
  6. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

ElementHandle.setChecked(checked);
ElementHandle.setChecked(checked, options);

Arguments

  • checked boolean#

    Whether to check or uncheck the checkbox.

  • options ElementHandle.SetCheckedOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional)#

      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.

Returns

setInputFiles​

Added before v1.9 elementHandle.setInputFiles
Discouraged

Use locator-based Locator.setInputFiles() 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.

Usage

ElementHandle.setInputFiles(files);
ElementHandle.setInputFiles(files, options);

Arguments

  • files Path | Path[] | FilePayload | FilePayload[]#
  • options ElementHandle.SetInputFilesOptions (optional)

Returns

tap​

Added before v1.9 elementHandle.tap
Discouraged

Use locator-based Locator.tap() instead. Read more about locators.

This method taps the element by performing the following steps:

  1. Wait for actionability checks on the element, unless setForce option is set.
  2. Scroll the element into view if needed.
  3. Use Page.touchscreen() to tap the center of the element, or the specified setPosition.

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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

elementHandle.tap() requires that the hasTouch option of the browser context be set to true.

Usage

ElementHandle.tap();
ElementHandle.tap(options);

Arguments

  • options ElementHandle.TapOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { 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.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

textContent​

Added before v1.9 elementHandle.textContent
Discouraged

Use locator-based Locator.textContent() instead. Read more about locators.

Returns the node.textContent.

Usage

ElementHandle.textContent();

Returns

type​

Added before v1.9 elementHandle.type
Deprecated

In most cases, you should use Locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use Locator.pressSequentially().

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().

Usage

Arguments

  • text String#

    A text to type into a focused element.

  • options ElementHandle.TypeOptions (optional)

    • setDelay double (optional)#

      Time to wait between key presses in milliseconds. Defaults to 0.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

uncheck​

Added before v1.9 elementHandle.uncheck
Discouraged

Use locator-based Locator.uncheck() instead. Read more about locators.

This method checks the element by performing the following steps:

  1. 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.
  2. Wait for actionability checks on the element, unless setForce option is set.
  3. Scroll the element into view if needed.
  4. Use Page.mouse() to click in the center of the element.
  5. 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

ElementHandle.uncheck();
ElementHandle.uncheck(options);

Arguments

  • options ElementHandle.UncheckOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional) Added in: v1.11#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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.

Returns

waitForSelector​

Added before v1.9 elementHandle.waitForSelector
Discouraged

Use web assertions that assert visibility or a locator-based Locator.waitFor() instead.

Returns element specified by selector when it satisfies setState option. Returns null if waiting for hidden or detached.

Wait for the selector relative to the element handle to satisfy setState 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 setTimeout milliseconds, the function will throw.

Usage

page.setContent("<div><span></span></div>");
ElementHandle div = page.querySelector("div");
// Waiting for the "span" selector relative to the div.
ElementHandle span = div.waitForSelector("span", new ElementHandle.WaitForSelectorOptions()
  .setState(WaitForSelectorState.ATTACHED));
note

This method does not work across navigations, use Page.waitForSelector() instead.

Arguments

  • selector String#

    A selector to query for.

  • options ElementHandle.WaitForSelectorOptions (optional)

    • setState enum WaitForSelectorState { 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 no visibility:hidden. Note that element without any content or with display:none has 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 or visibility:hidden. This is opposite to the 'visible' option.

    • setStrict boolean (optional) Added in: v1.15#

      When 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.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns