playwright-ruby-client 0.5.6 → 0.6.0

data/lib/playwright_api/file_chooser.rb

@@ -28,6 +28,13 @@ module Playwright
   # file_chooser = fc_info.value
   # file_chooser.set_files("myfile.pdf")
   # ```
+  # 
+  # ```csharp
+  # var waitForFileChooserTask = page.WaitForFileChooserAsync();
+  # await page.ClickAsync("upload");
+  # var fileChooser = await waitForFileChooserTask;
+  # await fileChooser.SetFilesAsync("temp.txt");
+  # ```
   class FileChooser < PlaywrightApi
 
     # Returns input element associated with this file chooser.

data/lib/playwright_api/frame.rb

@@ -96,6 +96,32 @@ module Playwright
   # with sync_playwright() as playwright:
   #     run(playwright)
   # ```
+  # 
+  # ```csharp
+  # using Microsoft.Playwright;
+  # using System;
+  # using System.Threading.Tasks;
+  # 
+  # class FrameExamples
+  # {
+  #     public static async Task Main()
+  #     {
+  #         using var playwright = await Playwright.CreateAsync();
+  #         await using var browser = await playwright.Firefox.LaunchAsync();
+  #         var page = await browser.NewPageAsync();
+  # 
+  #         await page.GotoAsync("https://www.bing.com");
+  #         DumpFrameTree(page.MainFrame, string.Empty);
+  #     }
+  # 
+  #     private static void DumpFrameTree(IFrame frame, string indent)
+  #     {
+  #         Console.WriteLine($"{indent}{frame.Url}");
+  #         foreach (var child in frame.ChildFrames)
+  #             DumpFrameTree(child, indent + " ");
+  #     }
+  # }
+  # ```
   class Frame < PlaywrightApi
 
     # Returns the added tag when the script's onload fires or when the script content was injected into frame.
@@ -131,8 +157,9 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.check(unwrap_impl(selector), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.check(unwrap_impl(selector), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     def child_frames
@@ -158,8 +185,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.click(unwrap_impl(selector), button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.click(unwrap_impl(selector), button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Gets the full HTML contents of the frame, including the doctype.
@@ -188,8 +216,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.dblclick(unwrap_impl(selector), button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.dblclick(unwrap_impl(selector), button: unwrap_impl(button), delay: unwrap_impl(delay), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
@@ -213,6 +242,10 @@ module Playwright
     # frame.dispatch_event("button#submit", "click")
     # ```
     # 
+    # ```csharp
+    # await frame.DispatchEventAsync("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.
     # 
@@ -253,6 +286,12 @@ module Playwright
     # data_transfer = frame.evaluate_handle("new DataTransfer()")
     # frame.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })
     # ```
+    # 
+    # ```csharp
+    # // Note you can only create DataTransfer in Chromium and Firefox
+    # var dataTransfer = await frame.EvaluateHandleAsync("() => new DataTransfer()");
+    # await frame.DispatchEventAsync("#source", "dragstart", new { dataTransfer });
+    # ```
     def dispatch_event(selector, type, eventInit: nil, timeout: nil)
       wrap_impl(@impl.dispatch_event(unwrap_impl(selector), unwrap_impl(type), eventInit: unwrap_impl(eventInit), timeout: unwrap_impl(timeout)))
     end
@@ -292,6 +331,12 @@ module Playwright
     # preload_href = frame.eval_on_selector("link[rel=preload]", "el => el.href")
     # html = frame.eval_on_selector(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello")
     # ```
+    # 
+    # ```csharp
+    # var searchValue = await frame.EvalOnSelectorAsync<string>("#search", "el => el.value");
+    # var preloadHref = await frame.EvalOnSelectorAsync<string>("link[rel=preload]", "el => el.href");
+    # var html = await frame.EvalOnSelectorAsync(".main-container", "(e, suffix) => e.outerHTML + suffix", "hello");
+    # ```
     def eval_on_selector(selector, expression, arg: nil)
       wrap_impl(@impl.eval_on_selector(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -322,6 +367,10 @@ module Playwright
     # ```python sync
     # divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)
     # ```
+    # 
+    # ```csharp
+    # var divsCount = await frame.EvalOnSelectorAllAsync<bool>("div", "(divs, min) => divs.length >= min", 10);
+    # ```
     def eval_on_selector_all(selector, expression, arg: nil)
       wrap_impl(@impl.eval_on_selector_all(unwrap_impl(selector), unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -360,6 +409,11 @@ module Playwright
     # print(result) # prints "56"
     # ```
     # 
+    # ```csharp
+    # var result = await frame.EvaluateAsync<int>("([x, y]) => Promise.resolve(x * y)", new[] { 7, 8 });
+    # Console.WriteLine(result);
+    # ```
+    # 
     # A string can also be passed in instead of a function.
     # 
     #
@@ -383,6 +437,10 @@ module Playwright
     # print(frame.evaluate(f"1 + {x}")) # prints "11"
     # ```
     # 
+    # ```csharp
+    # Console.WriteLine(await frame.EvaluateAsync<int>("1 + 2")); // prints "3"
+    # ```
+    # 
     # `ElementHandle` instances can be passed as an argument to the [`method: Frame.evaluate`]:
     # 
     #
@@ -409,6 +467,12 @@ module Playwright
     # html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
     # body_handle.dispose()
     # ```
+    # 
+    # ```csharp
+    # var bodyHandle = await frame.QuerySelectorAsync("body");
+    # var html = await frame.EvaluateAsync<string>("([body, suffix]) => body.innerHTML + suffix", new object [] { bodyHandle, "hello" });
+    # await bodyHandle.DisposeAsync();
+    # ```
     def evaluate(expression, arg: nil)
       wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -442,6 +506,11 @@ module Playwright
     # a_window_handle # handle for the window object.
     # ```
     # 
+    # ```csharp
+    # // Handle for the window object.
+    # var aWindowHandle = await frame.EvaluateHandleAsync("() => Promise.resolve(window)");
+    # ```
+    # 
     # A string can also be passed in instead of a function.
     # 
     #
@@ -461,6 +530,10 @@ module Playwright
     # a_handle = page.evaluate_handle("document") # handle for the "document"
     # ```
     # 
+    # ```csharp
+    # var docHandle = await frame.EvalueHandleAsync("document"); // Handle for the `document`
+    # ```
+    # 
     # `JSHandle` instances can be passed as an argument to the [`method: Frame.evaluateHandle`]:
     # 
     #
@@ -491,15 +564,25 @@ module Playwright
     # print(result_handle.json_value())
     # result_handle.dispose()
     # ```
+    # 
+    # ```csharp
+    # var handle = await frame.EvaluateHandleAsync("() => document.body");
+    # var resultHandle = await frame.EvaluateHandleAsync("([body, suffix]) => body.innerHTML + suffix", new object[] { handle, "hello" });
+    # Console.WriteLine(await resultHandle.JsonValueAsync<string>());
+    # await resultHandle.DisposeAsync();
+    # ```
     def evaluate_handle(expression, arg: nil)
       wrap_impl(@impl.evaluate_handle(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
 
     # This method waits for an element matching `selector`, waits for [actionability](./actionability.md) checks, focuses the
-    # element, fills it and triggers an `input` event after filling. If the element is inside the `<label>` element that has
-    # associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), that control will be
-    # filled instead. If the element to be filled is not an `<input>`, `<textarea>` or `[contenteditable]` element, this
-    # method throws an error. Note that you can pass an empty string to clear the input field.
+    # 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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled
+    # instead.
     # 
     # To send fine-grained keyboard events, use [`method: Frame.type`].
     def fill(selector, value, noWaitAfter: nil, timeout: nil)
@@ -543,8 +626,14 @@ module Playwright
     # content_frame = frame_element.content_frame()
     # assert frame == content_frame
     # ```
+    # 
+    # ```csharp
+    # var frameElement = await frame.FrameElementAsync();
+    # var contentFrame = await frameElement.ContentFrameAsync();
+    # Console.WriteLine(frame == contentFrame); // -> True
+    # ```
     def frame_element
-      raise NotImplementedError.new('frame_element is not implemented yet.')
+      wrap_impl(@impl.frame_element)
     end
 
     # Returns element attribute value.
@@ -589,8 +678,9 @@ module Playwright
           force: nil,
           modifiers: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.innerHTML`.
@@ -700,12 +790,16 @@ module Playwright
       wrap_impl(@impl.query_selector_all(unwrap_impl(selector)))
     end
 
-    # Returns the array of option values that have been successfully selected.
+    # This method waits for an element matching `selector`, waits for [actionability](./actionability.md) checks, waits until
+    # all specified options are present in the `<select>` element and selects these options.
     # 
-    # Triggers a `change` and `input` event once all the provided options have been selected. If there's no `<select>` element
-    # matching `selector`, the method throws an error.
+    # 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](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be used instead.
+    # 
+    # Returns the array of option values that have been successfully selected.
     # 
-    # Will wait until all specified options are present in the `<select>` element.
+    # Triggers a `change` and `input` event once all the provided options have been selected.
     # 
     #
     # ```js
@@ -745,6 +839,15 @@ module Playwright
     # # multiple selection
     # frame.select_option("select#colors", value=["red", "green", "blue"])
     # ```
+    # 
+    # ```csharp
+    # // single selection matching the value
+    # await frame.SelectOptionAsync("select#colors", new[] { "blue" });
+    # // single selection matching both the value and the label
+    # await frame.SelectOptionAsync("select#colors", new[] { new SelectOptionValue() { Label = "blue" } });
+    # // multiple selection
+    # await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" });
+    # ```
     def select_option(
           selector,
           element: nil,
@@ -788,8 +891,9 @@ module Playwright
           modifiers: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.tap_point(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.tap_point(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.textContent`.
@@ -829,6 +933,11 @@ module Playwright
     # frame.type("#mytextarea", "hello") # types instantly
     # frame.type("#mytextarea", "world", delay=100) # types slower, like a user
     # ```
+    # 
+    # ```csharp
+    # await frame.TypeAsync("#mytextarea", "hello"); // types instantly
+    # await frame.TypeAsync("#mytextarea", "world", delay: 100); // types slower, like a user
+    # ```
     def type(
           selector,
           text,
@@ -856,8 +965,9 @@ module Playwright
           force: nil,
           noWaitAfter: nil,
           position: nil,
-          timeout: nil)
-      wrap_impl(@impl.uncheck(unwrap_impl(selector), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout)))
+          timeout: nil,
+          trial: nil)
+      wrap_impl(@impl.uncheck(unwrap_impl(selector), force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns frame's url.
@@ -933,6 +1043,23 @@ module Playwright
     #     run(playwright)
     # ```
     # 
+    # ```csharp
+    # using Microsoft.Playwright;
+    # using System.Threading.Tasks;
+    # 
+    # class FrameExamples
+    # {
+    #     public static async Task Main()
+    #     {
+    #         using var playwright = await Playwright.CreateAsync();
+    #         await using var browser = await playwright.Firefox.LaunchAsync();
+    #         var page = await browser.NewPageAsync();
+    #         await page.SetViewportSizeAsync(50, 50);
+    #         await page.MainFrame.WaitForFunctionAsync("window.innerWidth < 100");
+    #     }
+    # }
+    # ```
+    # 
     # To pass an argument to the predicate of `frame.waitForFunction` function:
     # 
     #
@@ -955,6 +1082,11 @@ module Playwright
     # selector = ".foo"
     # frame.wait_for_function("selector => !!document.querySelector(selector)", selector)
     # ```
+    # 
+    # ```csharp
+    # var selector = ".foo";
+    # await page.MainFrame.WaitForFunctionAsync("selector => !!document.querySelector(selector)", selector);
+    # ```
     def wait_for_function(expression, arg: nil, polling: nil, timeout: nil)
       wrap_impl(@impl.wait_for_function(unwrap_impl(expression), arg: unwrap_impl(arg), polling: unwrap_impl(polling), timeout: unwrap_impl(timeout)))
     end
@@ -984,6 +1116,11 @@ module Playwright
     # frame.click("button") # click triggers navigation.
     # frame.wait_for_load_state() # the promise resolves after "load" event.
     # ```
+    # 
+    # ```csharp
+    # await frame.ClickAsync("button");
+    # await frame.WaitForLoadStateAsync(); // Defaults to LoadState.Load
+    # ```
     def wait_for_load_state(state: nil, timeout: nil)
       wrap_impl(@impl.wait_for_load_state(state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
@@ -1023,6 +1160,14 @@ module Playwright
     # # Resolves after navigation has finished
     # ```
     # 
+    # ```csharp
+    # await Task.WhenAll(
+    #     frame.WaitForNavigationAsync(),
+    #     // clicking the link will indirectly cause a navigation
+    #     frame.ClickAsync("a.delayed-navigation"));
+    # // Resolves after navigation has finished
+    # ```
+    # 
     # > NOTE: Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is
     # considered a navigation.
     def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
@@ -1110,6 +1255,29 @@ module Playwright
     # with sync_playwright() as playwright:
     #     run(playwright)
     # ```
+    # 
+    # ```csharp
+    # using Microsoft.Playwright;
+    # using System;
+    # using System.Threading.Tasks;
+    # 
+    # class FrameExamples
+    # {
+    #   public static async Task Main()
+    #   {
+    #     using var playwright = await Playwright.CreateAsync();
+    #     await using var browser = await playwright.Chromium.LaunchAsync();
+    #     var page = await browser.NewPageAsync();
+    # 
+    #     foreach (var currentUrl in new[] { "https://www.google.com", "https://bbc.com" })
+    #     {
+    #       await page.GotoAsync(currentUrl);
+    #       element = await page.MainFrame.WaitForSelectorAsync("img");
+    #       Console.WriteLine($"Loaded image: {await element.GetAttributeAsync("src")}");
+    #     }
+    #   }
+    # }
+    # ```
     def wait_for_selector(selector, state: nil, timeout: nil)
       wrap_impl(@impl.wait_for_selector(unwrap_impl(selector), state: unwrap_impl(state), timeout: unwrap_impl(timeout)))
     end
@@ -1144,6 +1312,11 @@ module Playwright
     # frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
     # frame.wait_for_url("**/target.html")
     # ```
+    # 
+    # ```csharp
+    # await frame.ClickAsync("a.delayed-navigation"); // clicking the link will indirectly cause a navigation
+    # await frame.WaitForURLAsync("**/target.html");
+    # ```
     def wait_for_url(url, timeout: nil, waitUntil: nil)
       wrap_impl(@impl.wait_for_url(unwrap_impl(url), timeout: unwrap_impl(timeout), waitUntil: unwrap_impl(waitUntil)))
     end
@@ -1155,20 +1328,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy

data/lib/playwright_api/js_handle.rb

@@ -23,6 +23,10 @@ module Playwright
   # # ...
   # ```
   # 
+  # ```csharp
+  # var windowHandle = await page.EvaluateHandleAsync("() => window");
+  # ```
+  # 
   # JSHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with
   # [`method: JSHandle.dispose`]. JSHandles are auto-disposed when their origin frame gets navigated or the parent context
   # gets destroyed.
@@ -69,6 +73,11 @@ module Playwright
     # tweet_handle = page.query_selector(".tweet .retweets")
     # assert tweet_handle.evaluate("node => node.innerText") == "10 retweets"
     # ```
+    # 
+    # ```csharp
+    # var tweetHandle = await page.QuerySelectorAsync(".tweet .retweets");
+    # Assert.Equals("10 retweets", await tweetHandle.EvaluateAsync("node => node.innerText"));
+    # ```
     def evaluate(expression, arg: nil)
       wrap_impl(@impl.evaluate(unwrap_impl(expression), arg: unwrap_impl(arg)))
     end
@@ -122,6 +131,14 @@ module Playwright
     # document_handle = properties.get("document")
     # handle.dispose()
     # ```
+    # 
+    # ```csharp
+    # var handle = await page.EvaluateHandleAsync("() => ({window, document}");
+    # var properties = await handle.GetPropertiesAsync();
+    # var windowHandle = properties["window"];
+    # var documentHandle = properties["document"];
+    # await handle.DisposeAsync();
+    # ```
     def get_properties
       wrap_impl(@impl.get_properties)
     end
@@ -147,20 +164,20 @@ module Playwright
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def once(event, callback)
-      event_emitter_proxy.once(event, callback)
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def on(event, callback)
-      event_emitter_proxy.on(event, callback)
+    def once(event, callback)
+      event_emitter_proxy.once(event, callback)
     end
 
     # -- inherited from EventEmitter --
     # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
+    def on(event, callback)
+      event_emitter_proxy.on(event, callback)
     end
 
     private def event_emitter_proxy