playwright-ruby-client 1.28.1 → 1.29.0

data/documentation/docs/api/browser_context.md

@@ -26,37 +26,38 @@ page.goto("https://example.com")
 context.close
 ```
 
-
-
 ## add_cookies
 
 ```
 def add_cookies(cookies)
 ```
 
+
 Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be
 obtained via [BrowserContext#cookies](./browser_context#cookies).
 
+**Usage**
+
 ```ruby
 browser_context.add_cookies([cookie_object1, cookie_object2])
 ```
 
-
-
 ## add_init_script
 
 ```
 def add_init_script(path: nil, script: nil)
 ```
 
+
 Adds a script which would be evaluated in one of the following scenarios:
 - Whenever a page is created in the browser context or is navigated.
-- Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is
-  evaluated in the context of the newly attached frame.
+- Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.
 
 The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend
 the JavaScript environment, e.g. to seed `Math.random`.
 
+**Usage**
+
 An example of overriding `Math.random` before the page loads:
 
 ```ruby
@@ -64,7 +65,7 @@ An example of overriding `Math.random` before the page loads:
 browser_context.add_init_script(path: "preload.js")
 ```
 
-> NOTE: The order of evaluation of multiple scripts installed via [BrowserContext#add_init_script](./browser_context#add_init_script) and
+**NOTE**: The order of evaluation of multiple scripts installed via [BrowserContext#add_init_script](./browser_context#add_init_script) and
 [Page#add_init_script](./page#add_init_script) is not defined.
 
 ## background_pages
@@ -73,7 +74,8 @@ browser_context.add_init_script(path: "preload.js")
 def background_pages
 ```
 
-> NOTE: Background pages are only supported on Chromium-based browsers.
+
+**NOTE**: Background pages are only supported on Chromium-based browsers.
 
 All existing background pages in the context.
 
@@ -83,6 +85,7 @@ All existing background pages in the context.
 def browser
 ```
 
+
 Returns the browser instance of the context. If it was launched as a persistent context null gets returned.
 
 ## clear_cookies
@@ -91,6 +94,7 @@ Returns the browser instance of the context. If it was launched as a persistent
 def clear_cookies
 ```
 
+
 Clears context cookies.
 
 ## clear_permissions
@@ -99,8 +103,11 @@ Clears context cookies.
 def clear_permissions
 ```
 
+
 Clears all permission overrides for the browser context.
 
+**Usage**
+
 ```ruby
 context = browser.new_context
 context.grant_permissions(["clipboard-read"])
@@ -110,17 +117,16 @@ context.grant_permissions(["clipboard-read"])
 context.clear_permissions
 ```
 
-
-
 ## close
 
 ```
 def close
 ```
 
+
 Closes the browser context. All the pages that belong to the browser context will be closed.
 
-> NOTE: The default browser context cannot be closed.
+**NOTE**: The default browser context cannot be closed.
 
 ## cookies
 
@@ -128,6 +134,7 @@ Closes the browser context. All the pages that belong to the browser context wil
 def cookies(urls: nil)
 ```
 
+
 If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs
 are returned.
 
@@ -137,14 +144,18 @@ are returned.
 def expose_binding(name, callback, handle: nil)
 ```
 
-The method adds a function called `name` on the `window` object of every frame in every page in the context. When
-called, the function executes `callback` and returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves to the return value of `callback`. If
-the `callback` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), it will be awaited.
 
-The first argument of the `callback` function contains information about the caller: `{ browser_context: BrowserContext, page: Page, frame: Frame }`.
+The method adds a function called `name` on the `window` object of every frame in every page in the context.
+When called, the function executes `callback` and returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves to the return value of
+`callback`. If the `callback` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), it will be awaited.
+
+The first argument of the `callback` function contains information about the caller: `{ browserContext:
+BrowserContext, page: Page, frame: Frame }`.
 
 See [Page#expose_binding](./page#expose_binding) for page-only version.
 
+**Usage**
+
 An example of exposing page URL to all frames in all pages in the context:
 
 ```ruby
@@ -187,21 +198,23 @@ HTML
 page.locator('div').first.click
 ```
 
-
-
 ## expose_function
 
 ```
 def expose_function(name, callback)
 ```
 
-The method adds a function called `name` on the `window` object of every frame in every page in the context. When
-called, the function executes `callback` and returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves to the return value of `callback`.
+
+The method adds a function called `name` on the `window` object of every frame in every page in the context.
+When called, the function executes `callback` and returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which resolves to the return value of
+`callback`.
 
 If the `callback` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), it will be awaited.
 
 See [Page#expose_function](./page#expose_function) for page-only version.
 
+**Usage**
+
 An example of adding a `sha256` function to all pages in the context:
 
 ```ruby
@@ -225,14 +238,13 @@ HTML
 page.get_by_role("button").click
 ```
 
-
-
 ## grant_permissions
 
 ```
 def grant_permissions(permissions, origin: nil)
 ```
 
+
 Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if
 specified.
 
@@ -242,7 +254,8 @@ specified.
 def new_cdp_session(page)
 ```
 
-> NOTE: CDP sessions are only supported on Chromium-based browsers.
+
+**NOTE**: CDP sessions are only supported on Chromium-based browsers.
 
 Returns the newly created session.
 
@@ -252,6 +265,7 @@ Returns the newly created session.
 def new_page(&block)
 ```
 
+
 Creates a new page in the browser context.
 
 ## pages
@@ -260,6 +274,7 @@ Creates a new page in the browser context.
 def pages
 ```
 
+
 Returns all open pages in the context.
 
 ## route
@@ -268,12 +283,13 @@ Returns all open pages in the context.
 def route(url, handler, times: nil)
 ```
 
+
 Routing provides the capability to modify network requests that are made by any page in the browser context. Once route
 is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
 
-> NOTE: [BrowserContext#route](./browser_context#route) will not intercept requests intercepted by Service Worker. See
-[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
-request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+**NOTE**: [BrowserContext#route](./browser_context#route) will not intercept requests intercepted by Service Worker. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+
+**Usage**
 
 An example of a naive handler that aborts all image requests:
 
@@ -293,8 +309,7 @@ context.route(/\.(png|jpg)$/, ->(route, request) { route.abort })
 page.goto("https://example.com")
 ```
 
-It is possible to examine the request to decide the route action. For example, mocking all requests that contain some
-post data, and leaving all other requests as is:
+It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:
 
 ```ruby
 def handle_route(route, request)
@@ -313,7 +328,7 @@ handlers.
 
 To remove a route with its handler you can use [BrowserContext#unroute](./browser_context#unroute).
 
-> NOTE: Enabling routing disables http cache.
+**NOTE**: Enabling routing disables http cache.
 
 ## route_from_har
 
@@ -321,12 +336,10 @@ To remove a route with its handler you can use [BrowserContext#unroute](./browse
 def route_from_har(har, notFound: nil, update: nil, url: nil)
 ```
 
-If specified the network requests that are made in the context will be served from the HAR file. Read more about
-[Replaying from HAR](https://playwright.dev/python/docs/network).
 
-Playwright will not serve requests intercepted by Service Worker from the HAR file. See
-[this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using
-request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
+If specified the network requests that are made in the context will be served from the HAR file. Read more about [Replaying from HAR](https://playwright.dev/python/docs/network#replaying-from-har).
+
+Playwright will not serve requests intercepted by Service Worker from the HAR file. See [this](https://github.com/microsoft/playwright/issues/1090) issue. We recommend disabling Service Workers when using request interception by setting `Browser.newContext.serviceWorkers` to `'block'`.
 
 ## service_workers
 
@@ -334,7 +347,8 @@ request interception by setting `Browser.newContext.serviceWorkers` to `'block'`
 def service_workers
 ```
 
-> NOTE: Service workers are only supported on Chromium-based browsers.
+
+**NOTE**: Service workers are only supported on Chromium-based browsers.
 
 All existing service workers in the context.
 
@@ -345,6 +359,7 @@ def set_default_navigation_timeout(timeout)
 ```
 alias: `default_navigation_timeout=`
 
+
 This setting will change the default maximum navigation time for the following methods and related shortcuts:
 - [Page#go_back](./page#go_back)
 - [Page#go_forward](./page#go_forward)
@@ -353,7 +368,7 @@ This setting will change the default maximum navigation time for the following m
 - [Page#set_content](./page#set_content)
 - [Page#expect_navigation](./page#expect_navigation)
 
-> NOTE: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout) and [Page#set_default_timeout](./page#set_default_timeout) take priority over
+**NOTE**: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout) and [Page#set_default_timeout](./page#set_default_timeout) take priority over
 [BrowserContext#set_default_navigation_timeout](./browser_context#set_default_navigation_timeout).
 
 ## set_default_timeout
@@ -363,9 +378,10 @@ def set_default_timeout(timeout)
 ```
 alias: `default_timeout=`
 
+
 This setting will change the default maximum time for all the methods accepting `timeout` option.
 
-> NOTE: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout), [Page#set_default_timeout](./page#set_default_timeout) and
+**NOTE**: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout), [Page#set_default_timeout](./page#set_default_timeout) and
 [BrowserContext#set_default_navigation_timeout](./browser_context#set_default_navigation_timeout) take priority over [BrowserContext#set_default_timeout](./browser_context#set_default_timeout).
 
 ## set_extra_http_headers
@@ -375,11 +391,12 @@ def set_extra_http_headers(headers)
 ```
 alias: `extra_http_headers=`
 
+
 The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged
 with page-specific extra HTTP headers set with [Page#set_extra_http_headers](./page#set_extra_http_headers). If page overrides a particular
 header, page-specific header value will be used instead of the browser context header value.
 
-> NOTE: [BrowserContext#set_extra_http_headers](./browser_context#set_extra_http_headers) does not guarantee the order of headers in the outgoing requests.
+**NOTE**: [BrowserContext#set_extra_http_headers](./browser_context#set_extra_http_headers) does not guarantee the order of headers in the outgoing requests.
 
 ## set_geolocation
 
@@ -388,14 +405,17 @@ def set_geolocation(geolocation)
 ```
 alias: `geolocation=`
 
+
 Sets the context's geolocation. Passing `null` or `undefined` emulates position unavailable.
 
+**Usage**
+
 ```ruby
 browser_context.geolocation = { latitude: 59.95, longitude: 30.31667 }
 ```
 
-> NOTE: Consider using [BrowserContext#grant_permissions](./browser_context#grant_permissions) to grant permissions for the browser context pages to
-read its geolocation.
+**NOTE**: Consider using [BrowserContext#grant_permissions](./browser_context#grant_permissions) to grant permissions for the browser context pages to read
+its geolocation.
 
 ## set_offline
 
@@ -412,6 +432,7 @@ alias: `offline=`
 def storage_state(path: nil)
 ```
 
+
 Returns storage state for this browser context, contains current cookies and local storage snapshot.
 
 ## unroute
@@ -420,8 +441,9 @@ Returns storage state for this browser context, contains current cookies and loc
 def unroute(url, handler: nil)
 ```
 
-Removes a route created with [BrowserContext#route](./browser_context#route). When `handler` is not specified, removes all routes for
-the `url`.
+
+Removes a route created with [BrowserContext#route](./browser_context#route). When `handler` is not specified, removes all
+routes for the `url`.
 
 ## expect_event
 
@@ -429,28 +451,32 @@ the `url`.
 def expect_event(event, predicate: nil, timeout: nil, &block)
 ```
 
+
 Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
 value. Will throw an error if the context closes before the event is fired. Returns the event data value.
 
+**Usage**
+
 ```ruby
 new_page = browser_context.expect_event('page') do
   page.get_by_role("button").click
 end
 ```
 
-
-
 ## expect_page
 
 ```
 def expect_page(predicate: nil, timeout: nil)
 ```
 
-Performs action and waits for a new [Page](./page) to be created in the context. If predicate is provided, it passes [Page](./page) value into the `predicate` and waits for `predicate.call(page)` to return a truthy value. Will throw an error if
-the context closes before new [Page](./page) is created.
+
+Performs action and waits for a new [Page](./page) to be created in the context. If predicate is provided, it passes
+[Page](./page) value into the `predicate` function and waits for `predicate(event)` to return a truthy value.
+Will throw an error if the context closes before new [Page](./page) is created.
 
 ## request
 
+
 API testing helper associated with this context. Requests made with this API will use context cookies.
 
 ## tracing

data/documentation/docs/api/browser_type.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # BrowserType
 
+
 BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a
 typical example of using Playwright to drive automation:
 
@@ -18,8 +19,6 @@ chromium.launch do |browser|
 end
 ```
 
-
-
 ## connect_over_cdp
 
 ```
@@ -31,11 +30,14 @@ def connect_over_cdp(
       &block)
 ```
 
+
 This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.
 
 The default browser context is accessible via [Browser#contexts](./browser#contexts).
 
-> NOTE: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
+**NOTE**: Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.
+
+**Usage**
 
 ```ruby
 browser = playwright.chromium.connect_over_cdp("http://localhost:9222")
@@ -43,14 +45,13 @@ default_context = browser.contexts.first
 page = default_context.pages.first
 ```
 
-
-
 ## executable_path
 
 ```
 def executable_path
 ```
 
+
 A path where Playwright expects to find a bundled browser executable.
 
 ## launch
@@ -77,8 +78,11 @@ def launch(
       &block)
 ```
 
+
 Returns the browser instance.
 
+**Usage**
+
 You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
 
 ```ruby
@@ -89,18 +93,19 @@ browser = playwright.chromium.launch( # or "firefox" or "webkit".
 browser.close
 ```
 
-> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works
-best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use
-`executablePath` option with extreme caution.
+> **Chromium-only** Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of
+Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath`
+option with extreme caution.
+
 >
+
 > If Google Chrome (rather than Chromium) is preferred, a
 [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or
 [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested.
+
 >
-> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for
-video playback. See
-[this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other
-differences between Chromium and Chrome.
+
+> Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for other differences between Chromium and Chrome.
 [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md)
 describes some differences for Linux users.
 
@@ -159,10 +164,11 @@ def launch_persistent_context(
       &block)
 ```
 
+
 Returns the persistent browser context instance.
 
-Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing this
-context will automatically close the browser.
+Launches browser that uses persistent storage located at `userDataDir` and returns the only context. Closing
+this context will automatically close the browser.
 
 ## name
 
@@ -170,4 +176,5 @@ context will automatically close the browser.
 def name
 ```
 
+
 Returns browser name. For example: `'chromium'`, `'webkit'` or `'firefox'`.

data/documentation/docs/api/cdp_session.md

@@ -11,10 +11,8 @@ The [CDPSession](./cdp_session) instances are used to talk raw Chrome Devtools P
 - protocol events can be subscribed to with `session.on` method.
 
 Useful links:
-- Documentation on DevTools Protocol can be found here:
-  [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
-- Getting Started with DevTools Protocol:
-  https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
+- Documentation on DevTools Protocol can be found here: [DevTools Protocol Viewer](https://chromedevtools.github.io/devtools-protocol/).
+- Getting Started with DevTools Protocol: https://github.com/aslushnikov/getting-started-with-cdp/blob/master/README.md
 
 ```ruby
 client = page.context.new_cdp_session(page)
@@ -28,13 +26,13 @@ client.send_message(
 )
 ```
 
-
 ## detach
 
 ```
 def detach
 ```
 
+
 Detaches the CDPSession from the target. Once detached, the CDPSession object won't emit any events and can't be used to
 send messages.
 

data/documentation/docs/api/console_message.md

@@ -4,8 +4,10 @@ sidebar_position: 10
 
 # ConsoleMessage
 
-[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event. For each console messages logged
-in the page there will be corresponding event in the Playwright context.
+
+[ConsoleMessage](./console_message) objects are dispatched by page via the [`event: Page.console`] event.
+For each console messages logged in the page there will be corresponding event in the Playwright
+context.
 
 ```ruby
 # Listen for all console logs
@@ -30,14 +32,13 @@ msg.args[1].json_value # => 42
 msg.args[2].json_value # => { 'foo' => 'bar' }
 ```
 
-
-
 ## args
 
 ```
 def args
 ```
 
+
 List of arguments passed to a `console` function call. See also [`event: Page.console`].
 
 ## location
@@ -54,6 +55,7 @@ def location
 def text
 ```
 
+
 The text of the console message.
 
 ## type
@@ -62,6 +64,7 @@ The text of the console message.
 def type
 ```
 
+
 One of the following values: `'log'`, `'debug'`, `'info'`, `'error'`, `'warning'`, `'dir'`, `'dirxml'`, `'table'`,
 `'trace'`, `'clear'`, `'startGroup'`, `'startGroupCollapsed'`, `'endGroup'`, `'assert'`, `'profile'`, `'profileEnd'`,
 `'count'`, `'timeEnd'`.

data/documentation/docs/api/dialog.md

@@ -4,6 +4,7 @@ sidebar_position: 10
 
 # Dialog
 
+
 [Dialog](./dialog) objects are dispatched by page via the [`event: Page.dialog`] event.
 
 An example of using [Dialog](./dialog) class:
@@ -12,7 +13,7 @@ An example of using [Dialog](./dialog) class:
 def handle_dialog(dialog)
   puts "[#{dialog.type}] #{dialog.message}"
   if dialog.message =~ /foo/
-    dialog.accept_async
+    dialog.accept
   else
     dialog.dismiss
   end
@@ -25,10 +26,8 @@ page.evaluate("alert('bar')") # will be dismissed
 # => [alert] bar
 ```
 
-> NOTE: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener. When listener is
-present, it **must** either [Dialog#accept](./dialog#accept) or [Dialog#dismiss](./dialog#dismiss) the dialog - otherwise the page will
-[freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and
-actions like click will never finish.
+**NOTE**: Dialogs are dismissed automatically, unless there is a [`event: Page.dialog`] listener.
+When listener is present, it **must** either [Dialog#accept](./dialog#accept) or [Dialog#dismiss](./dialog#dismiss) the dialog - otherwise the page will [freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/EventLoop#never_blocking) waiting for the dialog, and actions like click will never finish.
 
 ## accept
 
@@ -36,6 +35,7 @@ actions like click will never finish.
 def accept(promptText: nil)
 ```
 
+
 Returns when the dialog has been accepted.
 
 ## default_value
@@ -44,6 +44,7 @@ Returns when the dialog has been accepted.
 def default_value
 ```
 
+
 If dialog is prompt, returns default prompt value. Otherwise, returns empty string.
 
 ## dismiss
@@ -52,6 +53,7 @@ If dialog is prompt, returns default prompt value. Otherwise, returns empty stri
 def dismiss
 ```
 
+
 Returns when the dialog has been dismissed.
 
 ## message
@@ -60,6 +62,7 @@ Returns when the dialog has been dismissed.
 def message
 ```
 
+
 A message displayed in the dialog.
 
 ## type
@@ -68,4 +71,5 @@ A message displayed in the dialog.
 def type
 ```
 
+
 Returns dialog's type, can be one of `alert`, `beforeunload`, `confirm` or `prompt`.