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

• #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) : Nil
• #check(selector : String, options : CheckOptions?) : Nil

  This method checks an element matching selector by performing the following steps:

• #child_frames : Array(Frame)
• #click(selector : String) : Nil
• #click(selector : String, options : ClickOptions?) : Nil

  This method clicks an element matching selector by performing the following steps:

• #content : String

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

• #dblclick(selector : String) : Nil
• #dblclick(selector : String, options : DblclickOptions?) : Nil

  This method double clicks an element matching selector by performing the following steps:

• #dispatch_event(selector : String, type : String) : Nil
• #dispatch_event(selector : String, type : String, event_init : Array(Any)?) : Nil
• #dispatch_event(selector : String, type : String, event_init : Array(Any)?, options : DispatchEventOptions?) : Nil

  The snippet below dispatches the #click event on the element.

• #dispatch_event(selector : String, type : String, *event_init : Any) : 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 pageFunction The method finds an element matching the specified selector within the frame and passes it as a first argument to pageFunction.

• #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 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.

• #evaluate(page_function : String, *arg : Any) : Any
• #evaluate(page_function : String) : Any
• #evaluate(page_function : String, arg : Array(Any)?) : 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.

• #evaluate_handle(page_function : String, arg : Array(Any)?) : 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

  This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling.

• #fill(selector : String, value : String) : Nil
• #focus(selector : String, options : FocusOptions?) : Nil

  This method fetches an element with selector and focuses it.

• #focus(selector : String) : Nil
• #frame_element : ElementHandle

  Returns the frame or iframe element handle which corresponds to this frame.

• #get_attribute(selector : String, name : String) : String?
• #get_attribute(selector : String, name : String, options : GetAttributeOptions?) : String?

  Returns element attribute value.

• #goto(url : String, options : NavigateOptions?) : Response?

  Returns the main resource response.

• #goto(url : String) : Response?
• #hover(selector : String, options : HoverOptions?) : Nil

  This method hovers over an element matching selector by performing the following steps:

• #hover(selector : String) : Nil
• #inner_html(selector : String, options : InnerHTMLOptions?) : String

  Returns element.innerHTML.

• #inner_html(selector : String) : String
• #inner_text(selector : String, options : InnerTextOptions?) : String

  Returns element.innerText.

• #inner_text(selector : String) : String
• #is_detached : Bool

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

• #name : String

  Returns frame's name attribute as specified in the tag.

• #page : Page?

  Returns the page containing this frame.

• #parent_frame : Frame?

  Parent frame, if any.

• #press(selector : String, key : String) : Nil
• #press(selector : String, key : String, options : PressOptions?) : Nil

  key can specify the intended keyboardEvent.key value or a single character to generate the text for.

• #query_selector(selector : String) : ElementHandle?

  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, values : Array(ElementHandle)?)
• #select_option(selector : String, value : ElementHandle?)
• #select_option(selector : String, values : Array(ElementHandle::SelectOption)?)
• #select_option(selector : String, value : ElementHandle::SelectOption?)
• #select_option(selector : String, values : Array(String))
• #select_option(selector : String, value : String)
• #select_option(selector : String, values : Array(ElementHandle)?, options : SelectOptionOptions?)
• #select_option(selector : String, value : ElementHandle?, options : SelectOptionOptions?)
• #select_option(selector : String, values : Array(ElementHandle::SelectOption)?, options : SelectOptionOptions?)
• #select_option(selector : String, value : ElementHandle::SelectOption?, options : SelectOptionOptions?)
• #select_option(selector : String, values : Array(String), options : SelectOptionOptions?)
• #select_option(selector : String, value : String, options : SelectOptionOptions?)
• #set_content(html : String, options : SetContentOptions?) : Nil
• #set_content(html : String) : Nil
• #set_input_files(selector : String, files : Array(FileChooser::FilePayload))
• #set_input_files(selector : String, file : FileChooser::FilePayload)
• #set_input_files(selector : String, files : Array(Path))
• #set_input_files(selector : String, file : Path)
• #set_input_files(selector : String, file : Array(FileChooser::FilePayload), options : SetInputFilesOptions?)

  This method expects selector to point to an input element.

• #set_input_files(selector : String, file : FileChooser::FilePayload, options : SetInputFilesOptions?)
• #set_input_files(selector : String, file : Array(Path), options : SetInputFilesOptions?)
• #set_input_files(selector : String, file : Path, options : SetInputFilesOptions?)
• #tap(selector : String, options : TapOptions?) : Nil

  This method taps an element matching selector by performing the following steps:

• #tap(selector : String) : Nil
• #text_content(selector : String, options : TextContentOptions?) : String?

  Returns element.textContent.

• #text_content(selector : String) : String?
• #title : String

  Returns the page title.

• #type(selector : String, text : String, options : TypeOptions?) : Nil

  Sends a keydown, keypress/input, and keyup event for each character in the text.

• #type(selector : String, text : String) : Nil
• #uncheck(selector : String, options : UncheckOptions?) : 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)?, options : WaitForFunctionOptions?) : Deferred(JSHandle)

  Returns when the pageFunction returns a truthy value, returns that value.

• #wait_for_function(page_function : String, arg : Array(Any)?) : 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?, options : WaitForLoadStateOptions?) : Deferred(Nil)

  Waits for the required load state to be reached.

• #wait_for_load_state(state : LoadState?) : Deferred(Nil)
• #wait_for_load_state : Deferred(Nil)
• #wait_for_navigation(options : WaitForNavigationOptions?) : Deferred(Response?)

  Returns the main resource response.

• #wait_for_navigation : Deferred(Response?)
• #wait_for_selector(selector : String, options : WaitForSelectorOptions?) : Deferred(ElementHandle?)

  Returns when element specified by selector satisfies state option.

• #wait_for_selector(selector : String) : Deferred(ElementHandle?)
• #wait_for_timeout(timeout : Int32) : Deferred(Nil)

  Waits for the given timeout in milliseconds.

Instance Method Detail