Frame
At every point of time, page exposes its current frame tree via the page.main_frame and frame.child_frames 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:
- Sync
- Async
- frame.add_script_tag(**kwargs)
- frame.add_style_tag(**kwargs)
- frame.check(selector, **kwargs)
- frame.child_frames
- frame.click(selector, **kwargs)
- frame.content()
- frame.dblclick(selector, **kwargs)
- frame.dispatch_event(selector, type, **kwargs)
- frame.eval_on_selector(selector, expression, **kwargs)
- frame.eval_on_selector_all(selector, expression, **kwargs)
- frame.evaluate(expression, **kwargs)
- frame.evaluate_handle(expression, **kwargs)
- frame.expect_navigation(**kwargs)
- frame.fill(selector, value, **kwargs)
- frame.focus(selector, **kwargs)
- frame.frame_element()
- frame.get_attribute(selector, name, **kwargs)
- frame.goto(url, **kwargs)
- frame.hover(selector, **kwargs)
- frame.inner_html(selector, **kwargs)
- frame.inner_text(selector, **kwargs)
- frame.is_checked(selector, **kwargs)
- frame.is_detached()
- frame.is_disabled(selector, **kwargs)
- frame.is_editable(selector, **kwargs)
- frame.is_enabled(selector, **kwargs)
- frame.is_hidden(selector, **kwargs)
- frame.is_visible(selector, **kwargs)
- frame.name
- frame.page
- frame.parent_frame
- frame.press(selector, key, **kwargs)
- frame.query_selector(selector)
- frame.query_selector_all(selector)
- frame.select_option(selector, **kwargs)
- frame.set_content(html, **kwargs)
- frame.set_input_files(selector, files, **kwargs)
- frame.tap(selector, **kwargs)
- frame.text_content(selector, **kwargs)
- frame.title()
- frame.type(selector, text, **kwargs)
- frame.uncheck(selector, **kwargs)
- frame.url
- frame.wait_for_function(expression, **kwargs)
- frame.wait_for_load_state(**kwargs)
- frame.wait_for_selector(selector, **kwargs)
- frame.wait_for_timeout(timeout)
#
frame.add_script_tag(**kwargs)content
<str> Raw JavaScript content to be injected into frame.path
<Union[str, pathlib.Path]> Path to the JavaScript file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to the current working directory.type
<str> Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.url
<str> URL of a script to be added.- returns: <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.
#
frame.add_style_tag(**kwargs)content
<str> Raw CSS content to be injected into frame.path
<Union[str, pathlib.Path]> Path to the CSS file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to the current working directory.url
<str> URL of the<link>
tag.- returns: <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.
#
frame.check(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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
no_wait_after
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.
#
frame.child_frames#
frame.click(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.button
<"left"|"right"|"middle"> Defaults toleft
.click_count
<int> defaults to 1. See UIEvent.detail.delay
<float> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.position
<Dict> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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
no_wait_after
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.
#
frame.content()- returns: <str>
Gets the full HTML contents of the frame, including the doctype.
#
frame.dblclick(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.button
<"left"|"right"|"middle"> Defaults toleft
.delay
<float> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.position
<Dict> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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
no_wait_after
option is set. Note that if the first click of thedblclick()
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.
#
frame.dispatch_event(selector, type, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.type
<str> DOM event type:"click"
,"dragstart"
, etc.event_init
<[EvaluationArgument]> Optional event-specific initialization properties.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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().
- Sync
- Async
Under the hood, it creates an instance of an event based on the given type
, initializes it with event_init
properties and dispatches it on the element. Events are composed
, cancelable
and bubble by default.
Since event_init
is event-specific, please refer to the events documentation for the lists of initial properties:
You can also specify JSHandle
as the property value if you want live objects to be passed into the event:
- Sync
- Async
#
frame.eval_on_selector(selector, expression, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
Returns the return value of expression
.
The method finds an element matching the specified selector within the frame and passes it as a first argument to expression
. See Working with selectors for more details. If no elements match the selector, the method throws an error.
If expression
returns a Promise, then frame.eval_on_selector(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
- Sync
- Async
#
frame.eval_on_selector_all(selector, expression, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
Returns the return value of expression
.
The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to expression
. See Working with selectors for more details.
If expression
returns a Promise, then frame.eval_on_selector_all(selector, expression, **kwargs) would wait for the promise to resolve and return its value.
Examples:
- Sync
- Async
#
frame.evaluate(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <Serializable>
Returns the return value of expression
.
If the function passed to the frame.evaluate(expression, **kwargs) returns a Promise, then frame.evaluate(expression, **kwargs) would wait for the promise to resolve and return its value.
If the function passed to the frame.evaluate(expression, **kwargs) returns a non-Serializable value, then frame.evaluate(expression, **kwargs) returns undefined
. Playwright also supports transferring some additional values that are not serializable by JSON
: -0
, NaN
, Infinity
, -Infinity
.
- Sync
- Async
A string can also be passed in instead of a function.
- Sync
- Async
ElementHandle instances can be passed as an argument to the frame.evaluate(expression, **kwargs):
- Sync
- Async
#
frame.evaluate_handle(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.- returns: <JSHandle>
Returns the return value of expression
as a JSHandle.
The only difference between frame.evaluate(expression, **kwargs) and frame.evaluate_handle(expression, **kwargs) is that [method: Frame.evaluateHandle`] returns JSHandle.
If the function, passed to the frame.evaluate_handle(expression, **kwargs), returns a Promise, then frame.evaluate_handle(expression, **kwargs) would wait for the promise to resolve and return its value.
- Sync
- Async
A string can also be passed in instead of a function.
- Sync
- Async
JSHandle instances can be passed as an argument to the frame.evaluate_handle(expression, **kwargs):
- Sync
- Async
#
frame.expect_navigation(**kwargs)timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.url
<str|Pattern|Callable[URL]:bool> URL string, URL regex pattern or predicate receiving URL to match while waiting for the navigation.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <EventContextManager[Response]>
Waits for the frame navigation and 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:
- Sync
- Async
note
Usage of the History API to change the URL is considered a navigation.
#
frame.fill(selector, value, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.value
<str> Value to fill for the<input>
,<textarea>
or[contenteditable]
element.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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 is inside the <label>
element that has associated control, that control will be filled instead. If the element to be filled 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, **kwargs).
#
frame.focus(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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.
#
frame.frame_element()- returns: <ElementHandle>
Returns the frame
or iframe
element handle which corresponds to this frame.
This is an inverse of element_handle.content_frame(). Note that returned handle actually belongs to the parent frame.
This method throws an error if the frame has been detached before frameElement()
returns.
- Sync
- Async
#
frame.get_attribute(selector, name, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.name
<str> Attribute name to get the value for.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|str>
Returns element attribute value.
#
frame.goto(url, **kwargs)url
<str> URL to navigate frame to. The url should include scheme, e.g.https://
.referer
<str> Referer header value. If provided it will take preference over the referer header value set by page.set_extra_http_headers(headers).timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
- returns: <NoneType|Response>
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.
#
frame.hover(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.position
<Dict> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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.
#
frame.inner_html(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <str>
Returns element.innerHTML
.
#
frame.inner_text(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <str>
Returns element.innerText
.
#
frame.is_checked(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
#
frame.is_detached()- returns: <bool>
Returns true
if the frame has been detached, or false
otherwise.
#
frame.is_disabled(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is disabled, the opposite of enabled.
#
frame.is_editable(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is editable.
#
frame.is_enabled(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is enabled.
#
frame.is_hidden(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is hidden, the opposite of visible. selector
that does not match any elements is considered hidden.
#
frame.is_visible(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <bool>
Returns whether the element is visible. selector
that does not match any elements is considered not visible.
#
frame.name- returns: <str>
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.
#
frame.page- returns: <Page>
Returns the page containing this frame.
#
frame.parent_frameParent frame, if any. Detached frames and main frames return null
.
#
frame.press(selector, key, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.key
<str> Name of the key to press or a character to generate, such asArrowLeft
ora
.delay
<float> Time to wait betweenkeydown
andkeyup
in milliseconds. Defaults to 0.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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 supported: 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.
#
frame.query_selector(selector)selector
<str> A selector to query for. See working with selectors for more details.- returns: <NoneType|ElementHandle>
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
.
#
frame.query_selector_all(selector)selector
<str> A selector to query for. See working with selectors for more details.- returns: <List[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.
#
frame.select_option(selector, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.element
<ElementHandle|List[ElementHandle]> Option elements to select. Optional.index
<int|List[int]> Options to select by index. Optional.value
<str|List[str]> Options to select by value. If the<select>
has themultiple
attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.label
<str|List[str]> Options to select by label. If the<select>
has themultiple
attribute, all given options are selected, otherwise only the first option matching one of the passed options is selected. Optional.- returns: <List[str]>
Returns the array of option values that have been successfully selected.
Triggers a change
and input
event once all the provided options have been selected. If there's no <select>
element matching selector
, the method throws an error.
Will wait until all specified options are present in the <select>
element.
- Sync
- Async
#
frame.set_content(html, **kwargs)html
<str> HTML markup to assign to the page.timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.wait_until
<"load"|"domcontentloaded"|"networkidle"> When to consider operation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider operation to be finished when theDOMContentLoaded
event is fired.'load'
- consider operation to be finished when theload
event is fired.'networkidle'
- consider operation to be finished when there are no network connections for at least500
ms.
#
frame.set_input_files(selector, files, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.files
<Union[str, pathlib.Path]|List[Union[str, pathlib.Path]]|Dict|List[Dict]>no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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.
#
frame.tap(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.modifiers
<List["Alt"|"Control"|"Meta"|"Shift"]> Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.position
<Dict> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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
no_wait_after
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.
#
frame.text_content(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|str>
Returns element.textContent
.
#
frame.title()- returns: <str>
Returns the page title.
#
frame.type(selector, text, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.text
<str> A text to type into a focused element.delay
<float> Time to wait between key presses in milliseconds. Defaults to 0.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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, **kwargs).
To press a special key, like Control
or ArrowDown
, use keyboard.press(key, **kwargs).
- Sync
- Async
#
frame.uncheck(selector, **kwargs)selector
<str> A selector to search for element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.force
<bool> Whether to bypass the actionability checks. Defaults tofalse
.no_wait_after
<bool> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults tofalse
.timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.
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
no_wait_after
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.
#
frame.url- returns: <str>
Returns frame's url.
#
frame.wait_for_function(expression, **kwargs)expression
<str> JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression.arg
<[EvaluationArgument]> Optional argument to pass toexpression
.polling
<float|"raf"> Ifpolling
is'raf'
, thenexpression
is constantly executed inrequestAnimationFrame
callback. Ifpolling
is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults toraf
.timeout
<float> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout).- returns: <JSHandle>
Returns when the expression
returns a truthy value, returns that value.
The frame.wait_for_function(expression, **kwargs) can be used to observe viewport size change:
- Sync
- Async
To pass an argument to the predicate of frame.waitForFunction
function:
- Sync
- Async
#
frame.wait_for_load_state(**kwargs)state
<"load"|"domcontentloaded"|"networkidle"> Optional load state to wait for, defaults toload
. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:'load'
- wait for theload
event to be fired.'domcontentloaded'
- wait for theDOMContentLoaded
event to be fired.'networkidle'
- wait until there are no network connections for at least500
ms.
timeout
<float> Maximum operation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_navigation_timeout(timeout), browser_context.set_default_timeout(timeout), page.set_default_navigation_timeout(timeout) or page.set_default_timeout(timeout) methods.
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.
- Sync
- Async
#
frame.wait_for_selector(selector, **kwargs)selector
<str> A selector to query for. See working with selectors for more details.state
<"attached"|"detached"|"visible"|"hidden"> Defaults to'visible'
. Can be either:'attached'
- wait for element to be present in DOM.'detached'
- wait for element to not be present in DOM.'visible'
- wait for element to have non-empty bounding box and novisibility:hidden
. Note that element without any content or withdisplay:none
has an empty bounding box and is not considered visible.'hidden'
- wait for element to be either detached from DOM, or have an empty bounding box orvisibility:hidden
. This is opposite to the'visible'
option.
timeout
<float> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browser_context.set_default_timeout(timeout) or page.set_default_timeout(timeout) methods.- returns: <NoneType|ElementHandle>
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:
- Sync
- Async
#
frame.wait_for_timeout(timeout)timeout
<float> A timeout to wait for
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.