module Playwright::Frame
Overview
At every point of time, page exposes its current frame tree via the page.mainFrame()
and frame.childFrames()
methods.
Frame object's lifecycle is controlled by three events, dispatched on the page object:
page.on('frameattached') - fired when the frame gets attached to the page. A Frame can be attached to the page only once. page.on('framenavigated') - fired when the frame commits navigation to a different URL. page.on('framedetached') - fired when the frame gets detached from the page. A Frame can be detached from the page only once.
An example of dumping frame tree:
An example of getting text from an iframe element:
Defined in:
playwright/frame.crInstance Method Summary
-
#add_script_tag(params : AddScriptTagParams) : ElementHandle
Returns the added tag when the script's onload fires or when the script content was injected into frame.
-
#add_style_tag(params : AddStyleTagParams) : ElementHandle
Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
-
#check(selector : String, options : CheckOptions | Nil) : Nil
This method checks an element matching
selector
by performing the following steps: - #check(selector : String) : Nil
- #child_frames : Array(Frame)
-
#click(selector : String, options : ClickOptions | Nil) : Nil
This method clicks an element matching
selector
by performing the following steps: - #click(selector : String) : Nil
-
#content : String
Gets the full HTML contents of the frame, including the doctype.
-
#dblclick(selector : String, options : DblclickOptions | Nil) : Nil
This method double clicks an element matching
selector
by performing the following steps: - #dblclick(selector : String) : Nil
-
#dispatch_event(selector : String, type : String, event_init : Array(Any) | Nil, options : DispatchEventOptions | Nil) : Nil
The snippet below dispatches the
#click
event on the element. - #dispatch_event(selector : String, type : String, event_init : Array(Any) | Nil) : Nil
- #dispatch_event(selector : String, type : String) : Nil
- #dispatch_event(selector : String, type : String, *event_init : Any) : Nil
-
#eval_on_selector(selector : String, page_function : String, arg : Array(Any) | Nil) : Any
Returns the return value of
pageFunction
The method finds an element matching the specified selector within the frame and passes it as a first argument topageFunction
. - #eval_on_selector(selector : String, page_function : String) : Any
- #eval_on_selector(selector : String, page_function : String, *arg : Any) : Any
-
#eval_on_selector_all(selector : String, page_function : String, arg : Array(Any) | Nil) : Any
Returns the return value of
pageFunction
The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument topageFunction
. - #eval_on_selector_all(selector : String, page_function : String) : Any
- #eval_on_selector_all(selector : String, page_function : String, *arg : Any) : Any
-
#evaluate(page_function : String, arg : Array(Any) | Nil) : Any
Returns the return value of
pageFunction
If the function passed to theframe.evaluate
returns a Promise, thenframe.evaluate
would wait for the promise to resolve and return its value. - #evaluate(page_function : String) : Any
- #evaluate(page_function : String, *arg : Any) : Any
-
#evaluate_handle(page_function : String, arg : Array(Any) | Nil) : JSHandle
Returns the return value of
pageFunction
as in-page object (JSHandle). - #evaluate_handle(page_function : String) : JSHandle
- #evaluate_handle(page_function : String, *arg : Any) : JSHandle
-
#fill(selector : String, value : String, options : FillOptions | Nil) : Nil
This method waits for an element matching
selector
, waits for actionability checks, focuses the element, fills it and triggers aninput
event after filling. - #fill(selector : String, value : String) : Nil
-
#focus(selector : String, options : FocusOptions | Nil) : Nil
This method fetches an element with
selector
and focuses it. - #focus(selector : String) : Nil
-
#frame_element : ElementHandle
Returns the
frame
oriframe
element handle which corresponds to this frame. -
#get_attribute(selector : String, name : String, options : GetAttributeOptions | Nil) : String | Nil
Returns element attribute value.
- #get_attribute(selector : String, name : String) : String | Nil
-
#goto(url : String, options : NavigateOptions | Nil) : Response | Nil
Returns the main resource response.
- #goto(url : String) : Response | Nil
-
#hover(selector : String, options : HoverOptions | Nil) : Nil
This method hovers over an element matching
selector
by performing the following steps: - #hover(selector : String) : Nil
-
#inner_html(selector : String, options : InnerHTMLOptions | Nil) : String
Returns
element.innerHTML
. - #inner_html(selector : String) : String
-
#inner_text(selector : String, options : InnerTextOptions | Nil) : String
Returns
element.innerText
. - #inner_text(selector : String) : String
-
#is_detached : Bool
Returns
true
if the frame has been detached, orfalse
otherwise. -
#name : String
Returns frame's name attribute as specified in the tag.
-
#page : Page | Nil
Returns the page containing this frame.
-
#parent_frame : Frame | Nil
Parent frame, if any.
-
#press(selector : String, key : String, options : PressOptions | Nil) : Nil
key
can specify the intended keyboardEvent.key value or a single character to generate the text for. - #press(selector : String, key : String) : Nil
-
#query_selector(selector : String) : ElementHandle | Nil
Returns the ElementHandle pointing to the frame element.
-
#query_selector_all(selector : String) : Array(ElementHandle)
Returns the ElementHandles pointing to the frame elements.
- #select_option(selector : String, value : String, options : SelectOptionOptions | Nil)
- #select_option(selector : String, values : Array(String), options : SelectOptionOptions | Nil)
- #select_option(selector : String, value : ElementHandle::SelectOption | Nil, options : SelectOptionOptions | Nil)
- #select_option(selector : String, values : Array(ElementHandle::SelectOption) | Nil, options : SelectOptionOptions | Nil)
- #select_option(selector : String, value : ElementHandle | Nil, options : SelectOptionOptions | Nil)
- #select_option(selector : String, values : Array(ElementHandle) | Nil, options : SelectOptionOptions | Nil)
- #select_option(selector : String, value : String)
- #select_option(selector : String, values : Array(String))
- #select_option(selector : String, value : ElementHandle::SelectOption | Nil)
- #select_option(selector : String, values : Array(ElementHandle::SelectOption) | Nil)
- #select_option(selector : String, value : ElementHandle | Nil)
- #select_option(selector : String, values : Array(ElementHandle) | Nil)
- #set_content(html : String, options : SetContentOptions | Nil) : Nil
- #set_content(html : String) : Nil
- #set_input_files(selector : String, file : Path, options : SetInputFilesOptions | Nil)
- #set_input_files(selector : String, file : Array(Path), options : SetInputFilesOptions | Nil)
- #set_input_files(selector : String, file : FileChooser::FilePayload, options : SetInputFilesOptions | Nil)
-
#set_input_files(selector : String, file : Array(FileChooser::FilePayload), options : SetInputFilesOptions | Nil)
This method expects
selector
to point to an input element. - #set_input_files(selector : String, file : Path)
- #set_input_files(selector : String, files : Array(Path))
- #set_input_files(selector : String, file : FileChooser::FilePayload)
- #set_input_files(selector : String, files : Array(FileChooser::FilePayload))
-
#tap(selector : String, options : TapOptions | Nil) : Nil
This method taps an element matching
selector
by performing the following steps: - #tap(selector : String) : Nil
-
#text_content(selector : String, options : TextContentOptions | Nil) : String | Nil
Returns
element.textContent
. - #text_content(selector : String) : String | Nil
-
#title : String
Returns the page title.
-
#type(selector : String, text : String, options : TypeOptions | Nil) : Nil
Sends a
keydown
,keypress
/input
, andkeyup
event for each character in the text. - #type(selector : String, text : String) : Nil
-
#uncheck(selector : String, options : UncheckOptions | Nil) : Nil
This method checks an element matching
selector
by performing the following steps: - #uncheck(selector : String) : Nil
-
#url : String
Returns frame's url.
-
#wait_for_function(page_function : String, arg : Array(Any) | Nil, options : WaitForFunctionOptions | Nil) : Deferred(JSHandle)
Returns when the
pageFunction
returns a truthy value, returns that value. - #wait_for_function(page_function : String, arg : Array(Any) | Nil) : Deferred(JSHandle)
- #wait_for_function(page_function : String) : Deferred(JSHandle)
- #wait_for_function(page_function : String, *arg : Any) : Deferred(JSHandle)
-
#wait_for_load_state(state : LoadState | Nil, options : WaitForLoadStateOptions | Nil) : Deferred(Nil)
Waits for the required load state to be reached.
- #wait_for_load_state(state : LoadState | Nil) : Deferred(Nil)
- #wait_for_load_state : Deferred(Nil)
-
#wait_for_navigation(options : WaitForNavigationOptions | Nil) : Deferred(Response | Nil)
Returns the main resource response.
- #wait_for_navigation : Deferred(Response | Nil)
-
#wait_for_selector(selector : String, options : WaitForSelectorOptions | Nil) : Deferred(ElementHandle | Nil)
Returns when element specified by selector satisfies
state
option. - #wait_for_selector(selector : String) : Deferred(ElementHandle | Nil)
-
#wait_for_timeout(timeout : Int32) : Deferred(Nil)
Waits for the given
timeout
in milliseconds.
Instance Method Detail
Returns the added tag when the script's onload fires or when the script content was injected into frame.
Adds a <script>
tag into the page with the desired url or content.
Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
Adds a <link rel="stylesheet">
tag into the page with the desired url or a <style type="text/css">
tag with the content.
This method checks an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
Ensure that matched 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 matched element, unless force
option is set. If the element is detached during the checks, the whole action is retried.
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.
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 an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
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.
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.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
This method double clicks an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
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.
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.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
NOTE frame.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 within the frame 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 within the frame 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:
Returns the return value of pageFunction
If the function passed to the frame.evaluate
returns a Promise, then frame.evaluate
would wait for the promise to resolve and return its value.
If the function passed to the frame.evaluate
returns a non-Serializable value, then frame.evaluate
returns undefined
. DevTools Protocol also supports transferring some additional values that are not serializable by JSON
: -0
, NaN
, Infinity
, -Infinity
, and bigint literals.
A string can also be passed in instead of a function.
ElementHandle instances can be passed as an argument to the frame.evaluate
:
Returns the return value of pageFunction
as in-page object (JSHandle).
The only difference between frame.evaluate
and frame.evaluateHandle
is that frame.evaluateHandle
returns in-page object (JSHandle).
If the function, passed to the frame.evaluateHandle
, returns a Promise, then frame.evaluateHandle
would wait for the promise to resolve and return its value.
A string can also be passed in instead of a function.
JSHandle instances can be passed as an argument to the frame.evaluateHandle
:
This method waits for an element matching selector
, waits for actionability checks, focuses the element, fills it and triggers an input
event after filling. If the element matching selector
is not an <input>
, <textarea>
or [contenteditable]
element, this method throws an error. Note that you can pass an empty string to clear the input field.
To send fine-grained keyboard events, use frame.type(selector, text[, options])
.
This method fetches an element with selector
and focuses it. If there's no element matching selector
, the method waits until a matching element appears in the DOM.
Returns the frame
or iframe
element handle which corresponds to this frame.
This is an inverse of elementHandle.contentFrame()
. Note that returned handle actually belongs to the parent frame.
This method throws an error if the frame has been detached before frameElement()
returns.
Returns element attribute value.
This method hovers over an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
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.
Scroll the element into view if needed.
Use page.mouse to hover over the center of the element, or the specified position
.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter
option is set.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
Returns element.innerHTML
.
Returns element.innerText
.
Returns frame's name attribute as specified in the tag. If the name is empty, returns the id attribute instead.
NOTE This value is calculated once when the frame is created, and will not update if the attribute is changed later.
Parent frame, if any. Detached frames and main frames return null
.
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 suported: 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 speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Returns the ElementHandle pointing to the frame element.
The method finds an element matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns null
.
Returns the ElementHandles pointing to the frame elements. The method finds all elements matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns empty array.
This method expects selector
to point to an input element.
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 the current working directory. For empty array, clears the selected files.
This method taps an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
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.
Scroll the element into view if needed.
Use page.touchscreen to tap the center of the element, or the specified position
.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter
option is set.
When all steps combined have not finished during the specified timeout
, this method rejects with a TimeoutError. Passing zero timeout disables this.
NOTE frame.tap()
requires that the hasTouch
option of the browser context be set to true.
Returns element.textContent
.
Sends a keydown
, keypress
/input
, and keyup
event for each character in the text. frame.type
can be used to send fine-grained keyboard events. To fill values in form fields, use frame.fill(selector, value[, options])
.
To press a special key, like Control
or ArrowDown
, use keyboard.press(key[, options])
.
This method checks an element matching selector
by performing the following steps:
Find an element match matching selector
. If there is none, wait until a matching element is attached to the DOM.
Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.
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.
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 unchecked. If not, 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 when the pageFunction
returns a truthy value, returns that value.
The waitForFunction
can be used to observe viewport size change:
To pass an argument to the predicate of frame.waitForFunction
function:
Waits for the required load state to be reached.
This returns when the frame reaches a required load state, load
by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.
Returns when element specified by selector satisfies state
option. Returns null
if waiting for hidden
or detached
.
Wait for the selector
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.
This method works across navigations:
Waits for the given timeout
in milliseconds.
Note that frame.waitForTimeout()
should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.