Playwright::Frame

Returns the added tag when the script's onload fires or when the script content was injected into frame. Adds a <script> tag into the page with the desired url or content.

Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame. Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content.

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.mouse to click in the center of the element. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Ensure that the element is now checked. If not, this method rejects.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.mouse to click in the center of the element, or the specified position. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

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

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.mouse to double click in the center of the element, or the specified position. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will reject.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

NOTE frame.dblclick() dispatches two click events and a single dblclick event.

The snippet below dispatches the click event on the element. Regardless of the visibility state of the elment, click is dispatched. This is equivalend to calling element.click().

Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default. Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

DragEvent FocusEvent KeyboardEvent MouseEvent PointerEvent TouchEvent Event

You can also specify JSHandle as the property value if you want live objects to be passed into the event:

Returns the return value of pageFunction The method finds an element matching the specified selector within the frame and passes it as a first argument to pageFunction. See Working with selectors for more details. If no elements match the selector, the method throws an error. If pageFunction returns a Promise, then frame.$eval would wait for the promise to resolve and return its value. Examples:

Returns the return value of pageFunction The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to pageFunction. See Working with selectors for more details. If pageFunction returns a Promise, then frame.$$eval would wait for the promise to resolve and return its value. Examples:

Returns the return value of pageFunction If the function passed to the frame.evaluate returns a Promise, then frame.evaluate would wait for the promise to resolve and return its value. If the function passed to the frame.evaluate returns a non-Serializable value, then frame.evaluate returns undefined. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals.

A string can also be passed in instead of a function.

ElementHandle instances can be passed as an argument to the frame.evaluate:

Returns the return value of pageFunction as in-page object (JSHandle). The only difference between frame.evaluate and frame.evaluateHandle is that frame.evaluateHandle returns in-page object (JSHandle). If the function, passed to the frame.evaluateHandle, returns a Promise, then frame.evaluateHandle would wait for the promise to resolve and return its value.

A string can also be passed in instead of a function.

JSHandle instances can be passed as an argument to the frame.evaluateHandle:

This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling. If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error. Note that you can pass an empty string to clear the input field. To send fine-grained keyboard events, use frame.type(selector, text[, options]).

This method fetches an element with selector and focuses it. If there's no element matching selector, the method waits until a matching element appears in the DOM.

Returns the frame or iframe element handle which corresponds to this frame. This is an inverse of elementHandle.contentFrame(). Note that returned handle actually belongs to the parent frame. This method throws an error if the frame has been detached before frameElement() returns.

Returns element attribute value.

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.

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.mouse to hover over the center of the element, or the specified position. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

Returns element.innerHTML.

Returns element.innerText.

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

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.

Returns the page containing this frame.

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

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are: F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc. Following modification shortcuts are also suported: Shift, Control, Alt, Meta, ShiftLeft. Holding down Shift will type the text that corresponds to the key in the upper case. If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts. Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Returns the ElementHandle pointing to the frame element. The method finds an element matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns null.

Returns the ElementHandles pointing to the frame elements. The method finds all elements matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns empty array.

This method expects selector to point to an input element. Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the the current working directory. For empty array, clears the selected files.

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.touchscreen to tap the center of the element, or the specified position. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

NOTE frame.tap() requires that the hasTouch option of the browser context be set to true.

Returns element.textContent.

Returns the page title.

Sends a keydown, keypress/input, and keyup event for each character in the text. frame.type can be used to send fine-grained keyboard events. To fill values in form fields, use frame.fill(selector, value[, options]). To press a special key, like Control or ArrowDown, use keyboard.press(key[, options]).

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

Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM. Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried. Scroll the element into view if needed. Use page.mouse to click in the center of the element. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Ensure that the element is now unchecked. If not, this method rejects.

When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.

Returns frame's url.

Returns when the pageFunction returns a truthy value, returns that value. The waitForFunction can be used to observe viewport size change:

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

Waits for the required load state to be reached. This returns when the frame reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.

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

Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached. Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw. This method works across navigations:

Waits for the given timeout in milliseconds. Note that frame.waitForTimeout() should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.