playwright-ruby-client 1.37.1 → 1.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d50bbadac84d3bfa4881ee450991e7e0999c9ca5daab2343bceb885d90522b
-  data.tar.gz: 16bfdd05cc45587c02a89a9e9098c32a518c3e6b81e254524393e71b47483391
+  metadata.gz: 88f3401d3e186312c93e17fa2758d30cdd45c7a95676af608b87a8052d548355
+  data.tar.gz: c0ac53d04666186f7ae9dc892c5c4a8a5ea982739c4a38e0740c5cece26543d0
 SHA512:
-  metadata.gz: 4e936a99c032fb86e7865cc8880c6679a23b2d621624a98b31d528a7c9d9886851b02b6cb9bab43937bf85b85a2d27ee2cbb0d15d25a11f2962066991531eac0
-  data.tar.gz: 5e3c6c5bf4af0df7129d6c5ed1ebd6b29928ed68b10b698eb3385ac414c3a04a7ec4a96b964feffa6a65e2f96a7821c3dea8e5b841d186312a66ec1ad53ad825
+  metadata.gz: bf802105e56ef6c3b3786ac24c53092eb32780cb0d98232c940cdbd8fb2cc44355d741c5d27312517e3c7ff5b63d683a4c6f4e6b939f99f62b56dcc2741e28f9
+  data.tar.gz: 1b0a0e47e92cbeb8f5142b54416ceeeaf8a16d5428452225433da0449f85ecfe77f6157ea794c29c308d311eda0e0e79b4cdac48238b82c9b6175b65602768b3

data/README.md

@@ -51,18 +51,24 @@ Playwright.create(playwright_cli_executable_path: './node_modules/.bin/playwrigh
     page = browser.new_page
     page.goto('https://github.com/')
 
-    form = page.query_selector("form.js-site-search-form")
-    search_input = form.query_selector("input.header-search-input")
-    search_input.click
+    page.get_by_placeholder("Search or jump to...").click
+    page.locator('input[name="query-builder-test"]').click
+
+    expect(page.keyboard).to be_a(::Playwright::Keyboard)
+
     page.keyboard.type("playwright")
     page.expect_navigation {
       page.keyboard.press("Enter")
     }
 
-    list = page.query_selector("ul.repo-list")
-    items = list.query_selector_all("div.f4")
-    items.each do |item|
-      title = item.eval_on_selector("a", "a => a.innerText")
+    list = page.get_by_test_id('results-list').locator('.search-title')
+
+    # wait for item to appear
+    list.first.wait_for
+
+    # list them
+    list.locator('.search-title').all.each do |item|
+      title = item.text_content
       puts("==> #{title}")
     end
   end

data/documentation/docs/api/download.md

@@ -10,15 +10,18 @@ sidebar_position: 10
 All the downloaded files belonging to the browser context are deleted when the
 browser context is closed.
 
-Download event is emitted once the download starts. Download path becomes available once download completes:
+Download event is emitted once the download starts. Download path becomes available once download completes.
 
-```ruby
-download = page.expect_download do
-  page.get_by_text("Download file").click
-end
+```python sync title=example_c247767083cf193df26a39a61a3a8bc19d63ed5c24db91b88c50b7d37975005d.py
+# Start waiting for the download
+with page.expect_download() as download_info:
+    # Perform the action that initiates download
+    page.get_by_text("Download file").click()
+download = download_info.value
+
+# Wait for the download process to complete and save the downloaded file somewhere
+download.save_as("/path/to/save/at/" + download.suggested_filename)
 
-# wait for download to complete
-path = download.path
 ```
 
 ## cancel
@@ -81,6 +84,13 @@ def save_as(path)
 Copy the download to a user-specified path. It is safe to call this method while the download
 is still in progress. Will wait for the download to finish if necessary.
 
+**Usage**
+
+```python sync title=example_66ffd4ef7286957e4294d84b8f660ff852c87af27a56b3e4dd9f84562b5ece02.py
+download.save_as("/path/to/save/at/" + download.suggested_filename)
+
+```
+
 ## suggested_filename
 
 ```

data/documentation/docs/api/element_handle.md

@@ -259,7 +259,7 @@ This method waits for [actionability](https://playwright.dev/python/docs/actiona
 
 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 [ElementHandle#type](./element_handle#type).
+To send fine-grained keyboard events, use [Locator#press_sequentially](./locator#press_sequentially).
 
 ## focus
 
@@ -614,19 +614,6 @@ To press a special key, like `Control` or `ArrowDown`, use [ElementHandle#press]
 
 **Usage**
 
-```ruby
-element_handle.type("hello") # types instantly
-element_handle.type("world", delay: 100) # types slower, like a user
-```
-
-An example of typing into a text field and then submitting the form:
-
-```ruby
-element_handle = page.query_selector("input")
-element_handle.type("some text")
-element_handle.press("Enter")
-```
-
 ## uncheck
 
 ```

data/documentation/docs/api/frame.md

@@ -349,7 +349,7 @@ This method waits for an element matching `selector`, waits for [actionability](
 
 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 [Frame#type](./frame#type).
+To send fine-grained keyboard events, use [Locator#press_sequentially](./locator#press_sequentially).
 
 ## focus
 
@@ -1041,11 +1041,6 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./ke
 
 **Usage**
 
-```ruby
-frame.type("#mytextarea", "hello") # types instantly
-frame.type("#mytextarea", "world", delay: 100) # types slower, like a user
-```
-
 ## uncheck
 
 ```

data/documentation/docs/api/keyboard.md

@@ -97,6 +97,8 @@ def press(key, delay: nil)
 ```
 
 
+**NOTE**: In most cases, you should use [Locator#press](./locator#press) instead.
+
 `key` can specify the intended
 [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key) value or a single character to
 generate the text for. A superset of the `key` values can be found
@@ -136,6 +138,8 @@ def type(text, delay: nil)
 ```
 
 
+**NOTE**: In most cases, you should use [Locator#fill](./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#press_sequentially](./locator#press_sequentially).
+
 Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
 
 To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./keyboard#press).

data/documentation/docs/api/locator.md

@@ -458,7 +458,7 @@ This method waits for [actionability](https://playwright.dev/python/docs/actiona
 
 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 [Locator#type](./locator#type).
+To send fine-grained keyboard events, use [Locator#press_sequentially](./locator#press_sequentially).
 
 ## filter
 
@@ -1032,6 +1032,36 @@ respective texts.
 Shortcuts such as `key: "Control+o"` 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.
 
+## press_sequentially
+
+```
+def press_sequentially(text, delay: nil, noWaitAfter: nil, timeout: nil)
+```
+
+
+**NOTE**: In most cases, you should use [Locator#fill](./locator#fill) instead. You only need to press keys one by one if there is special keyboard handling on the page.
+
+Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
+
+To press a special key, like `Control` or `ArrowDown`, use [Locator#press](./locator#press).
+
+**Usage**
+
+```python sync title=example_1b7781d5527574a18d4b9812e3461203d2acc9ba7e09cbfd0ffbc4154e3f5971.py
+locator.press_sequentially("hello") # types instantly
+locator.press_sequentially("world", delay=100) # types slower, like a user
+
+```
+
+An example of typing into a text field and then submitting the form:
+
+```python sync title=example_cc0a6b9aa95b97e5c17c4b114da10a29c7f6f793e99aee1ea2703636af6e24f9.py
+locator = page.get_by_label("Password")
+locator.press_sequentially("my password")
+locator.press("Enter")
+
+```
+
 ## screenshot
 
 ```
@@ -1254,27 +1284,12 @@ def type(text, delay: nil, noWaitAfter: nil, timeout: nil)
 ```
 
 
-**NOTE**: In most cases, you should use [Locator#fill](./locator#fill) instead. You only need to type characters if there is special keyboard handling on the page.
-
 Focuses the element, and then sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
 
 To press a special key, like `Control` or `ArrowDown`, use [Locator#press](./locator#press).
 
 **Usage**
 
-```ruby
-element.type("hello") # types instantly
-element.type("world", delay: 100) # types slower, like a user
-```
-
-An example of typing into a text field and then submitting the form:
-
-```ruby
-element = page.get_by_label("Password")
-element.type("my password")
-element.press("Enter")
-```
-
 ## uncheck
 
 ```