playwright-ruby-client 0.8.1 → 1.14.beta3

data/documentation/docs/api/mouse.md

@@ -8,16 +8,15 @@ The Mouse class operates in main-frame CSS pixels relative to the top-left corne
 
 Every `page` object has its own Mouse, accessible with [Page#mouse](./page#mouse).
 
-```python sync title=example_ba01da1f358cafb4c22b792488ff2f3de4dbd82d4ee1cc4050e3f0c24a2bd7dd.py
+```ruby
 # using ‘page.mouse’ to trace a 100x100 square.
 page.mouse.move(0, 0)
-page.mouse.down()
+page.mouse.down
 page.mouse.move(0, 100)
 page.mouse.move(100, 100)
 page.mouse.move(100, 0)
 page.mouse.move(0, 0)
-page.mouse.up()
-
+page.mouse.up
 ```
 
 

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,
@@ -261,6 +269,9 @@ def drag_and_drop(
       target,
       force: nil,
       noWaitAfter: nil,
+      sourcePosition: nil,
+      strict: nil,
+      targetPosition: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -301,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
@@ -518,6 +529,7 @@ def fill(
       value,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -537,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
@@ -574,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.
@@ -636,6 +648,7 @@ def hover(
       force: nil,
       modifiers: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -656,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`.
@@ -664,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`.
@@ -672,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.
@@ -696,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).
@@ -704,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).
@@ -712,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).
@@ -720,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
@@ -729,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
 
 ```
@@ -751,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
 
 ```
@@ -824,6 +866,7 @@ def press(
       key,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -861,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
@@ -963,6 +1006,7 @@ def select_option(
       label: nil,
       force: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1041,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
@@ -1079,6 +1128,7 @@ def tap_point(
       modifiers: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1101,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`.
@@ -1122,6 +1172,7 @@ def type(
       text,
       delay: nil,
       noWaitAfter: nil,
+      strict: nil,
       timeout: nil)
 ```
 
@@ -1145,6 +1196,7 @@ def uncheck(
       force: nil,
       noWaitAfter: nil,
       position: nil,
+      strict: nil,
       timeout: nil,
       trial: nil)
 ```
@@ -1213,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.
 
@@ -1394,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
@@ -1416,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
 
 ```
@@ -1439,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/request.md

@@ -28,9 +28,8 @@ The method returns `null` unless this request has failed, as reported by `reques
 
 Example of logging of all the failed requests:
 
-```py title=example_5f3f4534ab17f584cfd41ca38448ce7de9490b6588e29e73116ede3cb15a25a5.py
-page.on("requestfailed", lambda request: print(request.url + " " + request.failure))
-
+```ruby
+page.on("requestfailed", ->(request) { puts "#{request.url} #{request.failure}" })
 ```
 
 
@@ -108,18 +107,17 @@ construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
 
 For example, if the website `http://example.com` redirects to `https://example.com`:
 
-```python sync title=example_89568fc86bf623eef37b68c6659b1a8524647c8365bb32a7a8af63bd86111075.py
-response = page.goto("http://example.com")
-print(response.request.redirected_from.url) # "http://example.com"
-
+```ruby
+response = page.goto("http://github.com")
+puts response.url # => "https://github.com"
+puts response.request.redirected_from&.url # => "http://github.com"
 ```
 
 If the website `https://google.com` has no redirects:
 
-```python sync title=example_6d7b3fbf8d69dbe639b71fedc5a8977777fca29dfb16d38012bb07c496342472.py
+```ruby
 response = page.goto("https://google.com")
-print(response.request.redirected_from) # None
-
+puts response.request.redirected_from&.url # => nil
 ```
 
 
@@ -134,9 +132,8 @@ New request issued by the browser if the server responded with redirect.
 
 This method is the opposite of [Request#redirected_from](./request#redirected_from):
 
-```py title=example_922623f4033e7ec2158787e54a8554655f7e1e20a024e4bf4f69337f781ab88a.py
-assert request.redirected_from.redirected_to == request
-
+```ruby
+request.redirected_from.redirected_to # equals to request
 ```
 
 
@@ -169,12 +166,11 @@ Returns resource timing information for given request. Most of the timing values
 `responseEnd` becomes available when request finishes. Find more information at
 [Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
 
-```python sync title=example_e2a297fe95fd0699b6a856c3be2f28106daa2615c0f4d6084f5012682a619d20.py
-with page.expect_event("requestfinished") as request_info:
-    page.goto("http://example.com")
-request = request_info.value
-print(request.timing)
-
+```ruby
+request = page.expect_event("requestfinished") do
+  page.goto("https://example.com")
+end
+puts request.timing
 ```
 
 

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/tracing.md

@@ -9,13 +9,14 @@ Playwright script runs.
 
 Start with specifying the folder traces will be stored in:
 
-```python sync title=example_a767dfb400d98aef50f2767b94171d23474ea1ac1cf9b4d75d412936208e652d.py
-browser = chromium.launch()
-context = browser.new_context()
-context.tracing.start(screenshots=True, snapshots=True)
-page.goto("https://playwright.dev")
-context.tracing.stop(path = "trace.zip")
-
+```ruby
+browser.new_page do |page|
+  context = page.context
+
+  context.tracing.start(screenshots: true, snapshots: true)
+  page.goto('https://playwright.dev')
+  context.tracing.stop(path: 'trace.zip')
+end
 ```
 
 
@@ -28,12 +29,12 @@ def start(name: nil, screenshots: nil, snapshots: nil)
 
 Start tracing.
 
-```python sync title=example_e611abc8b1066118d0c87eae1bbbb08df655f36d50a94402fc56b8713150997b.py
-context.tracing.start(name="trace", screenshots=True, snapshots=True)
-page.goto("https://playwright.dev")
-context.tracing.stop()
-context.tracing.stop(path = "trace.zip")
+```ruby
+context = page.context
 
+context.tracing.start(name: 'trace', screenshots: true, snapshots: true)
+page.goto('https://playwright.dev')
+context.tracing.stop(path: 'trace.zip')
 ```