Skip to main content

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:

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType firefox = playwright.firefox();
      Browser browser = firefox.launch();
      Page page = browser.newPage();
      page.navigate("https://www.google.com/chrome/browser/canary.html");
      dumpFrameTree(page.mainFrame(), "");
      browser.close();
    }
  }
  static void dumpFrameTree(Frame frame, String indent) {
    System.out.println(indent + frame.url());
    for (Frame child : frame.childFrames()) {
      dumpFrameTree(child, indent + "  ");
    }
  }
}

Methods​

addScriptTag​

Added before v1.9 frame.addScriptTag

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.

Usage

Frame.addScriptTag();
Frame.addScriptTag(options);

Arguments

  • options Frame.AddScriptTagOptions (optional)

    • setContent String (optional)#

      Raw JavaScript content to be injected into frame.

    • setPath Path (optional)#

      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.

    • setType String (optional)#

      Script type. Use 'module' in order to load a JavaScript ES6 module. See script for more details.

    • setUrl String (optional)#

      URL of a script to be added.

Returns

addStyleTag​

Added before v1.9 frame.addStyleTag

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.

Usage

Frame.addStyleTag();
Frame.addStyleTag(options);

Arguments

  • options Frame.AddStyleTagOptions (optional)

    • setContent String (optional)#

      Raw CSS content to be injected into frame.

    • setPath Path (optional)#

      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.

    • setUrl String (optional)#

      URL of the <link> tag.

Returns

childFrames​

Added before v1.9 frame.childFrames

Usage

Frame.childFrames();

Returns

content​

Added before v1.9 frame.content

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

Usage

Frame.content();

Returns

dragAndDrop​

Added in: v1.13 frame.dragAndDrop

Usage

Frame.dragAndDrop(source, target);
Frame.dragAndDrop(source, target, options);

Arguments

  • source String#

    A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.

  • target String#

    A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.DragAndDropOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setSourcePosition SourcePosition (optional) Added in: v1.14#

      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.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTargetPosition TargetPosition (optional) Added in: v1.14#

      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.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional)#

      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

evaluate​

Added before v1.9 frame.evaluate

Returns the return value of expression.

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. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

Usage

Object result = frame.evaluate("([x, y]) => {\n" +
  "  return Promise.resolve(x * y);\n" +
  "}", Arrays.asList(7, 8));
System.out.println(result); // prints "56"

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

System.out.println(frame.evaluate("1 + 2")); // prints "3"

ElementHandle instances can be passed as an argument to the Frame.evaluate():

ElementHandle bodyHandle = frame.evaluate("document.body");
String html = (String) frame.evaluate("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(bodyHandle, "hello"));
bodyHandle.dispose();

Arguments

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

Returns

evaluateHandle​

Added before v1.9 frame.evaluateHandle

Returns the return value of expression as a JSHandle.

The only difference between Frame.evaluate() and Frame.evaluateHandle() is that Frame.evaluateHandle() returns 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.

Usage

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

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

JSHandle aHandle = frame.evaluateHandle("document"); // Handle for the "document".

JSHandle instances can be passed as an argument to the Frame.evaluateHandle():

JSHandle aHandle = frame.evaluateHandle("() => document.body");
JSHandle resultHandle = frame.evaluateHandle("([body, suffix]) => body.innerHTML + suffix", Arrays.asList(aHandle, "hello"));
System.out.println(resultHandle.jsonValue());
resultHandle.dispose();

Arguments

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

Returns

frameElement​

Added before v1.9 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.

Usage

ElementHandle frameElement = frame.frameElement();
Frame contentFrame = frameElement.contentFrame();
System.out.println(frame == contentFrame);  // -> true

Returns

frameLocator​

Added in: v1.17 frame.frameLocator

When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.

Usage

Following snippet locates element with text "Submit" in the iframe with id my-frame, like <iframe id="my-frame">:

Locator locator = frame.frameLocator("#my-iframe").getByText("Submit");
locator.click();

Arguments

  • selector String#

    A selector to use when resolving DOM element.

Returns

getByAltText​

Added in: v1.27 frame.getByAltText

Allows locating elements by their alt text.

Usage

For example, this method will find the image by alt text "Playwright logo":

<img alt='Playwright logo'>
page.getByAltText("Playwright logo").click();

Arguments

  • text String | Pattern#

    Text to locate the element for.

  • options Frame.GetByAltTextOptions (optional)

    • setExact boolean (optional)#

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

getByLabel​

Added in: v1.27 frame.getByLabel

Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

Usage

For example, this method will find inputs by label "Username" and "Password" in the following DOM:

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
page.getByLabel("Username").fill("john");
page.getByLabel("Password").fill("secret");

Arguments

  • text String | Pattern#

    Text to locate the element for.

  • options Frame.GetByLabelOptions (optional)

    • setExact boolean (optional)#

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

getByPlaceholder​

Added in: v1.27 frame.getByPlaceholder

Allows locating input elements by the placeholder text.

Usage

For example, consider the following DOM structure.

<input type="email" placeholder="name@example.com" />

You can fill the input after locating it by the placeholder text:

page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");

Arguments

  • text String | Pattern#

    Text to locate the element for.

  • options Frame.GetByPlaceholderOptions (optional)

    • setExact boolean (optional)#

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

getByRole​

Added in: v1.27 frame.getByRole

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

Usage

Consider the following DOM structure.

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

You can locate each element by it's implicit role:

assertThat(page
    .getByRole(AriaRole.HEADING,
               new Page.GetByRoleOptions().setName("Sign up")))
    .isVisible();

page.getByRole(AriaRole.CHECKBOX,
               new Page.GetByRoleOptions().setName("Subscribe"))
    .check();

page.getByRole(AriaRole.BUTTON,
               new Page.GetByRoleOptions().setName(
                   Pattern.compile("submit", Pattern.CASE_INSENSITIVE)))
    .click();

Arguments

  • role enum AriaRole { ALERT, ALERTDIALOG, APPLICATION, ARTICLE, BANNER, BLOCKQUOTE, BUTTON, CAPTION, CELL, CHECKBOX, CODE, COLUMNHEADER, COMBOBOX, COMPLEMENTARY, CONTENTINFO, DEFINITION, DELETION, DIALOG, DIRECTORY, DOCUMENT, EMPHASIS, FEED, FIGURE, FORM, GENERIC, GRID, GRIDCELL, GROUP, HEADING, IMG, INSERTION, LINK, LIST, LISTBOX, LISTITEM, LOG, MAIN, MARQUEE, MATH, METER, MENU, MENUBAR, MENUITEM, MENUITEMCHECKBOX, MENUITEMRADIO, NAVIGATION, NONE, NOTE, OPTION, PARAGRAPH, PRESENTATION, PROGRESSBAR, RADIO, RADIOGROUP, REGION, ROW, ROWGROUP, ROWHEADER, SCROLLBAR, SEARCH, SEARCHBOX, SEPARATOR, SLIDER, SPINBUTTON, STATUS, STRONG, SUBSCRIPT, SUPERSCRIPT, SWITCH, TAB, TABLE, TABLIST, TABPANEL, TERM, TEXTBOX, TIME, TIMER, TOOLBAR, TOOLTIP, TREE, TREEGRID, TREEITEM }#

    Required aria role.

  • options Frame.GetByRoleOptions (optional)

    • setChecked boolean (optional)#

      An attribute that is usually set by aria-checked or native <input type=checkbox> controls.

      Learn more about aria-checked.

    • setDisabled boolean (optional)#

      An attribute that is usually set by aria-disabled or disabled.

      note

      Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about aria-disabled.

    • setExact boolean (optional) Added in: v1.28#

      Whether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a regular expression. Note that exact match still trims whitespace.

    • setExpanded boolean (optional)#

      An attribute that is usually set by aria-expanded.

      Learn more about aria-expanded.

    • setIncludeHidden boolean (optional)#

      Option that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.

      Learn more about aria-hidden.

    • setLevel int (optional)#

      A number attribute that is usually present for roles heading, listitem, row, treeitem, with default values for <h1>-<h6> elements.

      Learn more about aria-level.

    • setName String | Pattern (optional)#

      Option to match the accessible name. By default, matching is case-insensitive and searches for a substring, use exact to control this behavior.

      Learn more about accessible name.

    • setPressed boolean (optional)#

      An attribute that is usually set by aria-pressed.

      Learn more about aria-pressed.

    • setSelected boolean (optional)#

      An attribute that is usually set by aria-selected.

      Learn more about aria-selected.

Returns

Details

Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

getByTestId​

Added in: v1.27 frame.getByTestId

Locate element by the test id.

Usage

Consider the following DOM structure.

<button data-testid="directions">Itinéraire</button>

You can locate the element by it's test id:

page.getByTestId("directions").click();

Arguments

Returns

Details

By default, the data-testid attribute is used as a test id. Use Selectors.setTestIdAttribute() to configure a different test id attribute if necessary.

getByText​

Added in: v1.27 frame.getByText

Allows locating elements that contain given text.

See also Locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.

Usage

Consider the following DOM structure:

<div>Hello <span>world</span></div>
<div>Hello</div>

You can locate by text substring, exact string, or a regular expression:

// Matches <span>
page.getByText("world")

// Matches first <div>
page.getByText("Hello world")

// Matches second <div>
page.getByText("Hello", new Page.GetByTextOptions().setExact(true))

// Matches both <div>s
page.getByText(Pattern.compile("Hello"))

// Matches second <div>
page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE))

Arguments

  • text String | Pattern#

    Text to locate the element for.

  • options Frame.GetByTextOptions (optional)

    • setExact boolean (optional)#

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

Details

Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

getByTitle​

Added in: v1.27 frame.getByTitle

Allows locating elements by their title attribute.

Usage

Consider the following DOM structure.

<span title='Issues count'>25 issues</span>

You can check the issues count after locating it by the title text:

assertThat(page.getByTitle("Issues count")).hasText("25 issues");

Arguments

  • text String | Pattern#

    Text to locate the element for.

  • options Frame.GetByTitleOptions (optional)

    • setExact boolean (optional)#

      Whether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.

Returns

isDetached​

Added before v1.9 frame.isDetached

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

Usage

Frame.isDetached();

Returns

isEnabled​

Added before v1.9 frame.isEnabled

Returns whether the element is enabled.

Usage

Frame.isEnabled(selector);
Frame.isEnabled(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsEnabledOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

locator​

Added in: v1.14 frame.locator

The method returns an element locator that can be used to perform actions on this page / 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.

Learn more about locators.

Learn more about locators.

Usage

Frame.locator(selector);
Frame.locator(selector, options);

Arguments

  • selector String#

    A selector to use when resolving DOM element.

  • options Frame.LocatorOptions (optional)

    • setHas Locator (optional)#

      Narrows down the results of the method to those which contain elements matching this relative locator. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.

      Inner locator must be relative to the outer locator and is queried starting with the outer locator match, not the document root. For example, you can find content that has div in <article><content><div>Playwright</div></content></article>. However, looking for content that has article div will fail, because the inner locator must be relative and should not use any elements outside the content.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • setHasNot Locator (optional) Added in: v1.33#

      Matches elements that do not contain an element that matches an inner locator. Inner locator is queried against the outer one. For example, article that does not have div matches <article><span>Playwright</span></article>.

      Note that outer and inner locators must belong to the same frame. Inner locator must not contain FrameLocators.

    • setHasNotText String | Pattern (optional) Added in: v1.33#

      Matches elements that do not contain specified text somewhere inside, possibly in a child or a descendant element. When passed a string, matching is case-insensitive and searches for a substring.

    • setHasText String | Pattern (optional)#

      Matches elements containing specified text somewhere inside, possibly in a child or a descendant element. When passed a string, matching is case-insensitive and searches for a substring. For example, "Playwright" matches <article><div>Playwright</div></article>.

Returns

name​

Added before v1.9 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.

Usage

Frame.name();

Returns

navigate​

Added before v1.9 frame.navigate

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.

Usage

Frame.navigate(url);
Frame.navigate(url, options);

Arguments

  • url String#

    URL to navigate frame to. The url should include scheme, e.g. https://.

  • options Frame.NavigateOptions (optional)

    • setReferer String (optional)#

      Referer header value. If provided it will take preference over the referer header value set by Page.setExtraHTTPHeaders().

    • setTimeout double (optional)#

      Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (optional)#

      When to consider operation succeeded, defaults to load. Events can be either:

      • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
      • 'load' - consider operation to be finished when the load event is fired.
      • 'networkidle' - DISCOURAGED consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
      • 'commit' - consider operation to be finished when network response is received and the document started loading.

Returns

page​

Added before v1.9 frame.page

Returns the page containing this frame.

Usage

Frame.page();

Returns

parentFrame​

Added before v1.9 frame.parentFrame

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

Usage

Frame.parentFrame();

Returns

setContent​

Added before v1.9 frame.setContent

This method internally calls document.write(), inheriting all its specific characteristics and behaviors.

Usage

Frame.setContent(html);
Frame.setContent(html, options);

Arguments

  • html String#

    HTML markup to assign to the page.

  • options Frame.SetContentOptions (optional)

    • setTimeout double (optional)#

      Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (optional)#

      When to consider operation succeeded, defaults to load. Events can be either:

      • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
      • 'load' - consider operation to be finished when the load event is fired.
      • 'networkidle' - DISCOURAGED consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
      • 'commit' - consider operation to be finished when network response is received and the document started loading.

Returns

title​

Added before v1.9 frame.title

Returns the page title.

Usage

Frame.title();

Returns

url​

Added before v1.9 frame.url

Returns frame's url.

Usage

Frame.url();

Returns

waitForFunction​

Added before v1.9 frame.waitForFunction

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

Usage

The Frame.waitForFunction() can be used to observe viewport size change:

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType firefox = playwright.firefox();
      Browser browser = firefox.launch();
      Page page = browser.newPage();
      page.setViewportSize(50, 50);
      page.mainFrame().waitForFunction("window.innerWidth < 100");
      browser.close();
    }
  }
}

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

String selector = ".foo";
frame.waitForFunction("selector => !!document.querySelector(selector)", selector);

Arguments

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

  • options Frame.WaitForFunctionOptions (optional)

    • setPollingInterval double (optional)#

      If specified, then it is treated as an interval in milliseconds at which the function would be executed. By default if the option is not specified expression is executed in requestAnimationFrame callback.

    • setTimeout double (optional)#

      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() or Page.setDefaultTimeout() methods.

Returns

waitForLoadState​

Added before v1.9 frame.waitForLoadState

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.

note

Most of the time, this method is not needed because Playwright auto-waits before every action.

Usage

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

Arguments

  • state enum LoadState { LOAD, DOMCONTENTLOADED, NETWORKIDLE } (optional)#

    Optional load state to wait for, defaults to load. If the state has been already reached while loading current document, the method resolves immediately. Can be one of:

    • 'load' - wait for the load event to be fired.
    • 'domcontentloaded' - wait for the DOMContentLoaded event to be fired.
    • 'networkidle' - DISCOURAGED wait until there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.

  • options Frame.WaitForLoadStateOptions (optional)

Returns

waitForURL​

Added in: v1.11 frame.waitForURL

Waits for the frame to navigate to the given URL.

Usage

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

Arguments

  • url String | Pattern | Predicate<String>#

    A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.

  • options Frame.WaitForURLOptions (optional)

    • setTimeout double (optional)#

      Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (optional)#

      When to consider operation succeeded, defaults to load. Events can be either:

      • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
      • 'load' - consider operation to be finished when the load event is fired.
      • 'networkidle' - DISCOURAGED consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
      • 'commit' - consider operation to be finished when network response is received and the document started loading.

Returns

Deprecated​

check​

Added before v1.9 frame.check
Discouraged

Use locator-based Locator.check() instead. Read more about locators.

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

Usage

Frame.check(selector);
Frame.check(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.CheckOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional) Added in: v1.11#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

click​

Added before v1.9 frame.click
Discouraged

Use locator-based Locator.click() instead. Read more about locators.

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.

Usage

Frame.click(selector);
Frame.click(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.ClickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setClickCount int (optional)#

      defaults to 1. See UIEvent.detail.

    • setDelay double (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (optional)#

      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. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option will default to true in the future.

      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.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

dblclick​

Added before v1.9 frame.dblclick
Discouraged

Use locator-based Locator.dblclick() instead. Read more about locators.

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

Usage

Frame.dblclick(selector);
Frame.dblclick(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.DblclickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setDelay double (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (optional)#

      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. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

dispatchEvent​

Added before v1.9 frame.dispatchEvent
Discouraged

Use locator-based Locator.dispatchEvent() instead. Read more about locators.

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

Usage

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 Firefox
JSHandle dataTransfer = frame.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
frame.dispatchEvent("#source", "dragstart", arg);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • type String#

    DOM event type: "click", "dragstart", etc.

  • eventInit EvaluationArgument (optional)#

    Optional event-specific initialization properties.

  • options Frame.DispatchEventOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

evalOnSelector​

Added in: v1.9 frame.evalOnSelector
Discouraged

This method does not wait for the element to pass the actionability checks and therefore can lead to the flaky tests. Use Locator.evaluate(), other Locator helper methods or web-first assertions instead.

Returns the return value of expression.

The method finds an element matching the specified selector within the frame and passes it as a first argument to expression. If no elements match the selector, the method throws an error.

If expression returns a Promise, then Frame.evalOnSelector() would wait for the promise to resolve and return its value.

Usage

String searchValue = (String) frame.evalOnSelector("#search", "el => el.value");
String preloadHref = (String) frame.evalOnSelector("link[rel=preload]", "el => el.href");
String html = (String) frame.evalOnSelector(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");

Arguments

  • selector String#

    A selector to query for.

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

  • options Frame.EvalOnSelectorOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

Returns

evalOnSelectorAll​

Added in: v1.9 frame.evalOnSelectorAll
Discouraged

In most cases, Locator.evaluateAll(), other Locator helper methods and web-first assertions do a better job.

Returns the return value of expression.

The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to expression.

If expression returns a Promise, then Frame.evalOnSelectorAll() would wait for the promise to resolve and return its value.

Usage

boolean divsCounts = (boolean) page.evalOnSelectorAll("div", "(divs, min) => divs.length >= min", 10);

Arguments

  • selector String#

    A selector to query for.

  • expression String#

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)#

    Optional argument to pass to expression.

Returns

fill​

Added before v1.9 frame.fill
Discouraged

Use locator-based Locator.fill() instead. Read more about locators.

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 Locator.pressSequentially().

Usage

Frame.fill(selector, value);
Frame.fill(selector, value, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • value String#

    Value to fill for the <input>, <textarea> or [contenteditable] element.

  • options Frame.FillOptions (optional)

    • setForce boolean (optional) Added in: v1.13#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

focus​

Added before v1.9 frame.focus
Discouraged

Use locator-based Locator.focus() instead. Read more about locators.

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.

Usage

Frame.focus(selector);
Frame.focus(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.FocusOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

getAttribute​

Added before v1.9 frame.getAttribute
Discouraged

Use locator-based Locator.getAttribute() instead. Read more about locators.

Returns element attribute value.

Usage

Frame.getAttribute(selector, name);
Frame.getAttribute(selector, name, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • name String#

    Attribute name to get the value for.

  • options Frame.GetAttributeOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

hover​

Added before v1.9 frame.hover
Discouraged

Use locator-based Locator.hover() instead. Read more about locators.

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.

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

Usage

Frame.hover(selector);
Frame.hover(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.HoverOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (optional)#

      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. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • setNoWaitAfter boolean (optional) Added in: v1.28#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

innerHTML​

Added before v1.9 frame.innerHTML
Discouraged

Use locator-based Locator.innerHTML() instead. Read more about locators.

Returns element.innerHTML.

Usage

Frame.innerHTML(selector);
Frame.innerHTML(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.InnerHTMLOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

innerText​

Added before v1.9 frame.innerText
Discouraged

Use locator-based Locator.innerText() instead. Read more about locators.

Returns element.innerText.

Usage

Frame.innerText(selector);
Frame.innerText(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.InnerTextOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

inputValue​

Added in: v1.13 frame.inputValue
Discouraged

Use locator-based Locator.inputValue() instead. Read more about locators.

Returns input.value for the selected <input> or <textarea> or <select> element.

Throws for non-input elements. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

Usage

Frame.inputValue(selector);
Frame.inputValue(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.InputValueOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

isChecked​

Added before v1.9 frame.isChecked
Discouraged

Use locator-based Locator.isChecked() instead. Read more about locators.

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

Usage

Frame.isChecked(selector);
Frame.isChecked(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsCheckedOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

isDisabled​

Added before v1.9 frame.isDisabled
Discouraged

Use locator-based Locator.isDisabled() instead. Read more about locators.

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

Usage

Frame.isDisabled(selector);
Frame.isDisabled(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsDisabledOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

isEditable​

Added before v1.9 frame.isEditable
Discouraged

Use locator-based Locator.isEditable() instead. Read more about locators.

Returns whether the element is editable.

Usage

Frame.isEditable(selector);
Frame.isEditable(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsEditableOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

isHidden​

Added before v1.9 frame.isHidden
Discouraged

Use locator-based Locator.isHidden() instead. Read more about locators.

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

Usage

Frame.isHidden(selector);
Frame.isHidden(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsHiddenOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Deprecated

      This option is ignored. Frame.isHidden() does not wait for the element to become hidden and returns immediately.

Returns

isVisible​

Added before v1.9 frame.isVisible
Discouraged

Use locator-based Locator.isVisible() instead. Read more about locators.

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

Usage

Frame.isVisible(selector);
Frame.isVisible(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.IsVisibleOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Deprecated

      This option is ignored. Frame.isVisible() does not wait for the element to become visible and returns immediately.

Returns

press​

Added before v1.9 frame.press
Discouraged

Use locator-based Locator.press() instead. Read more about locators.

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, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

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", key: "Control++ 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.

Usage

Frame.press(selector, key);
Frame.press(selector, key, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • key String#

    Name of the key to press or a character to generate, such as ArrowLeft or a.

  • options Frame.PressOptions (optional)

    • setDelay double (optional)#

      Time to wait between keydown and keyup in milliseconds. Defaults to 0.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option will default to true in the future.

      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.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

querySelector​

Added in: v1.9 frame.querySelector
Discouraged

Use locator-based Frame.locator() instead. Read more about locators.

Returns the ElementHandle pointing to the frame element.

caution

The use of ElementHandle is discouraged, use Locator objects and web-first assertions instead.

The method finds an element matching the specified selector within the frame. If no elements match the selector, returns null.

Usage

Frame.querySelector(selector);
Frame.querySelector(selector, options);

Arguments

  • selector String#

    A selector to query for.

  • options Frame.QuerySelectorOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

Returns

querySelectorAll​

Added in: v1.9 frame.querySelectorAll
Discouraged

Use locator-based Frame.locator() instead. Read more about locators.

Returns the ElementHandles pointing to the frame elements.

caution

The use of ElementHandle is discouraged, use Locator objects instead.

The method finds all elements matching the specified selector within the frame. If no elements match the selector, returns empty array.

Usage

Frame.querySelectorAll(selector);

Arguments

  • selector String#

    A selector to query for.

Returns

selectOption​

Added before v1.9 frame.selectOption
Discouraged

Use locator-based Locator.selectOption() instead. Read more about locators.

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.

Usage

// Single selection matching the value or label
frame.selectOption("select#colors", "blue");
// single selection matching both the value and the label
frame.selectOption("select#colors", new SelectOption().setLabel("Blue"));
// multiple selection
frame.selectOption("select#colors", new String[] {"red", "green", "blue"});

Arguments

  • selector String#

    A selector to query for.

  • values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#

    • setValue String (optional)

      Matches by option.value. Optional.

    • setLabel String (optional)

      Matches by option.label. Optional.

    • setIndex int (optional)

      Matches by the index. Optional.

    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 matching both values and labels. Option is considered matching if all specified properties match.

  • options Frame.SelectOptionOptions (optional)

    • setForce boolean (optional) Added in: v1.13#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

setChecked​

Added in: v1.15 frame.setChecked
Discouraged

Use locator-based Locator.setChecked() instead. Read more about locators.

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

Usage

Frame.setChecked(selector, checked);
Frame.setChecked(selector, checked, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • checked boolean#

    Whether to check or uncheck the checkbox.

  • options Frame.SetCheckedOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional)#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional)#

      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

setInputFiles​

Added before v1.9 frame.setInputFiles
Discouraged

Use locator-based Locator.setInputFiles() instead. Read more about locators.

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.

This method expects selector to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

Usage

Frame.setInputFiles(selector, files);
Frame.setInputFiles(selector, files, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • files Path | Path[] | FilePayload | FilePayload[]#

  • options Frame.SetInputFilesOptions (optional)

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

tap​

Added before v1.9 frame.tap
Discouraged

Use locator-based Locator.tap() instead. Read more about locators.

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.

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.

Usage

Frame.tap(selector);
Frame.tap(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.TapOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (optional)#

      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. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional)#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

textContent​

Added before v1.9 frame.textContent
Discouraged

Use locator-based Locator.textContent() instead. Read more about locators.

Returns element.textContent.

Usage

Frame.textContent(selector);
Frame.textContent(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.TextContentOptions (optional)

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

type​

Added before v1.9 frame.type
Deprecated

In most cases, you should use Locator.fill() instead. You only need to press keys one by one if there is special keyboard handling on the page - in this case use Locator.pressSequentially().

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

Usage

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • text String#

    A text to type into a focused element.

  • options Frame.TypeOptions (optional)

    • setDelay double (optional)#

      Time to wait between key presses in milliseconds. Defaults to 0.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

uncheck​

Added before v1.9 frame.uncheck
Discouraged

Use locator-based Locator.uncheck() instead. Read more about locators.

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

Usage

Frame.uncheck(selector);
Frame.uncheck(selector, options);

Arguments

  • selector String#

    A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.

  • options Frame.UncheckOptions (optional)

    • setForce boolean (optional)#

      Whether to bypass the actionability checks. Defaults to false.

    • setNoWaitAfter boolean (optional)#

      Deprecated

      This option has no effect.

      This option has no effect.

    • setPosition Position (optional) Added in: v1.11#

      A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

    • setTrial boolean (optional) Added in: v1.11#

      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

waitForNavigation​

Added before v1.9 frame.waitForNavigation
Deprecated

This method is inherently racy, please use Frame.waitForURL() instead.

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.

Usage

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:

// The method returns after navigation has finished
frame.waitForNavigation(() -> {
  // Clicking the link will indirectly cause a navigation
  frame.click("a.delayed-navigation");
});
note

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

Arguments

  • options Frame.WaitForNavigationOptions (optional)

    • setTimeout double (optional)#

      Maximum operation time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultNavigationTimeout(), BrowserContext.setDefaultTimeout(), Page.setDefaultNavigationTimeout() or Page.setDefaultTimeout() methods.

    • setUrl String | Pattern | Predicate<String> (optional)#

      A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.

    • setWaitUntil enum WaitUntilState { LOAD, DOMCONTENTLOADED, NETWORKIDLE, COMMIT } (optional)#

      When to consider operation succeeded, defaults to load. Events can be either:

      • 'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.
      • 'load' - consider operation to be finished when the load event is fired.
      • 'networkidle' - DISCOURAGED consider operation to be finished when there are no network connections for at least 500 ms. Don't use this method for testing, rely on web assertions to assess readiness instead.
      • 'commit' - consider operation to be finished when network response is received and the document started loading.

  • callback Runnable Added in: v1.9#

    Callback that performs the action triggering the event.

Returns

waitForSelector​

Added before v1.9 frame.waitForSelector
Discouraged

Use web assertions that assert visibility or a locator-based Locator.waitFor() instead. Read more about locators.

Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

note

Playwright automatically waits for element to be ready before performing an action. Using Locator objects and web-first assertions make the code wait-for-selector-free.

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.

Usage

This method works across navigations:

import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      for (String currentURL : Arrays.asList("https://google.com", "https://bbc.com")) {
        page.navigate(currentURL);
        ElementHandle element = page.mainFrame().waitForSelector("img");
        System.out.println("Loaded image: " + element.getAttribute("src"));
      }
      browser.close();
    }
  }
}

Arguments

  • selector String#

    A selector to query for.

  • options Frame.WaitForSelectorOptions (optional)

    • setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (optional)#

      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.

    • setStrict boolean (optional) Added in: v1.14#

      When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.

    • setTimeout double (optional)#

      Maximum time in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.setDefaultTimeout() or Page.setDefaultTimeout() methods.

Returns

waitForTimeout​

Added before v1.9 frame.waitForTimeout
Discouraged

Never wait for timeout in production. Tests that wait for time are inherently flaky. Use Locator actions and web assertions that wait automatically.

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.

Usage

Frame.waitForTimeout(timeout);

Arguments

  • timeout double#

    A timeout to wait for

Returns