Package com.microsoft.playwright

Interface Frame

  • public interface 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 + "  ");
     }
   }
 }

    • Method Detail

      • addScriptTag

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

        Since:
        v1.8

      • addScriptTag

        ElementHandle addScriptTag​(Frame.AddScriptTagOptions options)
        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.

        Since:
        v1.8

      • addStyleTag

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

        Since:
        v1.8

      • addStyleTag

        ElementHandle addStyleTag​(Frame.AddStyleTagOptions options)
        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.

        Since:
        v1.8

      • check

        default void check​(String selector)
        This method checks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
        3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        4. Scroll the element into view if needed.
        5. Use Page.mouse() to click in the center of the element.
        6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        7. Ensure that the element is now checked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • check

        void check​(String selector,
           Frame.CheckOptions options)
        This method checks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
        3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        4. Scroll the element into view if needed.
        5. Use Page.mouse() to click in the center of the element.
        6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        7. Ensure that the element is now checked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • childFrames

        List<Frame> childFrames()
        Since:
        v1.8

      • click

        default void click​(String selector)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • click

        void click​(String selector,
           Frame.ClickOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • content

        String content()
        Gets the full HTML contents of the frame, including the doctype.
        Since:
        v1.8

      • dblclick

        default void dblclick​(String selector)
        This method double clicks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to double click in the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

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

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • dblclick

        void dblclick​(String selector,
              Frame.DblclickOptions options)
        This method double clicks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to double click in the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will throw.

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

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • dispatchEvent

        default void dispatchEvent​(String selector,
                           String type,
                           Object eventInit)
        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);
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        type - DOM event type: "click", "dragstart", etc.
        eventInit - Optional event-specific initialization properties.
        Since:
        v1.8

      • dispatchEvent

        default void dispatchEvent​(String selector,
                           String type)
        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);
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        type - DOM event type: "click", "dragstart", etc.
        Since:
        v1.8

      • dispatchEvent

        void dispatchEvent​(String selector,
                   String type,
                   Object eventInit,
                   Frame.DispatchEventOptions options)
        The snippet below dispatches the click event on the element. Regardless of the visibility state of the element, click is dispatched. This is equivalent to calling element.click().

        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);
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        type - DOM event type: "click", "dragstart", etc.
        eventInit - Optional event-specific initialization properties.
        Since:
        v1.8

      • dragAndDrop

        default void dragAndDrop​(String source,
                         String target)
        Parameters:
        source - A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.
        target - A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.13

      • dragAndDrop

        void dragAndDrop​(String source,
                 String target,
                 Frame.DragAndDropOptions options)
        Parameters:
        source - A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.
        target - A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.13

      • evalOnSelector

        default Object evalOnSelector​(String selector,
                              String expression,
                              Object arg)
        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");
        Parameters:
        selector - A selector to query for.
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.9

      • evalOnSelector

        default Object evalOnSelector​(String selector,
                              String expression)
        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");
        Parameters:
        selector - A selector to query for.
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        Since:
        v1.9

      • evalOnSelector

        Object evalOnSelector​(String selector,
                      String expression,
                      Object arg,
                      Frame.EvalOnSelectorOptions options)
        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");
        Parameters:
        selector - A selector to query for.
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.9

      • evalOnSelectorAll

        default Object evalOnSelectorAll​(String selector,
                                 String expression)
        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);
        Parameters:
        selector - A selector to query for.
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        Since:
        v1.9

      • evalOnSelectorAll

        Object evalOnSelectorAll​(String selector,
                         String expression,
                         Object arg)
        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);
        Parameters:
        selector - A selector to query for.
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.9

      • evaluate

        default Object evaluate​(String expression)
        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();
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        Since:
        v1.8

      • evaluate

        Object evaluate​(String expression,
                Object arg)
        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();
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.8

      • evaluateHandle

        default JSHandle evaluateHandle​(String expression)
        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();
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        Since:
        v1.8

      • evaluateHandle

        JSHandle evaluateHandle​(String expression,
                        Object arg)
        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();
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.8

      • fill

        default void fill​(String selector,
                  String value)
        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().

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        value - Value to fill for the <input>, <textarea> or [contenteditable] element.
        Since:
        v1.8

      • fill

        void fill​(String selector,
          String value,
          Frame.FillOptions options)
        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().

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        value - Value to fill for the <input>, <textarea> or [contenteditable] element.
        Since:
        v1.8

      • focus

        default void focus​(String selector)
        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.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • focus

        void focus​(String selector,
           Frame.FocusOptions options)
        This method fetches an element with selector and focuses it. If there's no element matching selector, the method waits until a matching element appears in the DOM.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • frameElement

        ElementHandle 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
        Since:
        v1.8

      • frameLocator

        FrameLocator frameLocator​(String selector)
        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();
        Parameters:
        selector - A selector to use when resolving DOM element.
        Since:
        v1.17

      • getAttribute

        default String getAttribute​(String selector,
                            String name)
        Returns element attribute value.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        name - Attribute name to get the value for.
        Since:
        v1.8

      • getAttribute

        String getAttribute​(String selector,
                    String name,
                    Frame.GetAttributeOptions options)
        Returns element attribute value.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        name - Attribute name to get the value for.
        Since:
        v1.8

      • getByAltText

        default Locator getByAltText​(String text)
        Allows locating elements by their alt text.

        Usage

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

        
 page.getByAltText("Playwright logo").click();
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByAltText

        Locator getByAltText​(String text,
                     Frame.GetByAltTextOptions options)
        Allows locating elements by their alt text.

        Usage

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

        
 page.getByAltText("Playwright logo").click();
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByAltText

        default Locator getByAltText​(Pattern text)
        Allows locating elements by their alt text.

        Usage

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

        
 page.getByAltText("Playwright logo").click();
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByAltText

        Locator getByAltText​(Pattern text,
                     Frame.GetByAltTextOptions options)
        Allows locating elements by their alt text.

        Usage

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

        
 page.getByAltText("Playwright logo").click();
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByLabel

        default Locator getByLabel​(String text)
        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: 

        
 page.getByLabel("Username").fill("john");
 page.getByLabel("Password").fill("secret");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByLabel

        Locator getByLabel​(String text,
                   Frame.GetByLabelOptions options)
        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: 

        
 page.getByLabel("Username").fill("john");
 page.getByLabel("Password").fill("secret");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByLabel

        default Locator getByLabel​(Pattern text)
        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: 

        
 page.getByLabel("Username").fill("john");
 page.getByLabel("Password").fill("secret");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByLabel

        Locator getByLabel​(Pattern text,
                   Frame.GetByLabelOptions options)
        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: 

        
 page.getByLabel("Username").fill("john");
 page.getByLabel("Password").fill("secret");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByPlaceholder

        default Locator getByPlaceholder​(String text)
        Allows locating input elements by the placeholder text.

        Usage

        For example, consider the following DOM structure.

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

        
 page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByPlaceholder

        Locator getByPlaceholder​(String text,
                         Frame.GetByPlaceholderOptions options)
        Allows locating input elements by the placeholder text.

        Usage

        For example, consider the following DOM structure.

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

        
 page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByPlaceholder

        default Locator getByPlaceholder​(Pattern text)
        Allows locating input elements by the placeholder text.

        Usage

        For example, consider the following DOM structure.

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

        
 page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByPlaceholder

        Locator getByPlaceholder​(Pattern text,
                         Frame.GetByPlaceholderOptions options)
        Allows locating input elements by the placeholder text.

        Usage

        For example, consider the following DOM structure.

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

        
 page.getByPlaceholder("name@example.com").fill("playwright@microsoft.com");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByRole

        default Locator getByRole​(AriaRole role)
        Allows locating elements by their ARIA role, ARIA attributes and accessible name.

        Usage

        Consider the following DOM structure.

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

        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.

        Parameters:
        role - Required aria role.
        Since:
        v1.27

      • getByRole

        Locator getByRole​(AriaRole role,
                  Frame.GetByRoleOptions options)
        Allows locating elements by their ARIA role, ARIA attributes and accessible name.

        Usage

        Consider the following DOM structure.

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

        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.

        Parameters:
        role - Required aria role.
        Since:
        v1.27

      • getByTestId

        Locator getByTestId​(String testId)
        Locate element by the test id.

        Usage

        Consider the following DOM structure.

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

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

        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.

        Parameters:
        testId - Id to locate the element by.
        Since:
        v1.27

      • getByTestId

        Locator getByTestId​(Pattern testId)
        Locate element by the test id.

        Usage

        Consider the following DOM structure.

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

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

        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.

        Parameters:
        testId - Id to locate the element by.
        Since:
        v1.27

      • getByText

        default Locator getByText​(String text)
        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:

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

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

        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByText

        Locator getByText​(String text,
                  Frame.GetByTextOptions options)
        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:

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

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

        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByText

        default Locator getByText​(Pattern text)
        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:

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

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

        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByText

        Locator getByText​(Pattern text,
                  Frame.GetByTextOptions options)
        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:

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

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

        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByTitle

        default Locator getByTitle​(String text)
        Allows locating elements by their title attribute.

        Usage

        Consider the following DOM structure.

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

        
 assertThat(page.getByTitle("Issues count")).hasText("25 issues");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByTitle

        Locator getByTitle​(String text,
                   Frame.GetByTitleOptions options)
        Allows locating elements by their title attribute.

        Usage

        Consider the following DOM structure.

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

        
 assertThat(page.getByTitle("Issues count")).hasText("25 issues");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByTitle

        default Locator getByTitle​(Pattern text)
        Allows locating elements by their title attribute.

        Usage

        Consider the following DOM structure.

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

        
 assertThat(page.getByTitle("Issues count")).hasText("25 issues");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • getByTitle

        Locator getByTitle​(Pattern text,
                   Frame.GetByTitleOptions options)
        Allows locating elements by their title attribute.

        Usage

        Consider the following DOM structure.

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

        
 assertThat(page.getByTitle("Issues count")).hasText("25 issues");
        Parameters:
        text - Text to locate the element for.
        Since:
        v1.27

      • navigate

        default Response navigate​(String url)
        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.

        Parameters:
        url - URL to navigate frame to. The url should include scheme, e.g. https://.
        Since:
        v1.8

      • navigate

        Response navigate​(String url,
                  Frame.NavigateOptions options)
        Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

        The method will throw an error if:

        • there's an SSL error (e.g. in case of self-signed certificates).
        • target URL is invalid.
        • the timeout is exceeded during navigation.
        • the remote server does not respond or is unreachable.
        • the main resource failed to load.

        The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling Response.status().

        NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to about:blank or navigation to the same URL with a different hash, which would succeed and return null.

        NOTE: Headless mode doesn't support navigation to a PDF document. See the upstream issue.

        Parameters:
        url - URL to navigate frame to. The url should include scheme, e.g. https://.
        Since:
        v1.8

      • hover

        default void hover​(String selector)
        This method hovers over an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to hover over the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • hover

        void hover​(String selector,
           Frame.HoverOptions options)
        This method hovers over an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.mouse() to hover over the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • innerHTML

        default String innerHTML​(String selector)
        Returns element.innerHTML.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • innerHTML

        String innerHTML​(String selector,
                 Frame.InnerHTMLOptions options)
        Returns element.innerHTML.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • innerText

        default String innerText​(String selector)
        Returns element.innerText.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • innerText

        String innerText​(String selector,
                 Frame.InnerTextOptions options)
        Returns element.innerText.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • inputValue

        default String inputValue​(String selector)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.13

      • inputValue

        String inputValue​(String selector,
                  Frame.InputValueOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.13

      • isChecked

        default boolean isChecked​(String selector)
        Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isChecked

        boolean isChecked​(String selector,
                  Frame.IsCheckedOptions options)
        Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isDetached

        boolean isDetached()
        Returns true if the frame has been detached, or false otherwise.
        Since:
        v1.8

      • isDisabled

        default boolean isDisabled​(String selector)
        Returns whether the element is disabled, the opposite of enabled.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isDisabled

        boolean isDisabled​(String selector,
                   Frame.IsDisabledOptions options)
        Returns whether the element is disabled, the opposite of enabled.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isEditable

        default boolean isEditable​(String selector)
        Returns whether the element is editable.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isEditable

        boolean isEditable​(String selector,
                   Frame.IsEditableOptions options)
        Returns whether the element is editable.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isEnabled

        default boolean isEnabled​(String selector)
        Returns whether the element is enabled.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isEnabled

        boolean isEnabled​(String selector,
                  Frame.IsEnabledOptions options)
        Returns whether the element is enabled.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isHidden

        default boolean isHidden​(String selector)
        Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isHidden

        boolean isHidden​(String selector,
                 Frame.IsHiddenOptions options)
        Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isVisible

        default boolean isVisible​(String selector)
        Returns whether the element is visible. selector that does not match any elements is considered not visible.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • isVisible

        boolean isVisible​(String selector,
                  Frame.IsVisibleOptions options)
        Returns whether the element is visible. selector that does not match any elements is considered not visible.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • locator

        default Locator locator​(String selector)
        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.

        Parameters:
        selector - A selector to use when resolving DOM element.
        Since:
        v1.14

      • locator

        Locator locator​(String selector,
                Frame.LocatorOptions options)
        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.

        Parameters:
        selector - A selector to use when resolving DOM element.
        Since:
        v1.14

      • name

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

        Since:
        v1.8

      • page

        Page page()
        Returns the page containing this frame.
        Since:
        v1.8

      • parentFrame

        Frame parentFrame()
        Parent frame, if any. Detached frames and main frames return null.
        Since:
        v1.8

      • press

        default void press​(String selector,
                   String key)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        key - Name of the key to press or a character to generate, such as ArrowLeft or a.
        Since:
        v1.8

      • press

        void press​(String selector,
           String key,
           Frame.PressOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        key - Name of the key to press or a character to generate, such as ArrowLeft or a.
        Since:
        v1.8

      • querySelector

        default ElementHandle querySelector​(String selector)
        Returns the ElementHandle pointing to the frame element.

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

        Parameters:
        selector - A selector to query for.
        Since:
        v1.9

      • querySelector

        ElementHandle querySelector​(String selector,
                            Frame.QuerySelectorOptions options)
        Returns the ElementHandle pointing to the frame element.

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

        Parameters:
        selector - A selector to query for.
        Since:
        v1.9

      • querySelectorAll

        List<ElementHandle> querySelectorAll​(String selector)
        Returns the ElementHandles pointing to the frame elements.

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

        Parameters:
        selector - A selector to query for.
        Since:
        v1.9

      • selectOption

        default List<String> selectOption​(String selector,
                                  String values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          String values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        default List<String> selectOption​(String selector,
                                  ElementHandle values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          ElementHandle values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        default List<String> selectOption​(String selector,
                                  String[] values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          String[] values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        default List<String> selectOption​(String selector,
                                  SelectOption values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          SelectOption values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        default List<String> selectOption​(String selector,
                                  ElementHandle[] values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          ElementHandle[] values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        default List<String> selectOption​(String selector,
                                  SelectOption[] values)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • selectOption

        List<String> selectOption​(String selector,
                          SelectOption[] values,
                          Frame.SelectOptionOptions options)
        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"});
        Parameters:
        selector - A selector to query for.
        values - 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.
        Since:
        v1.8

      • setChecked

        default void setChecked​(String selector,
                        boolean checked)
        This method checks or unchecks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
        3. If the element already has the right checked state, this method returns immediately.
        4. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        5. Scroll the element into view if needed.
        6. Use Page.mouse() to click in the center of the element.
        7. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        8. Ensure that the element is now checked or unchecked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        checked - Whether to check or uncheck the checkbox.
        Since:
        v1.15

      • setChecked

        void setChecked​(String selector,
                boolean checked,
                Frame.SetCheckedOptions options)
        This method checks or unchecks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
        3. If the element already has the right checked state, this method returns immediately.
        4. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        5. Scroll the element into view if needed.
        6. Use Page.mouse() to click in the center of the element.
        7. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        8. Ensure that the element is now checked or unchecked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        checked - Whether to check or uncheck the checkbox.
        Since:
        v1.15

      • setContent

        default void setContent​(String html)
        This method internally calls document.write(), inheriting all its specific characteristics and behaviors.
        Parameters:
        html - HTML markup to assign to the page.
        Since:
        v1.8

      • setContent

        void setContent​(String html,
                Frame.SetContentOptions options)
        This method internally calls document.write(), inheriting all its specific characteristics and behaviors.
        Parameters:
        html - HTML markup to assign to the page.
        Since:
        v1.8

      • setInputFiles

        default void setInputFiles​(String selector,
                           Path files)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        void setInputFiles​(String selector,
                   Path files,
                   Frame.SetInputFilesOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        default void setInputFiles​(String selector,
                           Path[] files)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        void setInputFiles​(String selector,
                   Path[] files,
                   Frame.SetInputFilesOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        default void setInputFiles​(String selector,
                           FilePayload files)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        void setInputFiles​(String selector,
                   FilePayload files,
                   Frame.SetInputFilesOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        default void setInputFiles​(String selector,
                           FilePayload[] files)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • setInputFiles

        void setInputFiles​(String selector,
                   FilePayload[] files,
                   Frame.SetInputFilesOptions options)
        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.

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • tap

        default void tap​(String selector)
        This method taps an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.touchscreen() to tap the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

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

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • tap

        void tap​(String selector,
         Frame.TapOptions options)
        This method taps an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        3. Scroll the element into view if needed.
        4. Use Page.touchscreen() to tap the center of the element, or the specified position.
        5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

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

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • textContent

        default String textContent​(String selector)
        Returns element.textContent.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • textContent

        String textContent​(String selector,
                   Frame.TextContentOptions options)
        Returns element.textContent.
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • title

        String title()
        Returns the page title.
        Since:
        v1.8

      • type

        default void type​(String selector,
                  String text)
        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().
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        text - A text to type into a focused element.
        Since:
        v1.8

      • type

        void type​(String selector,
          String text,
          Frame.TypeOptions options)
        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().
        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        text - A text to type into a focused element.
        Since:
        v1.8

      • uncheck

        default void uncheck​(String selector)
        This method checks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
        3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        4. Scroll the element into view if needed.
        5. Use Page.mouse() to click in the center of the element.
        6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        7. Ensure that the element is now unchecked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • uncheck

        void uncheck​(String selector,
             Frame.UncheckOptions options)
        This method checks an element matching selector by performing the following steps:
        1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
        2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
        3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
        4. Scroll the element into view if needed.
        5. Use Page.mouse() to click in the center of the element.
        6. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
        7. Ensure that the element is now unchecked. If not, this method throws.

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

        Parameters:
        selector - A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
        Since:
        v1.8

      • url

        String url()
        Returns frame's url.
        Since:
        v1.8

      • waitForFunction

        default JSHandle waitForFunction​(String expression,
                                 Object arg)
        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);
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.8

      • waitForFunction

        default JSHandle waitForFunction​(String expression)
        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);
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        Since:
        v1.8

      • waitForFunction

        JSHandle waitForFunction​(String expression,
                         Object arg,
                         Frame.WaitForFunctionOptions options)
        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);
        Parameters:
        expression - JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.
        arg - Optional argument to pass to expression.
        Since:
        v1.8

      • waitForLoadState

        default void waitForLoadState​(LoadState state)
        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.
        Parameters:
        state - 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.
        Since:
        v1.8

      • waitForLoadState

        default void 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.
        Since:
        v1.8

      • waitForLoadState

        void waitForLoadState​(LoadState state,
                      Frame.WaitForLoadStateOptions options)
        Waits for the required load state to be reached.

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

        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.
        Parameters:
        state - 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.
        Since:
        v1.8

      • waitForNavigation

        default Response waitForNavigation​(Runnable callback)
        Deprecated.
        This method is inherently racy, please use Frame.waitForURL() instead.
        Parameters:
        callback - Callback that performs the action triggering the event.
        Since:
        v1.8

      • waitForSelector

        default ElementHandle waitForSelector​(String selector)
        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();
     }
   }
 }
        Parameters:
        selector - A selector to query for.
        Since:
        v1.8

      • waitForSelector

        ElementHandle waitForSelector​(String selector,
                              Frame.WaitForSelectorOptions options)
        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();
     }
   }
 }
        Parameters:
        selector - A selector to query for.
        Since:
        v1.8

      • waitForTimeout

        void waitForTimeout​(double timeout)
        Waits for the given timeout in milliseconds.

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

        Parameters:
        timeout - A timeout to wait for
        Since:
        v1.8

      • waitForURL

        default void waitForURL​(String url)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11

      • waitForURL

        void waitForURL​(String url,
                Frame.WaitForURLOptions options)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11

      • waitForURL

        default void waitForURL​(Pattern url)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11

      • waitForURL

        void waitForURL​(Pattern url,
                Frame.WaitForURLOptions options)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11

      • waitForURL

        default void waitForURL​(Predicate<String> url)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11

      • waitForURL

        void waitForURL​(Predicate<String> url,
                Frame.WaitForURLOptions options)
        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");
        Parameters:
        url - 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.
        Since:
        v1.11