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

Instance Method Summary

Instance Method Detail

abstract def 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. Adds a <script> tag into the page with the desired url or content.


[View source]
abstract def 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. Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content.


[View source]
abstract def check(selector : String, options : CheckOptions | Nil) : Nil #

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.


[View source]
def check(selector : String) : Nil #

[View source]
abstract def child_frames : Array(Frame) #

[View source]
abstract def click(selector : String, options : ClickOptions | Nil) : Nil #

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.


[View source]
def click(selector : String) : Nil #

[View source]
abstract def content : String #

Gets the full HTML contents of the frame, including the doctype.


[View source]
abstract def dblclick(selector : String, options : DblclickOptions | Nil) : Nil #

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.


[View source]
def dblclick(selector : String) : Nil #

[View source]
abstract def 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. 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:


[View source]
def dispatch_event(selector : String, type : String, event_init : Array(Any) | Nil) : Nil #

[View source]
def dispatch_event(selector : String, type : String) : Nil #

[View source]
def dispatch_event(selector : String, type : String, *event_init : Any) : Nil #

[View source]
abstract def 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 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:


[View source]
def eval_on_selector(selector : String, page_function : String) : Any #

[View source]
def eval_on_selector(selector : String, page_function : String, *arg : Any) : Any #

[View source]
abstract def 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 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:


[View source]
def eval_on_selector_all(selector : String, page_function : String) : Any #

[View source]
def eval_on_selector_all(selector : String, page_function : String, *arg : Any) : Any #

[View source]
abstract def evaluate(page_function : String, arg : Array(Any) | Nil) : Any #

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:


[View source]
def evaluate(page_function : String) : Any #

[View source]
def evaluate(page_function : String, *arg : Any) : Any #

[View source]
abstract def evaluate_handle(page_function : String, arg : Array(Any) | Nil) : JSHandle #

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:


[View source]
def evaluate_handle(page_function : String) : JSHandle #

[View source]
def evaluate_handle(page_function : String, *arg : Any) : JSHandle #

[View source]
abstract def 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 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]).


[View source]
def fill(selector : String, value : String) : Nil #

[View source]
abstract def focus(selector : String, options : FocusOptions | Nil) : Nil #

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.


[View source]
def focus(selector : String) : Nil #

[View source]
abstract def frame_element : ElementHandle #

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.


[View source]
abstract def get_attribute(selector : String, name : String, options : GetAttributeOptions | Nil) : String | Nil #

Returns element attribute value.


[View source]
def get_attribute(selector : String, name : String) : String | Nil #

[View source]
abstract def goto(url : String, options : NavigateOptions | Nil) : Response | Nil #

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. frame.goto will throw an error if:

there's an SSL error (e.g. in case of self-signed certificates). target URL is invalid. the timeout is exceeded during navigation. the remote server does not respond or is unreachable. the main resource failed to load.

frame.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling response.status().

NOTE frame.goto either throws an error or returns a main resource response. The only exceptions are navigation to about:blank or navigation to the same URL with a different hash, which would succeed and return null. NOTE Headless mode doesn't support navigation to a PDF document. See the upstream issue.


[View source]
def goto(url : String) : Response | Nil #

[View source]
abstract def hover(selector : String, options : HoverOptions | Nil) : Nil #

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.


[View source]
def hover(selector : String) : Nil #

[View source]
abstract def inner_html(selector : String, options : InnerHTMLOptions | Nil) : String #

Returns element.innerHTML.


[View source]
def inner_html(selector : String) : String #

[View source]
abstract def inner_text(selector : String, options : InnerTextOptions | Nil) : String #

Returns element.innerText.


[View source]
def inner_text(selector : String) : String #

[View source]
abstract def is_detached : Bool #

Returns true if the frame has been detached, or false otherwise.


[View source]
abstract def name : String #

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.


[View source]
abstract def page : Page | Nil #

Returns the page containing this frame.


[View source]
abstract def parent_frame : Frame | Nil #

Parent frame, if any. Detached frames and main frames return null.


[View source]
abstract def 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. 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.


[View source]
def press(selector : String, key : String) : Nil #

[View source]
abstract def query_selector(selector : String) : ElementHandle | Nil #

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.


[View source]
abstract def query_selector_all(selector : String) : Array(ElementHandle) #

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.


[View source]
def select_option(selector : String, value : String, options : SelectOptionOptions | Nil) #

[View source]
def select_option(selector : String, values : Array(String), options : SelectOptionOptions | Nil) #

[View source]
def select_option(selector : String, value : ElementHandle::SelectOption | Nil, options : SelectOptionOptions | Nil) #

[View source]
abstract def select_option(selector : String, values : Array(ElementHandle::SelectOption) | Nil, options : SelectOptionOptions | Nil) #

[View source]
def select_option(selector : String, value : ElementHandle | Nil, options : SelectOptionOptions | Nil) #

[View source]
abstract def select_option(selector : String, values : Array(ElementHandle) | Nil, options : SelectOptionOptions | Nil) #

[View source]
def select_option(selector : String, value : String) #

[View source]
def select_option(selector : String, values : Array(String)) #

[View source]
def select_option(selector : String, value : ElementHandle::SelectOption | Nil) #

[View source]
def select_option(selector : String, values : Array(ElementHandle::SelectOption) | Nil) #

[View source]
def select_option(selector : String, value : ElementHandle | Nil) #

[View source]
def select_option(selector : String, values : Array(ElementHandle) | Nil) #

[View source]
abstract def set_content(html : String, options : SetContentOptions | Nil) : Nil #

[View source]
def set_content(html : String) : Nil #

[View source]
def set_input_files(selector : String, file : Path, options : SetInputFilesOptions | Nil) #

[View source]
abstract def set_input_files(selector : String, file : Array(Path), options : SetInputFilesOptions | Nil) #

[View source]
def set_input_files(selector : String, file : FileChooser::FilePayload, options : SetInputFilesOptions | Nil) #

[View source]
abstract def set_input_files(selector : String, file : Array(FileChooser::FilePayload), options : SetInputFilesOptions | Nil) #

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.


[View source]
def set_input_files(selector : String, file : Path) #

[View source]
def set_input_files(selector : String, files : Array(Path)) #

[View source]
def set_input_files(selector : String, file : FileChooser::FilePayload) #

[View source]
def set_input_files(selector : String, files : Array(FileChooser::FilePayload)) #

[View source]
abstract def tap(selector : String, options : TapOptions | Nil) : Nil #

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.


[View source]
def tap(selector : String) : Nil #

[View source]
abstract def text_content(selector : String, options : TextContentOptions | Nil) : String | Nil #

Returns element.textContent.


[View source]
def text_content(selector : String) : String | Nil #

[View source]
abstract def title : String #

Returns the page title.


[View source]
abstract def type(selector : String, text : String, options : TypeOptions | Nil) : Nil #

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


[View source]
def type(selector : String, text : String) : Nil #

[View source]
abstract def uncheck(selector : String, options : UncheckOptions | Nil) : Nil #

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.


[View source]
def uncheck(selector : String) : Nil #

[View source]
abstract def url : String #

Returns frame's url.


[View source]
abstract def 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. The waitForFunction can be used to observe viewport size change:

To pass an argument to the predicate of frame.waitForFunction function:


[View source]
def wait_for_function(page_function : String, arg : Array(Any) | Nil) : Deferred(JSHandle) #

[View source]
def wait_for_function(page_function : String) : Deferred(JSHandle) #

[View source]
def wait_for_function(page_function : String, *arg : Any) : Deferred(JSHandle) #

[View source]
abstract def wait_for_load_state(state : LoadState | Nil, options : WaitForLoadStateOptions | Nil) : Deferred(Nil) #

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.


[View source]
def wait_for_load_state(state : LoadState | Nil) : Deferred(Nil) #

[View source]
def wait_for_load_state : Deferred(Nil) #

[View source]
abstract def wait_for_navigation(options : WaitForNavigationOptions | Nil) : Deferred(Response | Nil) #

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null. This method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause the frame to navigate. Consider this example:

NOTE Usage of the History API to change the URL is considered a navigation.


[View source]
def wait_for_navigation : Deferred(Response | Nil) #

[View source]
abstract def wait_for_selector(selector : String, options : WaitForSelectorOptions | Nil) : Deferred(ElementHandle | Nil) #

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:


[View source]
def wait_for_selector(selector : String) : Deferred(ElementHandle | Nil) #

[View source]
abstract def wait_for_timeout(timeout : Int32) : Deferred(Nil) #

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.


[View source]