Frame
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:
- 'frameattached' - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
- 'framenavigated' - fired when the frame commits navigation to a different URL.
- '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:
- frame.$(selector)
- frame.$$(selector)
- frame.$eval(selector, pageFunction[, arg])
- frame.$$eval(selector, pageFunction[, arg])
- frame.addScriptTag(options)
- frame.addStyleTag(options)
- frame.check(selector, [options])
- frame.childFrames()
- frame.click(selector[, options])
- frame.content()
- frame.dblclick(selector[, options])
- frame.dispatchEvent(selector, type[, eventInit, options])
- frame.evaluate(pageFunction[, arg])
- frame.evaluateHandle(pageFunction[, arg])
- frame.fill(selector, value[, options])
- frame.focus(selector[, options])
- frame.frameElement()
- frame.getAttribute(selector, name[, options])
- frame.goto(url[, options])
- frame.hover(selector[, options])
- frame.innerHTML(selector[, options])
- frame.innerText(selector[, options])
- frame.isDetached()
- frame.name()
- frame.parentFrame()
- frame.press(selector, key[, options])
- frame.selectOption(selector, values[, options])
- frame.setContent(html[, options])
- frame.setInputFiles(selector, files[, options])
- frame.textContent(selector[, options])
- frame.title()
- frame.type(selector, text[, options])
- frame.uncheck(selector, [options])
- frame.url()
- frame.waitForFunction(pageFunction[, arg, options])
- frame.waitForLoadState([state[, options]])
- frame.waitForNavigation([options])
- frame.waitForSelector(selector[, options])
- frame.waitForTimeout(timeout)
#
frame.$(selector)selector
<string> A selector to query frame for. See working with selectors) for more details.- returns: <Promise<?ElementHandle>> Promise which resolves to 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, the return value resolves to null
.
#
frame.$$(selector)selector
<string> A selector to query frame for. See working with selectors for more details.- returns: <Promise<Array<ElementHandle>>> Promise which resolves to 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, the return value resolves to []
.
#
frame.$eval(selector, pageFunction[, arg])selector
<string> A selector to query frame for. See working with selectors for more details.pageFunction
<function(Element)> Function to be evaluated in browser contextarg
<EvaluationArgument> Optional argument to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to 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:
#
frame.$$eval(selector, pageFunction[, arg])selector
<string> A selector to query frame for. See working with selectors for more details.pageFunction
<function(Array<Element>)> Function to be evaluated in browser contextarg
<EvaluationArgument> Optional argument to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to 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:
#
frame.addScriptTag(options)options
<Object>url
<string> URL of a script to be added.path
<string> Path to the JavaScript file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw JavaScript content to be injected into frame.type
<string> Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.
- returns: <Promise<ElementHandle>> which resolves to 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.addStyleTag(options)options
<Object>url
<string> URL of the<link>
tag.path
<string> Path to the CSS file to be injected into frame. Ifpath
is a relative path, then it is resolved relative to current working directory.content
<string> Raw CSS content to be injected into frame.
- returns: <Promise<ElementHandle>> which resolves to 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, [options])selector
<string> A selector to search for checkbox to check. If there are multiple elements satisfying the selector, the first will be checked. See working with selectors for more details.options
<Object>force
<boolean> Whether to bypass the actionability checks. Defaults tofalse
.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully checked. The Promise will be rejected if there is no element matchingselector
.
This method waits for an element matching selector
, waits for actionability checks. Then, if the element is not already checked, this method scrolls the element into view and uses elementHandle.click to click in the center of the element.
If there's no element matching selector
, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.
#
frame.childFrames()#
frame.click(selector[, options])selector
<string> A selector to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked. See working with selectors for more details.options
<Object>button
<"left"|"right"|"middle"> Defaults toleft
.clickCount
<number> defaults to 1. See UIEvent.detail.delay
<number> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.position
<Object> A point to click relative to the top-left corner of element padding box. If not specified, clicks to some visible point of the element.modifiers
<Array<"Alt"|"Control"|"Meta"|"Shift">> Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used.force
<boolean> Whether to bypass the actionability checks. Defaults tofalse
.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully clicked. The Promise will be rejected if there is no element matchingselector
.
This method waits for an element matching selector
, waits for actionability checks, then scrolls the element into view if needed and uses page.mouse to click in the center of the element.
If there's no element matching selector
, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.
#
frame.content()Gets the full HTML contents of the frame, including the doctype.
#
frame.dblclick(selector[, options])selector
<string> A selector to search for element to double click. If there are multiple elements satisfying the selector, the first will be double clicked. See working with selectors for more details.options
<Object>button
<"left"|"right"|"middle"> Defaults toleft
.delay
<number> Time to wait betweenmousedown
andmouseup
in milliseconds. Defaults to 0.position
<Object> A point to double click relative to the top-left corner of element padding box. If not specified, double clicks to some visible point of the element.modifiers
<Array<"Alt"|"Control"|"Meta"|"Shift">> Modifier keys to press. Ensures that only these modifiers are pressed during the double click, and then restores current modifiers back. If not specified, currently pressed modifiers are used.force
<boolean> Whether to bypass the actionability checks. Defaults tofalse
.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully double clicked. The Promise will be rejected if there is no element matchingselector
.
This method waits for an element matching selector
, waits for actionability checks, then scrolls the element into view if needed and uses page.mouse to double click in the center of the element.
If there's no element matching selector
, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.
Bear in mind that if the first click of the dblclick()
triggers a navigation event, there will be an exception.
NOTE
frame.dblclick()
dispatches twoclick
events and a singledblclick
event.
#
frame.dispatchEvent(selector, type[, eventInit, options])selector
<string> A selector to search for element to use. If there are multiple elements satisfying the selector, the first will be double clicked. See working with selectors for more details.type
<string> DOM event type:"click"
,"dragstart"
, etc.eventInit
<Object> event-specific initialization properties.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise>
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:
You can also specify
JSHandle
as the property value if you want live objects to be passed into the event:
#
frame.evaluate(pageFunction[, arg])pageFunction
<function|string> Function to be evaluated in browser contextarg
<EvaluationArgument> Optional argument to pass topageFunction
- returns: <Promise<Serializable>> Promise which resolves to 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
resolves to 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
:
#
frame.evaluateHandle(pageFunction[, arg])pageFunction
<function|string> Function to be evaluated in the page contextarg
<EvaluationArgument> Optional argument to pass topageFunction
- returns: <Promise<JSHandle>> Promise which resolves to 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
:
#
frame.fill(selector, value[, options])selector
<string> A selector to query page for. See working with selectors for more details.value
<string> Value to fill for the<input>
,<textarea>
or[contenteditable]
element.options
<Object>noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise>
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
.
#
frame.focus(selector[, options])selector
<string> A selector of an element to focus. If there are multiple elements satisfying the selector, the first will be focused. See working with selectors for more details.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully focused. The promise will be rejected if there is no element matchingselector
.
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.frameElement()- returns: <Promise<ElementHandle>> Promise that resolves with a
frame
oriframe
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.
#
frame.getAttribute(selector, name[, options])selector
<string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be picked. See working with selectors for more details.name
<string> Attribute name to get the value for.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<null|string>>
Returns element attribute value.
#
frame.goto(url[, options])url
<string> URL to navigate frame to. The url should include scheme, e.g.https://
.options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.waitUntil
<"load"|"domcontentloaded"|"networkidle"> When to consider navigation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider navigation to be finished when theDOMContentLoaded
event is fired.'load'
- consider navigation to be finished when theload
event is fired.'networkidle'
- consider navigation to be finished when there are no network connections for at least500
ms.
referer
<string> Referer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders().
- returns: <Promise<?Response>> Promise which resolves to 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 toabout:blank
or navigation to the same URL with a different hash, which would succeed and returnnull
.
NOTE Headless mode doesn't support navigation to a PDF document. See the upstream issue.
#
frame.hover(selector[, options])selector
<string> A selector to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered. See working with selectors for more details.options
<Object>position
<Object> A point to hover relative to the top-left corner of element padding box. If not specified, hovers over some visible point of the element.modifiers
<Array<"Alt"|"Control"|"Meta"|"Shift">> Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.force
<boolean> Whether to bypass the actionability checks. Defaults tofalse
.timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully hovered. Promise gets rejected if there's no element matchingselector
.
This method waits for an element matching selector
, waits for actionability checks, then scrolls the element into view if needed and uses page.mouse to hover over the center of the element.
If there's no element matching selector
, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.
#
frame.innerHTML(selector[, options])selector
<string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be picked. See working with selectors for more details.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<string>>
Resolves to the element.innerHTML
.
#
frame.innerText(selector[, options])selector
<string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be picked. See working with selectors for more details.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<string>>
Resolves to the element.innerText
.
#
frame.isDetached()- returns: <boolean>
Returns true
if the frame has been detached, or false
otherwise.
#
frame.name()- returns: <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.
#
frame.parentFrame()- returns: <?Frame> Parent frame, if any. Detached frames and main frames return
null
.
#
frame.press(selector, key[, options])selector
<string> A selector of an element to type into. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.key
<string> Name of the key to press or a character to generate, such asArrowLeft
ora
.options
<Object>delay
<number> Time to wait betweenkeydown
andkeyup
in milliseconds. Defaults to 0.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise>
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.
#
frame.selectOption(selector, values[, options])selector
<string> A selector to query frame for. See working with selectors for more details.values
<null|string|ElementHandle|Array<string>|Object|Array<ElementHandle>|Array<Object>> Options to select. If the<select>
has themultiple
attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are equivalent to{value:'string'}
. Option is considered matching if all specified properties match.options
<Object>noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<Array<string>>> An 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.
#
frame.setContent(html[, options])html
<string> HTML markup to assign to the page.options
<Object> Parameters which might have the following properties:timeout
<number> Maximum time in milliseconds for resources to load, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.waitUntil
<"load"|"domcontentloaded"|"networkidle"> When to consider navigation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider setting content to be finished when theDOMContentLoaded
event is fired.'load'
- consider setting content to be finished when theload
event is fired.'networkidle'
- consider setting content to be finished when there are no network connections for at least500
ms.
- returns: <Promise>
#
frame.setInputFiles(selector, files[, options])selector
<string> A selector to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked. See working with selectors for more details.files
<string|Array<string>|Object|Array<Object>>options
<Object>noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise>
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 current working directory. For empty array, clears the selected files.
#
frame.textContent(selector[, options])selector
<string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be picked. See working with selectors for more details.options
<Object>timeout
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<null|string>>
Resolves to the element.textContent
.
#
frame.title()#
frame.type(selector, text[, options])selector
<string> A selector of an element to type into. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.text
<string> A text to type into a focused element.options
<Object>delay
<number> Time to wait between key presses in milliseconds. Defaults to 0.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise>
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
.
To press a special key, like Control
or ArrowDown
, use keyboard.press
.
#
frame.uncheck(selector, [options])selector
<string> A selector to search for uncheckbox to check. If there are multiple elements satisfying the selector, the first will be checked. See working with selectors for more details.options
<Object>force
<boolean> Whether to bypass the actionability checks. Defaults tofalse
.noWaitAfter
<boolean> 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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the element matching
selector
is successfully unchecked. The Promise will be rejected if there is no element matchingselector
.
This method waits for an element matching selector
, waits for actionability checks. Then, if the element is not already unchecked, this method scrolls the element into view and uses elementHandle.click to click in the center of the element.
If there's no element matching selector
, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.
#
frame.url()- returns: <string>
Returns frame's url.
#
frame.waitForFunction(pageFunction[, arg, options])pageFunction
<function|string> Function to be evaluated in browser contextarg
<EvaluationArgument> Optional argument to pass topageFunction
options
<Object> Optional waiting parameterspolling
<number|"raf"> Ifpolling
is'raf'
, thenpageFunction
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
<number> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<JSHandle>> Promise which resolves when the
pageFunction
returns a truthy value. It resolves to a JSHandle of the truthy value.
The waitForFunction
can be used to observe viewport size change:
To pass an argument from Node.js to the predicate of frame.waitForFunction
function:
#
frame.waitForLoadState([state[, options]])state
<"load"|"domcontentloaded"|"networkidle"> Load state to wait for, defaults toload
. If the state has been already reached while loading current document, the method resolves immediately.'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.
options
<Object>timeout
<number> Maximum waiting time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise> Promise which resolves when the required load state has been reached.
This resolves 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.
#
frame.waitForNavigation([options])options
<Object> Navigation parameters which might have the following properties:timeout
<number> Maximum navigation time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.url
<string|RegExp|Function> URL string, URL regex pattern or predicate receiving URL to match while waiting for the navigation.waitUntil
<"load"|"domcontentloaded"|"networkidle"> When to consider navigation succeeded, defaults toload
. Events can be either:'domcontentloaded'
- consider navigation to be finished when theDOMContentLoaded
event is fired.'load'
- consider navigation to be finished when theload
event is fired.'networkidle'
- consider navigation to be finished when there are no network connections for at least500
ms.
- returns: <Promise<?Response>> Promise which resolves to 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 resolves when the frame navigates 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.
#
frame.waitForSelector(selector[, options])selector
<string> A selector of an element to wait for. See working with selectors for more details.options
<Object>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
<number> Maximum time in milliseconds, defaults to 30 seconds, pass0
to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
- returns: <Promise<?ElementHandle>> Promise which resolves when element specified by selector satisfies
state
option. Resolves tonull
if waiting forhidden
ordetached
.
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:
#
frame.waitForTimeout(timeout)Returns a promise that resolves after the timeout.
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.