module Playwright::ElementHandle
Overview
ElementHandle represents an in-page DOM element. ElementHandles can be created with the page.$(selector) method.
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.$eval(selector, pageFunction[, arg]) and page.evaluate(pageFunction[, arg]) methods.
Included Modules
Defined in:
playwright/elementhandle.crInstance Method Summary
-
#bounding_box : BoundingBox?
This method returns the bounding box of the element, or
nullif the element is not visible. -
#check(options : CheckOptions?) : Nil
This method checks the element by performing the following steps:
- #check : Nil
- #click : Nil
-
#click(options : ClickOptions?) : Nil
This method clicks the element by performing the following steps:
-
#content_frame : Frame?
Returns the content frame for element handles referencing iframe nodes, or
nullotherwise - #dblclick : Nil
-
#dblclick(options : DblclickOptions?) : Nil
This method double clicks the element by performing the following steps:
- #dispatch_event(type : String, *event_init : Any) : Nil
-
#dispatch_event(type : String, event_init : Array(Any)?) : Nil
The snippet below dispatches the
#clickevent on the element. - #dispatch_event(type : String) : Nil
- #eval_on_selector(selector : String, page_function : String, *arg : Any) : Any
- #eval_on_selector(selector : String, page_function : String) : Any
-
#eval_on_selector(selector : String, page_function : String, arg : Array(Any)?) : Any
Returns the return value of
pageFunctionThe method finds an element matching the specified selector in theElementHandles subtree and passes it as a first argument topageFunction. - #eval_on_selector_all(selector : String, page_function : String, *arg : Any) : Any
- #eval_on_selector_all(selector : String, page_function : String) : Any
-
#eval_on_selector_all(selector : String, page_function : String, arg : Array(Any)?) : Any
Returns the return value of
pageFunctionThe method finds all elements matching the specified selector in theElementHandle's subtree and passes an array of matched elements as a first argument topageFunction. -
#fill(value : String, options : FillOptions?) : Nil
This method waits for actionability checks, focuses the element, fills it and triggers an
inputevent after filling. - #fill(value : String) : Nil
-
#focus : Nil
Calls focus on the element.
-
#get_attribute(name : String) : String?
Returns element attribute value.
-
#hover(options : HoverOptions?) : Nil
This method hovers over the element by performing the following steps:
- #hover : Nil
-
#inner_html : String
Returns the
element.innerHTML. -
#inner_text : String
Returns the
element.innerText. -
#owner_frame : Frame?
Returns the frame containing the given element.
- #press(key : String) : Nil
-
#press(key : String, options : PressOptions?) : Nil
Focuses the element, and then uses
keyboard.down(key)andkeyboard.up(key). -
#query_selector(selector : String) : ElementHandle?
The method finds an element matching the specified selector in the
ElementHandle's subtree. -
#query_selector_all(selector : String) : Array(ElementHandle)
The method finds all elements matching the specified selector in the
ElementHandles subtree. -
#screenshot(options : ScreenshotOptions?) : Bytes
Returns the buffer with the captured screenshot.
- #screenshot : Bytes
-
#scroll_into_view_if_needed(options : ScrollIntoViewIfNeededOptions?) : Nil
This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's
ratio. - #scroll_into_view_if_needed : Nil
- #select_option(values : Array(ElementHandle)?)
- #select_option(value : ElementHandle?)
- #select_option(values : Array(SelectOption)?)
- #select_option(value : SelectOption?)
- #select_option(values : Array(String))
- #select_option(value : String)
- #select_option(values : Array(ElementHandle)?, options : SelectOptionOptions?)
- #select_option(value : ElementHandle?, options : SelectOptionOptions?)
- #select_option(values : Array(SelectOption)?, options : SelectOptionOptions?)
- #select_option(value : SelectOption?, options : SelectOptionOptions?)
- #select_option(values : Array(String), options : SelectOptionOptions?)
- #select_option(value : String, options : SelectOptionOptions?)
-
#select_text(options : SelectTextOptions?) : Nil
This method waits for actionability checks, then focuses the element and selects all its text content.
- #select_text : Nil
- #set_input_files(file : FileChooser::FilePayload)
- #set_input_files(files : Array(Path))
- #set_input_files(file : Path)
- #set_input_files(files : Array(FileChooser::FilePayload))
- #set_input_files(file : FileChooser::FilePayload, options : SetInputFilesOptions?)
- #set_input_files(file : Array(Path), options : SetInputFilesOptions?)
- #set_input_files(file : Path, options : SetInputFilesOptions?)
-
#set_input_files(file : Array(FileChooser::FilePayload), options : SetInputFilesOptions?)
This method expects
elementHandleto point to an input element. -
#tap(options : TapOptions?) : Nil
This method taps the element by performing the following steps:
- #tap : Nil
-
#text_content : String?
Returns the
node.textContent. - #to_string : String
-
#type(text : String, options : TypeOptions?) : Nil
Focuses the element, and then sends a
keydown,keypress/input, andkeyupevent for each character in the text. - #type(text : String) : Nil
-
#uncheck(options : UncheckOptions?) : Nil
This method checks the element by performing the following steps:
- #uncheck : Nil
-
#wait_for_element_state(state : ElementState, options : WaitForElementStateOptions?) : Deferred(Nil)
Returns the element satisfies the
state. - #wait_for_element_state(state : ElementState) : Deferred(Nil)
-
#wait_for_selector(selector : String, options : WaitForSelectorOptions?) : Deferred(ElementHandle?)
Returns element specified by selector satisfies
stateoption. - #wait_for_selector(selector : String) : Deferred(ElementHandle?)
Instance methods inherited from module Playwright::JSHandle
as_element : ElementHandle?
as_element,
dispose : Nil
dispose,
evaluate(page_function : String, arg : Array(Any)?) : Anyevaluate(page_function : String) : Any
evaluate(page_function : String, *arg : Any) : Any evaluate, evaluate_handle(page_function : String, arg : Array(Any)?) : JSHandle
evaluate_handle(page_function : String) : JSHandle
evaluate_handle(page_function : String, *arg : Any) : JSHandle evaluate_handle, get_properties : Hash(String, JSHandle) get_properties, get_property(property_name : String) : JSHandle get_property, json_value : Any json_value
Instance Method Detail
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 bonding 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.
This method checks the element by performing the following steps:
Ensure that element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.
Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use page.mouse to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
Ensure that the element is now checked. If not, this method rejects.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
This method clicks the element by performing the following steps:
Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use page.mouse to click in the center of the element, or the specified position.
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 rejects.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
Returns the content frame for element handles referencing iframe nodes, or null otherwise
This method double clicks the element by performing the following steps:
Wait for actionability checks on the element, unless force option is set.
Scroll the element into view if needed.
Use page.mouse to double click in the center of the element, or the specified position.
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 reject.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
NOTE elementHandle.dblclick() dispatches two #click events and a single #dblclick event.
The snippet below dispatches the #click event on the element. Regardless of the visibility state of the elment, #click is dispatched. This is equivalend to calling element.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:
DragEvent FocusEvent KeyboardEvent MouseEvent PointerEvent TouchEvent Event
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
Returns the return value of pageFunction
The method finds an element matching the specified selector in the ElementHandles subtree and passes it as a first argument to pageFunction. See Working with selectors for more details. If no elements match the selector, the method throws an error.
If pageFunction returns a Promise, then frame.$eval would wait for the promise to resolve and return its value.
Examples:
Returns the return value of pageFunction
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 pageFunction. See Working with selectors for more details.
If pageFunction returns a Promise, then frame.$$eval would wait for the promise to resolve and return its value.
Examples:
This method waits for actionability checks, focuses the element, fills it and triggers an input event after filling. If the element is not an ,