playwright-ruby-client 0.8.0 → 1.14.beta2

data/documentation/docs/api/page.md

@@ -104,6 +104,7 @@ def check(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -136,6 +137,7 @@ def click(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -194,6 +196,7 @@ def dblclick(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -217,7 +220,12 @@ Shortcut for main frame's [Frame#dblclick](./frame#dblclick).
 ## dispatch_event
 
 ```
-def dispatch_event(selector, type, eventInit: nil, timeout: nil)
+def dispatch_event(
+      selector,
+      type,
+      eventInit: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
@@ -253,6 +261,23 @@ page.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_tran
 
 
 
+## drag_and_drop
+
+```
+def drag_and_drop(
+      source,
+      target,
+      force: nil,
+      noWaitAfter: nil,
+      sourcePosition: nil,
+      strict: nil,
+      targetPosition: nil,
+      timeout: nil,
+      trial: nil)
+```
+
+
+
 ## emulate_media
 
 ```
@@ -287,7 +312,7 @@ page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # =
 ## eval_on_selector
 
 ```
-def eval_on_selector(selector, expression, arg: nil)
+def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page and passes it as a first argument to
@@ -504,6 +529,7 @@ def fill(
       value,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -523,7 +549,7 @@ Shortcut for main frame's [Frame#fill](./frame#fill).
 ## focus
 
 ```
-def focus(selector, timeout: nil)
+def focus(selector, strict: nil, timeout: nil)
 ```
 
 This method fetches an element with `selector` and focuses it. If there's no element matching `selector`, the method
@@ -560,7 +586,7 @@ An array of all frames attached to the page.
 ## get_attribute
 
 ```
-def get_attribute(selector, name, timeout: nil)
+def get_attribute(selector, name, strict: nil, timeout: nil)
 ```
 
 Returns element attribute value.
@@ -622,6 +648,7 @@ def hover(
       force: nil,
       modifiers: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -642,7 +669,7 @@ Shortcut for main frame's [Frame#hover](./frame#hover).
 ## inner_html
 
 ```
-def inner_html(selector, timeout: nil)
+def inner_html(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerHTML`.
@@ -650,7 +677,7 @@ Returns `element.innerHTML`.
 ## inner_text
 
 ```
-def inner_text(selector, timeout: nil)
+def inner_text(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.innerText`.
@@ -658,15 +685,15 @@ Returns `element.innerText`.
 ## input_value
 
 ```
-def input_value(selector, timeout: nil)
+def input_value(selector, strict: nil, timeout: nil)
 ```
 
-Returns `input.value` for the selected `<input>` or `<textarea>` element. Throws for non-input elements.
+Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element. Throws for non-input elements.
 
 ## checked?
 
 ```
-def checked?(selector, timeout: nil)
+def checked?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
@@ -682,7 +709,7 @@ Indicates that the page has been closed.
 ## disabled?
 
 ```
-def disabled?(selector, timeout: nil)
+def disabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability).
@@ -690,7 +717,7 @@ Returns whether the element is disabled, the opposite of [enabled](https://playw
 ## editable?
 
 ```
-def editable?(selector, timeout: nil)
+def editable?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [editable](https://playwright.dev/python/docs/actionability).
@@ -698,7 +725,7 @@ Returns whether the element is [editable](https://playwright.dev/python/docs/act
 ## enabled?
 
 ```
-def enabled?(selector, timeout: nil)
+def enabled?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability).
@@ -706,7 +733,7 @@ Returns whether the element is [enabled](https://playwright.dev/python/docs/acti
 ## hidden?
 
 ```
-def hidden?(selector, timeout: nil)
+def hidden?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability).  `selector` that does not
@@ -715,12 +742,26 @@ match any elements is considered hidden.
 ## visible?
 
 ```
-def visible?(selector, timeout: nil)
+def visible?(selector, strict: nil, timeout: nil)
 ```
 
 Returns whether the element is [visible](https://playwright.dev/python/docs/actionability). `selector` that does not match any elements is
 considered not visible.
 
+## locator
+
+```
+def locator(selector)
+```
+
+The method returns an element locator that can be used to perform actions on the page. 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.
+
+Note that locator always implies visibility, so it will always be locating visible elements.
+
+Shortcut for main frame's [Frame#locator](./frame#locator).
+
 ## main_frame
 
 ```
@@ -737,6 +778,21 @@ def opener
 
 Returns the opener for popup pages and `null` for others. If the opener has been closed already the returns `null`.
 
+## pause
+
+```
+def pause
+```
+
+Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button
+in the page overlay or to call `playwright.resume()` in the DevTools console.
+
+User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from
+the place it was paused.
+
+> NOTE: This method requires Playwright to be started in a headed mode, with a falsy `headless` value in the
+[BrowserType#launch](./browser_type#launch).
+
 ## pdf
 
 ```
@@ -810,6 +866,7 @@ def press(
       key,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -847,7 +904,7 @@ page.screenshot(path: "o.png")
 ## query_selector
 
 ```
-def query_selector(selector)
+def query_selector(selector, strict: nil)
 ```
 
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
@@ -949,6 +1006,7 @@ def select_option(
       label: nil,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1027,7 +1085,12 @@ The extra HTTP headers will be sent with every request the page initiates.
 ## set_input_files
 
 ```
-def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
+def set_input_files(
+      selector,
+      files,
+      noWaitAfter: nil,
+      strict: nil,
+      timeout: nil)
 ```
 
 This method expects `selector` to point to an
@@ -1065,6 +1128,7 @@ def tap_point(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1087,7 +1151,7 @@ Shortcut for main frame's [Frame#tap_point](./frame#tap_point).
 ## text_content
 
 ```
-def text_content(selector, timeout: nil)
+def text_content(selector, strict: nil, timeout: nil)
 ```
 
 Returns `element.textContent`.
@@ -1108,6 +1172,7 @@ def type(
       text,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1131,6 +1196,7 @@ def uncheck(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1199,7 +1265,7 @@ throw an error if the page is closed before the [`event: Page.console`] event is
 def expect_download(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a new `Download`. If predicate is provided, it passes `Download` value into the
+Performs action and waits for a new [Download](./download). If predicate is provided, it passes [Download](./download) value into the
 `predicate` function and waits for `predicate(download)` to return a truthy value. Will throw an error if the page is
 closed before the download event is fired.
 
@@ -1320,7 +1386,7 @@ Performs action and waits for a popup [Page](./page). If predicate is provided,
 def expect_request(urlOrPredicate, timeout: nil, &block)
 ```
 
-Waits for the matching request and returns it.  See [waiting for event](https://playwright.dev/python/docs/events) for more details
+Waits for the matching request and returns it. See [waiting for event](https://playwright.dev/python/docs/events) for more details
 about events.
 
 ```ruby
@@ -1380,7 +1446,7 @@ puts response.body
 ## wait_for_selector
 
 ```
-def wait_for_selector(selector, state: nil, timeout: nil)
+def wait_for_selector(selector, state: nil, strict: nil, timeout: nil)
 ```
 
 Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
@@ -1402,6 +1468,23 @@ end
 
 
 
+## wait_for_timeout
+
+```
+def wait_for_timeout(timeout)
+```
+
+Waits for the given `timeout` in milliseconds.
+
+Note that `page.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.
+
+```ruby
+page.wait_for_timeout(1000)
+```
+
+Shortcut for main frame's [Frame#wait_for_timeout](./frame#wait_for_timeout).
+
 ## wait_for_url
 
 ```
@@ -1425,6 +1508,27 @@ def expect_websocket(predicate: nil, timeout: nil, &block)
 
 Performs action and waits for a new [WebSocket](./web_socket). If predicate is provided, it passes [WebSocket](./web_socket) value into the `predicate` function and waits for `predicate.call(web_socket)` to return a truthy value. Will throw an error if the page is closed before the WebSocket event is fired.
 
+## expect_worker
+
+```
+def expect_worker(predicate: nil, timeout: nil, &block)
+```
+
+Performs action and waits for a new [Worker](./worker). If predicate is provided, it passes [Worker](./worker) value into the `predicate`
+function and waits for `predicate(worker)` to return a truthy value. Will throw an error if the page is closed before
+the worker event is fired.
+
+## workers
+
+```
+def workers
+```
+
+This method returns all of the dedicated [WebWorkers](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
+associated with the page.
+
+> NOTE: This does not contain ServiceWorkers
+
 ## accessibility
 
 ## keyboard

data/documentation/docs/api/touchscreen.md

@@ -6,3 +6,11 @@ sidebar_position: 10
 
 The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the
 touchscreen can only be used in browser contexts that have been initialized with `hasTouch` set to true.
+
+## tap_point
+
+```
+def tap_point(x, y)
+```
+
+Dispatches a `touchstart` and `touchend` event with a single touch at the position (`x`,`y`).

data/documentation/docs/api/worker.md

@@ -22,3 +22,40 @@ for worker in page.workers:
 ```
 
 
+
+## evaluate
+
+```
+def evaluate(expression, arg: nil)
+```
+
+Returns the return value of `expression`.
+
+If the function passed to the [Worker#evaluate](./worker#evaluate) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Worker#evaluate](./worker#evaluate) would
+wait for the promise to resolve and return its value.
+
+If the function passed to the [Worker#evaluate](./worker#evaluate) returns a non-[Serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) value, then
+[Worker#evaluate](./worker#evaluate) returns `undefined`. Playwright also supports transferring some additional values that are
+not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+
+## evaluate_handle
+
+```
+def evaluate_handle(expression, arg: nil)
+```
+
+Returns the return value of `expression` as a [JSHandle](./js_handle).
+
+The only difference between [Worker#evaluate](./worker#evaluate) and [Worker#evaluate_handle](./worker#evaluate_handle) is that
+[Worker#evaluate_handle](./worker#evaluate_handle) returns [JSHandle](./js_handle).
+
+If the function passed to the [Worker#evaluate_handle](./worker#evaluate_handle) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then
+[Worker#evaluate_handle](./worker#evaluate_handle) would wait for the promise to resolve and return its value.
+
+## url
+
+```
+def url
+```
+
+

data/documentation/docs/article/guides/inspector.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 6
+---
+
+# Playwright inspector
+
+Playwright provides an useful inspector.
+https://playwright.dev/docs/inspector/
+
+## Overview
+
+```ruby {4,8}
+playwright.chromium.launch(headless: false) do |browser|
+  browser.new_context do |context|
+    # This method call should be put just after creating BrowserContext.
+    context.enable_debug_console!
+
+    page = context.new_pagè
+    page.goto('http://example.com/')
+    page.pause
+  end
+end
+```
+
+`page.pause` requires Playwright debug session, and it can be enabled by calling `BrowserContext#enable_debug_console!` in advance.
+
+Note that since Ruby is not officially supported in Playwright, many limitations exist. We CANNOT
+
+* Launch inspector via `PWDEBUG=1`
+* Debug without inspector UI (`PWDEBUG=console` is not working well)
+* Show Ruby code in inspector