Skip to main content
Version: 1.15

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:

An example of dumping frame tree:

const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
(async () => {  const browser = await firefox.launch();  const page = await browser.newPage();  await page.goto('https://www.google.com/chrome/browser/canary.html');  dumpFrameTree(page.mainFrame(), '');  await browser.close();
  function dumpFrameTree(frame, indent) {    console.log(indent + frame.url());    for (const child of frame.childFrames()) {      dumpFrameTree(child, indent + '  ');    }  }})();

frame.$(selector[, options])#

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.$$(selector)#

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.$eval(selector, pageFunction[, arg, options])#

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(selector, pageFunction[, arg, options]) would wait for the promise to resolve and return its value.

Examples:

const searchValue = await frame.$eval('#search', el => el.value);const preloadHref = await frame.$eval('link[rel=preload]', el => el.href);const html = await frame.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');

frame.$$eval(selector, pageFunction[, arg])#

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(selector, pageFunction[, arg]) would wait for the promise to resolve and return its value.

Examples:

const divsCounts = await frame.$$eval('div', (divs, min) => divs.length >= min, 10);

frame.addScriptTag([options])#

  • options <Object>
    • content <string> Raw JavaScript content to be injected into frame.#
    • path <string> Path to the JavaScript file to be injected into frame. If path is a relative path, then it is resolved relative to the current working directory.#
    • type <string> Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.#
    • url <string> URL of a script to be added.#
  • returns: <Promise<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.addStyleTag([options])#

  • options <Object>
    • content <string> Raw CSS content to be injected into frame.#
    • path <string> Path to the CSS file to be injected into frame. If path is a relative path, then it is resolved relative to the current working directory.#
    • url <string> URL of the <link> tag.#
  • returns: <Promise<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[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
  3. 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.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  7. Ensure that the element is now checked. If not, this method throws.

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

frame.childFrames()#

frame.click(selector[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • button <"left"|"right"|"middle"> Defaults to left.#
    • clickCount <number> defaults to 1. See UIEvent.detail.#
    • delay <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers <Array<"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.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. 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.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element, or the specified position.
  5. 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 throws a TimeoutError. Passing zero timeout disables this.

frame.content()#

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

frame.dblclick(selector[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • button <"left"|"right"|"middle"> Defaults to left.#
    • delay <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.#
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers <Array<"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.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. 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.
  3. Scroll the element into view if needed.
  4. Use page.mouse to double click in the center of the element, or the specified position.
  5. 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 throw.

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

note

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

frame.dispatchEvent(selector, type[, eventInit, options])#

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

await frame.dispatchEvent('button#submit', '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:

// Note you can only create DataTransfer in Chromium and Firefoxconst dataTransfer = await frame.evaluateHandle(() => new DataTransfer());await frame.dispatchEvent('#source', 'dragstart', { dataTransfer });

frame.dragAndDrop(source, target[, options])#

  • source <string>#
  • target <string>#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • sourcePosition <Object> Clicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • targetPosition <Object> Drops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

frame.evaluate(pageFunction[, arg])#

Returns the return value of pageFunction.

If the function passed to the frame.evaluate(pageFunction[, arg]) returns a Promise, then frame.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.

If the function passed to the frame.evaluate(pageFunction[, arg]) returns a non-Serializable value, then frame.evaluate(pageFunction[, arg]) returns undefined. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

const result = await frame.evaluate(([x, y]) => {  return Promise.resolve(x * y);}, [7, 8]);console.log(result); // prints "56"

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

console.log(await frame.evaluate('1 + 2')); // prints "3"

ElementHandle instances can be passed as an argument to the frame.evaluate(pageFunction[, arg]):

const bodyHandle = await frame.$('body');const html = await frame.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);await bodyHandle.dispose();

frame.evaluateHandle(pageFunction[, arg])#

Returns the return value of pageFunction as a JSHandle.

The only difference between frame.evaluate(pageFunction[, arg]) and frame.evaluateHandle(pageFunction[, arg]) is that frame.evaluateHandle(pageFunction[, arg]) returns JSHandle.

If the function, passed to the frame.evaluateHandle(pageFunction[, arg]), returns a Promise, then frame.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.

const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window));aWindowHandle; // Handle for the window object.

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

const aHandle = await frame.evaluateHandle('document'); // Handle for the 'document'.

JSHandle instances can be passed as an argument to the frame.evaluateHandle(pageFunction[, arg]):

const aHandle = await frame.evaluateHandle(() => document.body);const resultHandle = await frame.evaluateHandle(([body, suffix]) => body.innerHTML + suffix, [aHandle, 'hello']);console.log(await resultHandle.jsonValue());await resultHandle.dispose();

frame.fill(selector, value[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • value <string> Value to fill for the <input>, <textarea> or [contenteditable] element.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

To send fine-grained keyboard events, use frame.type(selector, text[, options]).

frame.focus(selector[, 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.

frame.frameElement()#

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.

const frameElement = await frame.frameElement();const contentFrame = await frameElement.contentFrame();console.log(frame === contentFrame);  // -> true

frame.getAttribute(selector, name[, options])#

Returns element attribute value.

frame.goto(url[, options])#

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

The method 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.

The method 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

The method 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[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers <Array<"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 <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. 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.
  3. Scroll the element into view if needed.
  4. Use page.mouse to hover over the center of the element, or the specified position.
  5. 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 throws a TimeoutError. Passing zero timeout disables this.

frame.innerHTML(selector[, options])#

Returns element.innerHTML.

frame.innerText(selector[, options])#

Returns element.innerText.

frame.inputValue(selector[, options])#

Returns input.value for the selected <input> or <textarea> or <select> element. Throws for non-input elements.

frame.isChecked(selector[, options])#

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

frame.isDetached()#

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

frame.isDisabled(selector[, options])#

Returns whether the element is disabled, the opposite of enabled.

frame.isEditable(selector[, options])#

Returns whether the element is editable.

frame.isEnabled(selector[, options])#

Returns whether the element is enabled.

frame.isHidden(selector[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> DEPRECATED This option is ignored. frame.isHidden(selector[, options]) does not wait for the element to become hidden and returns immediately.#
  • returns: <Promise<boolean>>#

Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.

frame.isVisible(selector[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> DEPRECATED This option is ignored. frame.isVisible(selector[, options]) does not wait for the element to become visible and returns immediately.#
  • returns: <Promise<boolean>>#

Returns whether the element is visible. selector that does not match any elements is considered not visible.

frame.locator(selector)#

The method returns an element locator that can be used to perform actions in the frame. Locator is resolved to the element immediately before performing an action, so a series of actions on the same locator can in fact be performed on different DOM elements. That would happen if the DOM structure between those actions has changed.

frame.name()#

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 the page containing this frame.

frame.parentFrame()#

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

frame.press(selector, key[, options])#

  • selector <string> A selector to search for an element. 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 as ArrowLeft or a.#
  • options <Object>
    • delay <number> Time to wait between keydown and keyup 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 to false.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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 specified 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 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 the multiple 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.#
    • value <string> Matches by option.value. Optional.
    • label <string> Matches by option.label. Optional.
    • index <number> Matches by the index. Optional.
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<Array<string>>>#

This method waits for an element matching selector, waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.

If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

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.

// single selection matching the valueframe.selectOption('select#colors', 'blue');
// single selection matching both the value and the labelframe.selectOption('select#colors', { label: 'Blue' });
// multiple selectionframe.selectOption('select#colors', 'red', 'green', 'blue');

frame.setChecked(selector, checked[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • checked <boolean> Whether to check or uncheck the checkbox.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  3. If the element already has the right checked state, this method returns immediately.
  4. 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.
  5. Scroll the element into view if needed.
  6. Use page.mouse to click in the center of the element.
  7. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  8. Ensure that the element is now checked or unchecked. If not, this method throws.

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

frame.setContent(html[, options])#

frame.setInputFiles(selector, files[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. 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 to false.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • modifiers <Array<"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.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. 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.
  3. Scroll the element into view if needed.
  4. Use page.touchscreen to tap the center of the element, or the specified position.
  5. 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 throws a TimeoutError. Passing zero timeout disables this.

note

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

frame.textContent(selector[, options])#

Returns element.textContent.

frame.title()#

Returns the page title.

frame.type(selector, text[, options])#

  • selector <string> A selector to search for an element. 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 to false.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<void>>#

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

await frame.type('#mytextarea', 'Hello'); // Types instantlyawait frame.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user

frame.uncheck(selector[, options])#

  • selector <string> A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.#
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. Defaults to false.#
    • 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 to false.#
    • position <Object> A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.#
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
    • trial <boolean> When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.#
  • returns: <Promise<void>>#

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

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  3. 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.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
  7. Ensure that the element is now unchecked. If not, this method throws.

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

frame.url()#

Returns frame's url.

frame.waitForFunction(pageFunction[, arg, options])#

  • pageFunction <function|string> Function to be evaluated in the page context.#
  • arg <EvaluationArgument> Optional argument to pass to pageFunction.#
  • options <Object>
    • polling <number|"raf"> If polling is 'raf', then pageFunction is constantly executed in requestAnimationFrame callback. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to raf.#
    • timeout <number> maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout).#
  • returns: <Promise<JSHandle>>#

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

The frame.waitForFunction(pageFunction[, arg, options]) can be used to observe viewport size change:

const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
(async () => {  const browser = await firefox.launch();  const page = await browser.newPage();  const watchDog = page.mainFrame().waitForFunction('window.innerWidth < 100');  page.setViewportSize({width: 50, height: 50});  await watchDog;  await browser.close();})();

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

const selector = '.foo';await frame.waitForFunction(selector => !!document.querySelector(selector), selector);

frame.waitForLoadState([state, options])#

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.

await frame.click('button'); // Click triggers navigation.await frame.waitForLoadState(); // Waits for 'load' state by default.

frame.waitForNavigation([options])#

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:

const [response] = await Promise.all([  frame.waitForNavigation(), // The promise resolves after navigation has finished  frame.click('a.delayed-navigation'), // Clicking the link will indirectly cause a navigation]);
note

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

frame.waitForSelector(selector[, options])#

  • selector <string> A selector to query 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 no visibility:hidden. Note that element without any content or with display: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 or visibility:hidden. This is opposite to the 'visible' option.
    • strict <boolean> When true, the call requires selector to resolve to a single element. If given selector resolves to more then one element, the call throws an exception.#
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.#
  • returns: <Promise<null|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:

const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
(async () => {  const browser = await chromium.launch();  const page = await browser.newPage();  for (let currentURL of ['https://google.com', 'https://bbc.com']) {    await page.goto(currentURL);    const element = await page.mainFrame().waitForSelector('img');    console.log('Loaded image: ' + await element.getAttribute('src'));  }  await browser.close();})();

frame.waitForTimeout(timeout)#

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.

frame.waitForURL(url[, options])#

Waits for the frame to navigate to the given URL.

await frame.click('a.delayed-navigation'); // Clicking the link will indirectly cause a navigationawait frame.waitForURL('**/target.html');