Package com.microsoft.playwright

Interface ElementHandle

All Superinterfaces:
JSHandle
All Known Implementing Classes:
ElementHandleImpl
public interface ElementHandle extends JSHandle
ElementHandle represents an in-page DOM element. ElementHandles can be created with the Page.querySelector() method.

NOTE: 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();

  • Method Details

    • boundingBox

      BoundingBox 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);
      Since:
      v1.8

    • check

      default void check()
      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 force option is set.
      3. Scroll the element into view if needed.
      4. Use Page.mouse() to click in the center of the element.
      5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      6. 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.

      Since:
      v1.8

    • check

      void check(ElementHandle.CheckOptions options)
      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 force option is set.
      3. Scroll the element into view if needed.
      4. Use Page.mouse() to click in the center of the element.
      5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      6. 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.

      Since:
      v1.8

    • click

      default void click()
      This method clicks the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

      Since:
      v1.8

    • click

      void click(ElementHandle.ClickOptions options)
      This method clicks the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

      Since:
      v1.8

    • contentFrame

      Frame contentFrame()
      Returns the content frame for element handles referencing iframe nodes, or null otherwise
      Since:
      v1.8

    • dblclick

      default void dblclick()
      This method double clicks the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

      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.

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

      Since:
      v1.8

    • dblclick

      void dblclick(ElementHandle.DblclickOptions options)
      This method double clicks the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

      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.

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

      Since:
      v1.8

    • dispatchEvent

      default void dispatchEvent(String type)
      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);
      Parameters:
      type - DOM event type: "click", "dragstart", etc.
      Since:
      v1.8

    • dispatchEvent

      void dispatchEvent(String type, Object eventInit)
      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);
      Parameters:
      type - DOM event type: "click", "dragstart", etc.
      eventInit - Optional event-specific initialization properties.
      Since:
      v1.8

    • evalOnSelector

      default Object evalOnSelector(String selector, String expression)
      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"));
      Parameters:
      selector - A selector to query for.
      expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
      Since:
      v1.9

    • evalOnSelector

      Object evalOnSelector(String selector, String expression, Object arg)
      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"));
      Parameters:
      selector - A selector to query for.
      expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
      arg - Optional argument to pass to expression.
      Since:
      v1.9

    • evalOnSelectorAll

      default Object evalOnSelectorAll(String selector, String expression)
      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** 

      
 ElementHandle feedHandle = page.querySelector(".feed");
 assertEquals(Arrays.asList("Hello!", "Hi!"), feedHandle.evalOnSelectorAll(".tweet", "nodes => nodes.map(n => n.innerText)"));
      Parameters:
      selector - A selector to query for.
      expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
      Since:
      v1.9

    • evalOnSelectorAll

      Object evalOnSelectorAll(String selector, String expression, Object arg)
      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** 

      
 ElementHandle feedHandle = page.querySelector(".feed");
 assertEquals(Arrays.asList("Hello!", "Hi!"), feedHandle.evalOnSelectorAll(".tweet", "nodes => nodes.map(n => n.innerText)"));
      Parameters:
      selector - A selector to query for.
      expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
      arg - Optional argument to pass to expression.
      Since:
      v1.9

    • fill

      default void fill(String value)
      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().

      Parameters:
      value - Value to set for the <input>, <textarea> or [contenteditable] element.
      Since:
      v1.8

    • fill

      void fill(String value, ElementHandle.FillOptions options)
      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().

      Parameters:
      value - Value to set for the <input>, <textarea> or [contenteditable] element.
      Since:
      v1.8

    • focus

      void focus()
      Calls focus on the element.
      Since:
      v1.8

    • getAttribute

      String getAttribute(String name)
      Returns element attribute value.
      Parameters:
      name - Attribute name to get the value for.
      Since:
      v1.8

    • hover

      default void hover()
      This method hovers over the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

      Since:
      v1.8

    • hover

      void hover(ElementHandle.HoverOptions options)
      This method hovers over the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, this method throws a TimeoutError. Passing zero timeout disables this.

      Since:
      v1.8

    • innerHTML

      String innerHTML()
      Returns the element.innerHTML.
      Since:
      v1.8

    • innerText

      String innerText()
      Returns the element.innerText.
      Since:
      v1.8

    • inputValue

      default String inputValue()
      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.

      Since:
      v1.13

    • inputValue

      String inputValue(ElementHandle.InputValueOptions options)
      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.

      Since:
      v1.13

    • isChecked

      boolean isChecked()
      Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
      Since:
      v1.8

    • isDisabled

      boolean isDisabled()
      Returns whether the element is disabled, the opposite of enabled.
      Since:
      v1.8

    • isEditable

      boolean isEditable()
      Returns whether the element is editable.
      Since:
      v1.8

    • isEnabled

      boolean isEnabled()
      Returns whether the element is enabled.
      Since:
      v1.8

    • isHidden

      boolean isHidden()
      Returns whether the element is hidden, the opposite of visible.
      Since:
      v1.8

    • isVisible

      boolean isVisible()
      Returns whether the element is visible.
      Since:
      v1.8

    • ownerFrame

      Frame ownerFrame()
      Returns the frame containing the given element.
      Since:
      v1.8

    • press

      default void press(String key)
      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.

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

      Parameters:
      key - Name of the key to press or a character to generate, such as ArrowLeft or a.
      Since:
      v1.8

    • press

      void press(String key, ElementHandle.PressOptions options)
      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.

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

      Parameters:
      key - Name of the key to press or a character to generate, such as ArrowLeft or a.
      Since:
      v1.8

    • querySelector

      ElementHandle querySelector(String selector)
      The method finds an element matching the specified selector in the ElementHandle's subtree. If no elements match the selector, returns null.
      Parameters:
      selector - A selector to query for.
      Since:
      v1.9

    • querySelectorAll

      List<ElementHandle> querySelectorAll(String selector)
      The method finds all elements matching the specified selector in the ElementHandles subtree. If no elements match the selector, returns empty array.
      Parameters:
      selector - A selector to query for.
      Since:
      v1.9

    • screenshot

      default byte[] screenshot()
      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.

      Since:
      v1.8

    • screenshot

      byte[] screenshot(ElementHandle.ScreenshotOptions options)
      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.

      Since:
      v1.8

    • scrollIntoViewIfNeeded

      default void scrollIntoViewIfNeeded()
      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.

      Since:
      v1.8

    • scrollIntoViewIfNeeded

      void scrollIntoViewIfNeeded(ElementHandle.ScrollIntoViewIfNeededOptions options)
      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.

      Since:
      v1.8

    • selectOption

      default List<String> selectOption(String values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(String values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      default List<String> selectOption(ElementHandle values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(ElementHandle values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      default List<String> selectOption(String[] values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(String[] values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      default List<String> selectOption(SelectOption values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(SelectOption values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      default List<String> selectOption(ElementHandle[] values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(ElementHandle[] values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      default List<String> selectOption(SelectOption[] values)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectOption

      List<String> selectOption(SelectOption[] values, ElementHandle.SelectOptionOptions options)
      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"});
      Parameters:
      values - 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.
      Since:
      v1.8

    • selectText

      default void selectText()
      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.

      Since:
      v1.8

    • selectText

      void selectText(ElementHandle.SelectTextOptions options)
      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.

      Since:
      v1.8

    • setChecked

      default void setChecked(boolean checked)
      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 force 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. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      7. 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.

      Parameters:
      checked - Whether to check or uncheck the checkbox.
      Since:
      v1.15

    • setChecked

      void setChecked(boolean checked, ElementHandle.SetCheckedOptions options)
      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 force 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. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      7. 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.

      Parameters:
      checked - Whether to check or uncheck the checkbox.
      Since:
      v1.15

    • setInputFiles

      default void setInputFiles(Path files)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      void setInputFiles(Path files, ElementHandle.SetInputFilesOptions options)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      default void setInputFiles(Path[] files)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      void setInputFiles(Path[] files, ElementHandle.SetInputFilesOptions options)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      default void setInputFiles(FilePayload files)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      void setInputFiles(FilePayload files, ElementHandle.SetInputFilesOptions options)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      default void setInputFiles(FilePayload[] files)
      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.

      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.

      Since:
      v1.8

    • setInputFiles

      void setInputFiles(FilePayload[] files, ElementHandle.SetInputFilesOptions options)
      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.

      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.

      Since:
      v1.8

    • tap

      default void tap()
      This method taps the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, 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.

      Since:
      v1.8

    • tap

      void tap(ElementHandle.TapOptions options)
      This method taps the element by performing the following steps:
      1. Wait for actionability checks on the element, unless force 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 position.
      4. Wait for initiated navigations to either succeed or fail, unless noWaitAfter 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 timeout, 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.

      Since:
      v1.8

    • textContent

      String textContent()
      Returns the node.textContent.
      Since:
      v1.8

    • type

      default void type(String text)
      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().
      Parameters:
      text - A text to type into a focused element.
      Since:
      v1.8

    • type

      void type(String text, ElementHandle.TypeOptions options)
      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().
      Parameters:
      text - A text to type into a focused element.
      Since:
      v1.8

    • uncheck

      default void uncheck()
      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 force option is set.
      3. Scroll the element into view if needed.
      4. Use Page.mouse() to click in the center of the element.
      5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      6. 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.

      Since:
      v1.8

    • uncheck

      void uncheck(ElementHandle.UncheckOptions options)
      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 force option is set.
      3. Scroll the element into view if needed.
      4. Use Page.mouse() to click in the center of the element.
      5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
      6. 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.

      Since:
      v1.8

    • waitForElementState

      default void waitForElementState(ElementState state)
      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 timeout milliseconds, this method will throw.

      Parameters:
      state - A state to wait for, see below for more details.
      Since:
      v1.8

    • waitForElementState

      void waitForElementState(ElementState state, ElementHandle.WaitForElementStateOptions options)
      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 timeout milliseconds, this method will throw.

      Parameters:
      state - A state to wait for, see below for more details.
      Since:
      v1.8

    • waitForSelector

      default ElementHandle waitForSelector(String selector)
      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** 

      
 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.

      Parameters:
      selector - A selector to query for.
      Since:
      v1.8

    • waitForSelector

      ElementHandle waitForSelector(String selector, ElementHandle.WaitForSelectorOptions options)
      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** 

      
 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.

      Parameters:
      selector - A selector to query for.
      Since:
      v1.8