class Playwright::ElementHandle

“‘
locator.click()
locator.hover()
locator = page.get_by_text(“Submit”)
“`python sync
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.
“`
handle.click()
handle.hover()
handle = page.query_selector(“text=Submit”)
“`python sync
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.
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.
ElementHandle instances can be used as an argument in [`method: Page.evalOnSelector`] and [`method: Page.evaluate`] methods.
[`method: JSHandle.dispose`]. ElementHandles are auto-disposed when their origin frame gets navigated.
ElementHandle prevents DOM element from garbage collection unless the handle is disposed with
“`
href_element.click()
href_element = page.query_selector(“a”)
“`python sync
NOTE: The use of ElementHandle is discouraged, use `Locator` objects and web-first assertions instead.
ElementHandle represents an in-page DOM element. ElementHandles can be created with the [`method: Page.querySelector`] method.
- extends: `JSHandle`

def bounding_box

```
page.mouse.click(box["x"] + box["width"] / 2, box["y"] + box["height"] / 2)
box = element_handle.bounding_box()
```python sync

**Usage**

snippet should click the center of the element.
Assuming the page is static, it is safe to use bounding box coordinates to perform input. For example, the following

[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect).
Elements from child frames return the bounding box relative to the main frame, unlike the

means `x` and/or `y` may be negative.
[Element.getBoundingClientRect](https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect). That
Scrolling affects the returned bounding box, similarly to

calculated relative to the main frame viewport - which is usually the same as the browser window.
This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is

def bounding_box
  wrap_impl(@impl.bounding_box)
end

def check(

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

If the element is detached from the DOM at any moment during the action, this method throws.

1. Ensure that the element is now checked. If not, this method throws.
1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
1. Use [`property: Page.mouse`] to click in the center of the element.
1. Scroll the element into view if needed.
1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.
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.
This method checks the element by performing the following steps:

def check(
      force: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

def checked?

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

def checked?
  wrap_impl(@impl.checked?)
end

def click(

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

If the element is detached from the DOM at any moment during the action, this method throws.

1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
1. Use [`property: Page.mouse`] to click in the center of the element, or the specified `position`.
1. Scroll the element into view if needed.
1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.
This method clicks the element by performing the following steps:

def click(
      button: nil,
      clickCount: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.click(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

def content_frame

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

def content_frame
  wrap_impl(@impl.content_frame)
end

def dblclick(

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

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

If the element is detached from the DOM at any moment during the action, this method throws.

1. 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.
1. Use [`property: Page.mouse`] to double click in the center of the element, or the specified `position`.
1. Scroll the element into view if needed.
1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.
This method double clicks the element by performing the following steps:

def dblclick(
      button: nil,
      delay: nil,
      force: nil,
      modifiers: nil,
      noWaitAfter: nil,
      position: nil,
      timeout: nil,
      trial: nil)
  wrap_impl(@impl.dblclick(button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end

def disabled?

Returns whether the element is disabled, the opposite of [enabled](../actionability.md#enabled).

def disabled?
  wrap_impl(@impl.disabled?)
end

def dispatch_event(type, eventInit: nil)

```
element_handle.dispatch_event("#source", "dragstart", {"dataTransfer": data_transfer})
data_transfer = page.evaluate_handle("new DataTransfer()")
# note you can only create data_transfer in chromium and firefox
```python sync

You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:

- [WheelEvent](https://developer.mozilla.org/en-US/docs/Web/API/WheelEvent/WheelEvent)
- [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
- [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
- [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
- [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
- [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
- [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
- [DeviceOrientationEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent/DeviceOrientationEvent)
- [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/DeviceMotionEvent)
properties:
Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial

default.
`eventInit` properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by
Under the hood, it creates an instance of an event based on the given `type`, initializes it with

```
element_handle.dispatch_event("click")
```python sync

**Usage**

[element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
is dispatched. This is equivalent to calling
The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element, `click`

def dispatch_event(type, eventInit: nil)
  wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit)))
end

def editable?

Returns whether the element is [editable](../actionability.md#editable).

def editable?
  wrap_impl(@impl.editable?)
end

def enabled?

Returns whether the element is [enabled](../actionability.md#enabled).

def enabled?
  wrap_impl(@impl.enabled?)
end

def eval_on_selector(selector, expression, arg: nil)

```
assert tweet_handle.eval_on_selector(".retweets", "node => node.innerText") == "10"
assert tweet_handle.eval_on_selector(".like", "node => node.innerText") == "100"
tweet_handle = page.query_selector(".tweet")
```python sync

**Usage**

value.
If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelector`] would wait for the promise to resolve and return its

argument to `expression`. If no elements match the selector, the method throws an error.
The method finds an element matching the specified selector in the `ElementHandle`s subtree and passes it as a first

Returns the return value of `expression`.

def eval_on_selector(selector, expression, arg: nil)
  wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
end

def eval_on_selector_all(selector, expression, arg: nil)

```
assert feed_handle.eval_on_selector_all(".tweet", "nodes => nodes.map(n => n.innerText)") == ["hello!", "hi!"]
feed_handle = page.query_selector(".feed")
```python sync

```

Hi!

Hello!

```html

**Usage**

value.
If `expression` returns a [Promise], then [`method: ElementHandle.evalOnSelectorAll`] would wait for the promise to resolve and return its

matched elements as a first argument to `expression`.
The method finds all elements matching the specified selector in the `ElementHandle`'s subtree and passes an array of

Returns the return value of `expression`.

def eval_on_selector_all(selector, expression, arg: nil)
  wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
end

def event_emitter_proxy

def event_emitter_proxy
_emitter_proxy ||= EventEmitterProxy.new(self, @impl)

def fill(value, force: nil, noWaitAfter: nil, timeout: nil)

To send fine-grained keyboard events, use [`method: Locator.pressSequentially`].

If the target element is not an ``, `

` or `[contenteditable]` element, this method throws an error. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled instead. This method waits for [actionability](../actionability.md) 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. 
 </div>

<pre id="code-block-6349" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def fill(value, force: nil, noWaitAfter: nil, timeout: nil)
 wrap_impl(@impl.fill(unwrap_impl(value), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end</pre>

</div>

<div class="mt-6 overflow-scroll">
 <div class="mt-6 mb-3">
 <div class="border-b border-gray-300 pb-2 mb-4">
 <h3 class="fs-step-1 font-medium tracking-tight monospace-font-family">def focus
</h3>

</div>

Calls [focus](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus) on the element. 
 </div>

<pre id="code-block-9834" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def focus
 wrap_impl(@impl.focus)
end</pre>

</div>

Returns element attribute value. 
 </div>

<pre id="code-block-2041" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def get_attribute(name)
 wrap_impl(@impl.get_attribute(unwrap_impl(name)))
end</pre>

</div>

Returns whether the element is hidden, the opposite of [visible](../actionability.md#visible). 
 </div>

<pre id="code-block-7765" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def hidden?
 wrap_impl(@impl.hidden?)
end</pre>

</div>

`TimeoutError`. Passing zero timeout disables this. When all steps combined have not finished during the specified `timeout`, this method throws a If the element is detached from the DOM at any moment during the action, this method throws. 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Use [`property: Page.mouse`] to hover over the center of the element, or the specified `position`. 1. Scroll the element into view if needed. 1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set. This method hovers over the element by performing the following steps: 
 </div>

<pre id="code-block-9664" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def hover(
 force: nil,
 modifiers: nil,
 noWaitAfter: nil,
 position: nil,
 timeout: nil,
 trial: nil)
 wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end</pre>

</div>

Returns the `element.innerHTML`. 
 </div>

<pre id="code-block-9366" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def inner_html
 wrap_impl(@impl.inner_html)
end</pre>

</div>

Returns the `element.innerText`. 
 </div>

<pre id="code-block-7658" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def inner_text
 wrap_impl(@impl.inner_text)
end</pre>

</div>

Throws for non-input elements. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), returns the value of the control. Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. 
 </div>

<pre id="code-block-6539" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def input_value(timeout: nil)
 wrap_impl(@impl.input_value(timeout: unwrap_impl(timeout)))
end</pre>

</div>

@nodoc -- inherited from EventEmitter --
 </div>

<pre id="code-block-9527" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def off(event, callback)
 event_emitter_proxy.off(event, callback)
end</pre>

</div>

@nodoc -- inherited from EventEmitter --
 </div>

<pre id="code-block-4137" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def on(event, callback)
 event_emitter_proxy.on(event, callback)
end</pre>

</div>

@nodoc -- inherited from EventEmitter --
 </div>

<pre id="code-block-4427" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def once(event, callback)
 event_emitter_proxy.once(event, callback)
end</pre>

</div>

Returns the frame containing the given element. 
 </div>

<pre id="code-block-8350" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def owner_frame
 wrap_impl(@impl.owner_frame)
end</pre>

</div>

modifier, modifier is pressed and being held while the subsequent key is being pressed. Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported as well. When specified with the respective texts. If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different Holding down `Shift` will type the text that corresponds to the `key` in the upper case. Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`. `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc. `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`, [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are: generate the text for. A superset of the `key` values can be found [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character to `key` can specify the intended Focuses the element, and then uses [`method: Keyboard.down`] and [`method: Keyboard.up`]. 
 </div>

<pre id="code-block-5917" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def press(key, delay: nil, noWaitAfter: nil, timeout: nil)
 wrap_impl(@impl.press(unwrap_impl(key), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end</pre>

</div>

returns `null`. The method finds an element matching the specified selector in the `ElementHandle`'s subtree. If no elements match the selector, 
 </div>

<pre id="code-block-9113" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def query_selector(selector)
 wrap_impl(@impl.query_selector(unwrap_impl(selector)))
end</pre>

</div>

returns empty array. The method finds all elements matching the specified selector in the `ElementHandle`s subtree. If no elements match the selector, 
 </div>

<pre id="code-block-132" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def query_selector_all(selector)
 wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
end</pre>

</div>

Returns the buffer with the captured screenshot. screenshot. If the element is detached from DOM, the method throws an error. This method waits for the [actionability](../actionability.md) checks, then scrolls element into view before taking a 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. 
 </div>

<pre id="code-block-9397" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def screenshot(
 animations: nil,
 caret: nil,
 mask: nil,
 maskColor: nil,
 omitBackground: nil,
 path: nil,
 quality: nil,
 scale: nil,
 style: nil,
 timeout: nil,
 type: nil)
 wrap_impl(@impl.screenshot(animations: unwrap_impl(animations), caret: unwrap_impl(caret), mask: unwrap_impl(mask), maskColor: unwrap_impl(maskColor), omitBackground: unwrap_impl(omitBackground), path: unwrap_impl(path), quality: unwrap_impl(quality), scale: unwrap_impl(scale), style: unwrap_impl(style), timeout: unwrap_impl(timeout), type: unwrap_impl(type)))
end</pre>

</div>

[connected](https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected) to a Document or a ShadowRoot. Throws when `elementHandle` does not point to an element [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)'s `ratio`. completely visible as defined by This method waits for [actionability](../actionability.md) checks, then tries to scroll element into view, unless it is 
 </div>

<pre id="code-block-6933" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def scroll_into_view_if_needed(timeout: nil)
 wrap_impl(@impl.scroll_into_view_if_needed(timeout: unwrap_impl(timeout)))
end</pre>

</div>

``` handle.select_option(value=["red", "green", "blue"]) # multiple selection handle.select_option(label="blue") # single selection matching both the label handle.select_option("blue") # Single selection matching the value or label ```python sync **Usage** Triggers a `change` and `input` event once all the provided options have been selected. Returns the array of option values that have been successfully selected. 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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used instead. This method waits for [actionability](../actionability.md) checks, waits until all specified options are present in the `<select>` element and selects these options. 
 </div>

<pre id="code-block-1776" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def select_option(
 element: nil,
 index: nil,
 value: nil,
 label: nil,
 force: nil,
 noWaitAfter: nil,
 timeout: nil)
 wrap_impl(@impl.select_option(element: unwrap_impl(element), index: unwrap_impl(index), value: unwrap_impl(value), label: unwrap_impl(label), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end</pre>

</div>

If the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), focuses and selects text in the control instead. content. This method waits for [actionability](../actionability.md) checks, then focuses the element and selects all its text 
 </div>

<pre id="code-block-3914" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def select_text(force: nil, timeout: nil)
 wrap_impl(@impl.select_text(force: unwrap_impl(force), timeout: unwrap_impl(timeout)))
end</pre>

</div>

`TimeoutError`. Passing zero timeout disables this. When all steps combined have not finished during the specified `timeout`, this method throws a 1. Ensure that the element is now checked or unchecked. If not, this method throws. 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Use [`property: Page.mouse`] to click in the center of the element. 1. Scroll the element into view if needed. 1. Wait for [actionability](../actionability.md) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. If the element already has the right checked state, this method returns immediately. 1. Ensure that element is a checkbox or a radio input. If not, this method throws. This method checks or unchecks an element by performing the following steps: 
 </div>

<pre id="code-block-765" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def set_checked(
 checked,
 force: nil,
 noWaitAfter: nil,
 position: nil,
 timeout: nil,
 trial: nil)
 wrap_impl(@impl.set_checked(unwrap_impl(checked), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end</pre>

</div>

[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), targets the control instead. This method expects `ElementHandle` to point to an are resolved relative to the current working directory. For empty array, clears the selected files. Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they 
 </div>

<pre id="code-block-439" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def set_input_files(files, noWaitAfter: nil, timeout: nil)
 wrap_impl(@impl.set_input_files(unwrap_impl(files), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end</pre>

</div>

**NOTE**: `elementHandle.tap()` requires that the `hasTouch` option of the browser context be set to true. `TimeoutError`. Passing zero timeout disables this. When all steps combined have not finished during the specified `timeout`, this method throws a If the element is detached from the DOM at any moment during the action, this method throws. 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Use [`property: Page.touchscreen`] to tap the center of the element, or the specified `position`. 1. Scroll the element into view if needed. 1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set. This method taps the element by performing the following steps: 
 </div>

<pre id="code-block-7630" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def tap_point(
 force: nil,
 modifiers: nil,
 noWaitAfter: nil,
 position: nil,
 timeout: nil,
 trial: nil)
 wrap_impl(@impl.tap_point(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end</pre>

</div>

Returns the `node.textContent`. 
 </div>

<pre id="code-block-8094" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def text_content
 wrap_impl(@impl.text_content)
end</pre>

</div>

**Usage** To press a special key, like `Control` or `ArrowDown`, use [`method: ElementHandle.press`]. Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. 
 </div>

<pre id="code-block-7819" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
 wrap_impl(@impl.type(unwrap_impl(text), delay: unwrap_impl(delay), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
end</pre>

</div>

`TimeoutError`. Passing zero timeout disables this. When all steps combined have not finished during the specified `timeout`, this method throws a If the element is detached from the DOM at any moment during the action, this method throws. 1. Ensure that the element is now unchecked. If not, this method throws. 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Use [`property: Page.mouse`] to click in the center of the element. 1. Scroll the element into view if needed. 1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set. 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. This method checks the element by performing the following steps: 
 </div>

<pre id="code-block-4339" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def uncheck(
 force: nil,
 noWaitAfter: nil,
 position: nil,
 timeout: nil,
 trial: nil)
 wrap_impl(@impl.uncheck(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
end</pre>

</div>

Returns whether the element is [visible](../actionability.md#visible). 
 </div>

<pre id="code-block-5600" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def visible?
 wrap_impl(@impl.visible?)
end</pre>

</div>

If the element does not satisfy the condition for the `timeout` milliseconds, this method will throw. - `"editable"` Wait until the element is [editable](../actionability.md#editable). - `"disabled"` Wait until the element is [not enabled](../actionability.md#enabled). - `"enabled"` Wait until the element is [enabled](../actionability.md#enabled). - `"stable"` Wait until the element is both [visible](../actionability.md#visible) and [stable](../actionability.md#stable). - `"hidden"` Wait until the element is [not visible](../actionability.md#visible) or not attached. Note that waiting for hidden does not throw when the element detaches. - `"visible"` Wait until the element is [visible](../actionability.md#visible). to pass. This method throws when the element is detached while waiting, unless waiting for the `"hidden"` state. Depending on the `state` parameter, this method waits for one of the [actionability](../actionability.md) checks Returns when the element satisfies the `state`. 
 </div>

<pre id="code-block-8692" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def wait_for_element_state(state, timeout: nil)
 wrap_impl(@impl.wait_for_element_state(unwrap_impl(state), timeout: unwrap_impl(timeout)))
end</pre>

</div>

**NOTE**: This method does not work across navigations, use [`method: Page.waitForSelector`] instead. ``` span = div.wait_for_selector("span", state="attached") # waiting for the "span" selector relative to the div. div = page.query_selector("div") page.set_content("<div></div>") ```python sync **Usage** `timeout` milliseconds, the function will throw. satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the appear/disappear from dom, or become visible/hidden). If at the moment of calling the method `selector` already Wait for the `selector` relative to the element handle to satisfy `state` option (either or `detached`. Returns element specified by selector when it satisfies `state` option. Returns `null` if waiting for `hidden` 
 </div>

<pre id="code-block-7804" class="rouge border border-gray-300 rounded overflow-scroll px-4 py-2">def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
end</pre>

</div>

</div>
 </div>

</div>
 </main>
 </div>

<div class="overflow-hidden mt-6 hidden xl:block">
 <div class="block truncate col-span-1 mb-6">
 <h3 class="list-header">Namespace</h3>

<ul class="list code">
 <li><a href="/gems/playwright-ruby-client/v1.41.1/modules/Playwright">Playwright</a></li>
 </ul>
</div>

<div class="block truncate col-span-1 mb-6">
 <h3 class="list-header">Parent class</h3>

<ul class="list code">
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::JSHandle">Playwright::JSHandle</a></li>
 </ul>
</div>

<div class="block truncate col-span-1 mb-6">
 <h3 class="list-header">Instance Methods</h3>

<ul class="list code">
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/bounding_box"># bounding_box</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/check"># check</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/checked%3F"># checked?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/click"># click</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/content_frame"># content_frame</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/dblclick"># dblclick</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/disabled%3F"># disabled?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/dispatch_event"># dispatch_event</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/editable%3F"># editable?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/enabled%3F"># enabled?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/eval_on_selector"># eval_on_selector</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/eval_on_selector_all"># eval_on_selector_all</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/event_emitter_proxy"># event_emitter_proxy</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/fill"># fill</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/focus"># focus</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/get_attribute"># get_attribute</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/hidden%3F"># hidden?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/hover"># hover</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/inner_html"># inner_html</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/inner_text"># inner_text</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/input_value"># input_value</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/off"># off</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/on"># on</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/once"># once</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/owner_frame"># owner_frame</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/press"># press</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/query_selector"># query_selector</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/query_selector_all"># query_selector_all</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/screenshot"># screenshot</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/scroll_into_view_if_needed"># scroll_into_view_if_needed</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/select_option"># select_option</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/select_text"># select_text</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/set_checked"># set_checked</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/set_input_files"># set_input_files</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/tap_point"># tap_point</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/text_content"># text_content</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/type"># type</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/uncheck"># uncheck</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/visible%3F"># visible?</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/wait_for_element_state"># wait_for_element_state</a></li>
 <li><a href="/gems/playwright-ruby-client/v1.41.1/classes/Playwright::ElementHandle/instance_methods/wait_for_selector"># wait_for_selector</a></li>
 </ul>
</div>

<div class="block truncate col-span-1 mb-6">
 <h3 class="list-header">Defined in</h3>

<ul class="list code">
 <li><a href="/gems/playwright-ruby-client/v1.41.1/files/lib%2Fplaywright_api%2Felement_handle.rb">lib/playwright_api/element_handle.rb</a></li>
 </ul>
</div>

</div>
 </div>
 </div>
</main>

</div>

<footer class="bg-white">
 <div class="mx-auto max-w-7xl overflow-hidden px-6 py-20 sm:py-24 lg:px-8">
 <nav class="-mb-6 flex flex-wrap text-center justify-center gap-x-12" aria-label="Footer">
 <div class="pb-6">
 <a class="text-sm leading-6 text-gray-600 hover:text-gray-900" href="/">Home</a>
 </div>
 <div class="pb-6">
 <a class="text-sm leading-6 text-gray-600 hover:text-gray-900" href="/gems">Gems</a>
 </div>
 <div class="pb-6">
 <a class="text-sm leading-6 text-gray-600 hover:text-gray-900" href="/docs">Docs</a>
 </div>
 <div class="pb-6">
 <a target="_blank" class="text-sm leading-6 text-gray-600 hover:text-gray-900" href="https://github.com/marcoroth/gem.sh">Contribute</a>
 </div>
 <div class="pb-6">
 <a target="_blank" class="text-sm leading-6 text-gray-600 hover:text-gray-900" href="https://www.rorvswild.com/applications/136042/requests?utm_medium=referral&utm_source=gem.sh">Monitoring</a>
 </div>
 </nav>

<div class="mt-8 flex justify-center space-x-6">
 <a target="_blank" href="https://twitter.com/marcoroth_" class="text-gray-400 hover:text-gray-500">
 Twitter
 <svg class="h-6 w-6" fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
 <path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path>
 </svg>
 </a>

<a target="_blank" href="https://github.com/marcoroth/gem.sh" class="text-gray-400 hover:text-gray-500">
 GitHub
 <svg class="h-6 w-6" fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512">
 <path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path>
 </svg>
 </a>

<a target="_blank" href="https://ruby.social/@marcoroth" target="_blank" class="text-gray-400 hover:text-gray-500">
 Mastodon
 <svg class="h-6 w-6" fill="currentColor" viewBox="0 0 16 16">
 <path d="M11.19 12.195c2.016-.24 3.77-1.475 3.99-2.603.348-1.778.32-4.339.32-4.339 0-3.47-2.286-4.488-2.286-4.488C12.062.238 10.083.017 8.027 0h-.05C5.92.017 3.942.238 2.79.765c0 0-2.285 1.017-2.285 4.488l-.002.662c-.004.64-.007 1.35.011 2.091.083 3.394.626 6.74 3.78 7.57 1.454.383 2.703.463 3.709.408 1.823-.1 2.847-.647 2.847-.647l-.06-1.317s-1.303.41-2.767.36c-1.45-.05-2.98-.156-3.215-1.928a3.614 3.614 0 0 1-.033-.496s1.424.346 3.228.428c1.103.05 2.137-.064 3.188-.189zm1.613-2.47H11.13v-4.08c0-.859-.364-1.295-1.091-1.295-.804 0-1.207.517-1.207 1.541v2.233H7.168V5.89c0-1.024-.403-1.541-1.207-1.541-.727 0-1.091.436-1.091 1.296v4.079H3.197V5.522c0-.859.22-1.541.66-2.046.456-.505 1.052-.764 1.793-.764.856 0 1.504.328 1.933.983L8 4.39l.417-.695c.429-.655 1.077-.983 1.934-.983.74 0 1.336.259 1.791.764.442.505.661 1.187.661 2.046v4.203z"></path>
 </svg>
 </a>
 </div>

© 2025 gem.sh - Beautiful documentation for any Ruby gem
 
 </div>
</footer>

</body>
</html>

Modules

Classes

class Playwright::ElementHandle

def bounding_box

def check(

def checked?

def click(

def content_frame

def dblclick(

def disabled?

def dispatch_event(type, eventInit: nil)

def editable?

def enabled?

def eval_on_selector(selector, expression, arg: nil)

def eval_on_selector_all(selector, expression, arg: nil)

def event_emitter_proxy

def fill(value, force: nil, noWaitAfter: nil, timeout: nil)