A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://playwright.dev/java/docs/api/class-frame below:

Frame | Playwright Java

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

Returns

addStyleTagAdded 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

Returns

childFramesAdded before v1.9 frame.childFrames

Usage

Returns

contentAdded before v1.9 frame.content

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

Usage

Returns

dragAndDropAdded in: v1.13 frame.dragAndDrop

Usage

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

Arguments

Returns

evaluateAdded 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);

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

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

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

Returns

evaluateHandleAdded 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


JSHandle aWindowHandle = frame.evaluateHandle("() => Promise.resolve(window)");

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

JSHandle aHandle = frame.evaluateHandle("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

Returns

frameElementAdded 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);

Returns

frameLocatorAdded 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

Returns

getByAltTextAdded 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

Returns

getByLabelAdded 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

Returns

getByPlaceholderAdded 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

Returns

getByRoleAdded 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

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.

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

getByTextAdded 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:


page.getByText("world");


page.getByText("Hello world");


page.getByText("Hello", new Page.GetByTextOptions().setExact(true));


page.getByText(Pattern.compile("Hello"));


page.getByText(Pattern.compile("^hello$", Pattern.CASE_INSENSITIVE));

Arguments

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

getByTitleAdded 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

Returns

isDetachedAdded before v1.9 frame.isDetached

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

Usage

Returns

isEnabledAdded before v1.9 frame.isEnabled

Returns whether the element is enabled.

Usage

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

Arguments

Returns

locatorAdded 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

Returns

nameAdded 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

Returns

navigateAdded 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:

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

Returns

pageAdded before v1.9 frame.page

Returns the page containing this frame.

Usage

Returns

parentFrameAdded before v1.9 frame.parentFrame

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

Usage

Returns

setContentAdded 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

Returns

titleAdded before v1.9 frame.title

Returns the page title.

Usage

Returns

urlAdded before v1.9 frame.url

Returns frame's url.

Usage

Returns

waitForFunctionAdded 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

Returns

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

Usage

frame.click("button"); 
frame.waitForLoadState();

Arguments

Returns

waitForURLAdded in: v1.11 frame.waitForURL

Waits for the frame to navigate to the given URL.

Usage

frame.click("a.delayed-navigation"); 
frame.waitForURL("**/target.html");

Arguments

Returns

Deprecated checkAdded before v1.9 frame.check

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 setForce 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

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

Arguments

Returns

clickAdded before v1.9 frame.click

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 setForce 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 setPosition.
  5. Wait for initiated navigations to either succeed or fail, unless setNoWaitAfter option is set.

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

Usage

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

Arguments

Returns

dblclickAdded before v1.9 frame.dblclick

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 setForce 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 setPosition. 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 setTimeout, 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

Returns

dispatchEventAdded before v1.9 frame.dispatchEvent

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:


JSHandle dataTransfer = frame.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
frame.dispatchEvent("#source", "dragstart", arg);

Arguments

Returns

evalOnSelectorAdded 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

Returns

evalOnSelectorAllAdded in: v1.9 frame.evalOnSelectorAll

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

Returns

fillAdded before v1.9 frame.fill

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

Returns

focusAdded before v1.9 frame.focus

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

Returns

getAttributeAdded before v1.9 frame.getAttribute

Returns element attribute value.

Usage

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

Arguments

Returns

hoverAdded before v1.9 frame.hover

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

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

Usage

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

Arguments

Returns

innerHTMLAdded before v1.9 frame.innerHTML

Returns element.innerHTML.

Usage

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

Arguments

Returns

innerTextAdded before v1.9 frame.innerText

Returns element.innerText.

Usage

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

Arguments

Returns

inputValueAdded in: v1.13 frame.inputValue

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

Returns

isCheckedAdded before v1.9 frame.isChecked

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

Returns

isDisabledAdded before v1.9 frame.isDisabled

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

Usage

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

Arguments

Returns

isEditableAdded before v1.9 frame.isEditable

Returns whether the element is editable.

Usage

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

Arguments

Returns

isHiddenAdded before v1.9 frame.isHidden

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

Returns

isVisibleAdded before v1.9 frame.isVisible

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

Returns

pressAdded before v1.9 frame.press

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

Returns

querySelectorAdded in: v1.9 frame.querySelector

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

Returns

querySelectorAllAdded in: v1.9 frame.querySelectorAll

Returns the ElementHandles pointing to the frame elements.

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

Returns

selectOptionAdded before v1.9 frame.selectOption

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


frame.selectOption("select#colors", "blue");

frame.selectOption("select#colors", new SelectOption().setLabel("Blue"));

frame.selectOption("select#colors", new String[] {"red", "green", "blue"});

Arguments

Returns

setCheckedAdded in: v1.15 frame.setChecked

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 setForce 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

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

Arguments

Returns

setInputFilesAdded before v1.9 frame.setInputFiles

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

Returns

tapAdded before v1.9 frame.tap

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

When all steps combined have not finished during the specified setTimeout, 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

Returns

textContentAdded before v1.9 frame.textContent

Returns element.textContent.

Usage

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

Arguments

Returns

typeAdded before v1.9 frame.type

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

Returns

uncheckAdded before v1.9 frame.uncheck

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 setForce 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 setTimeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

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

Arguments

Returns

waitForNavigationAdded before v1.9 frame.waitForNavigation

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:


frame.waitForNavigation(() -> {

frame.click("a.delayed-navigation");
});

note

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

Arguments

Returns

waitForSelectorAdded 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 setState 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 setState 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 setTimeout 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

Returns

waitForTimeoutAdded 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

Returns


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4