playwright-ruby-client 1.28.1 → 1.29.0

data/documentation/docs/api/page.md

@@ -40,22 +40,22 @@ page.off('request', listener)
 page.goto('https://example.com/') # => no print
 ```
 
-
-
 ## 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 the page is navigated.
-- Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the newly
-  attached frame.
+- Whenever the child frame is attached or navigated. 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
@@ -63,7 +63,7 @@ An example of overriding `Math.random` before the page loads:
 page.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.
 
 ## add_script_tag
@@ -72,28 +72,27 @@ page.add_init_script(path: "./preload.js")
 def add_script_tag(content: nil, path: nil, type: nil, url: nil)
 ```
 
+
 Adds a `<script>` tag into the page with the desired url or content. Returns the added tag when the script's onload
 fires or when the script content was injected into frame.
 
-Shortcut for main frame's [Frame#add_script_tag](./frame#add_script_tag).
-
 ## add_style_tag
 
 ```
 def add_style_tag(content: nil, path: nil, url: nil)
 ```
 
+
 Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the
 content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
 
-Shortcut for main frame's [Frame#add_style_tag](./frame#add_style_tag).
-
 ## bring_to_front
 
 ```
 def bring_to_front
 ```
 
+
 Brings page to front (activates tab).
 
 ## check
@@ -109,21 +108,18 @@ def check(
       trial: nil)
 ```
 
+
 This method checks an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already
-   checked, this method returns immediately.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to click in the center of the element.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 1. Ensure that the element is now checked. If not, this method throws.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
-
-Shortcut for main frame's [Frame#check](./frame#check).
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## click
 
@@ -142,18 +138,16 @@ def click(
       trial: nil)
 ```
 
+
 This method clicks an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to click in the center of the element, or the specified `position`.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
-
-Shortcut for main frame's [Frame#click](./frame#click).
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## close
 
@@ -161,13 +155,14 @@ Shortcut for main frame's [Frame#click](./frame#click).
 def close(runBeforeUnload: nil)
 ```
 
+
 If `runBeforeUnload` is `false`, does not run any unload handlers and waits for the page to be closed. If
 `runBeforeUnload` is `true` the method will run unload handlers, but will **not** wait for the page to close.
 
 By default, `page.close()` **does not** run `beforeunload` handlers.
 
-> NOTE: if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned and should be handled manually
-via [`event: Page.dialog`] event.
+**NOTE**: if `runBeforeUnload` is passed as true, a `beforeunload` dialog might be summoned and should be handled
+manually via [`event: Page.dialog`] event.
 
 ## content
 
@@ -175,6 +170,7 @@ via [`event: Page.dialog`] event.
 def content
 ```
 
+
 Gets the full HTML contents of the page, including the doctype.
 
 ## context
@@ -183,6 +179,7 @@ Gets the full HTML contents of the page, including the doctype.
 def context
 ```
 
+
 Get the browser context that the page belongs to.
 
 ## dblclick
@@ -201,21 +198,18 @@ def dblclick(
       trial: nil)
 ```
 
+
 This method double clicks an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to double click in the center of the element, or the specified `position`.
-1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the
-   first click of the `dblclick()` triggers a navigation event, this method will throw.
+1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
-> NOTE: `page.dblclick()` dispatches two `click` events and a single `dblclick` event.
-
-Shortcut for main frame's [Frame#dblclick](./frame#dblclick).
+**NOTE**: `page.dblclick()` dispatches two `click` events and a single `dblclick` event.
 
 ## dispatch_event
 
@@ -228,19 +222,24 @@ def dispatch_event(
       timeout: nil)
 ```
 
-The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element,
-`click` is dispatched. This is equivalent to calling
+
+The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the element, `click`
+is dispatched. This is equivalent to calling
 [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
 
+**Usage**
+
 ```ruby
 page.content = '<button id="submit">Send</button>'
 page.dispatch_event("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.
+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.
 
-Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
+Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial
+properties:
 - [DragEvent](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/DragEvent)
 - [FocusEvent](https://developer.mozilla.org/en-US/docs/Web/API/FocusEvent/FocusEvent)
 - [KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/KeyboardEvent)
@@ -259,8 +258,6 @@ data_transfer = page.evaluate_handle("new DataTransfer()")
 page.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_transfer })
 ```
 
-
-
 ## drag_and_drop
 
 ```
@@ -276,8 +273,12 @@ def drag_and_drop(
       trial: nil)
 ```
 
-This method drags the source element to the target element. It will first move to the source element, perform a
-`mousedown`, then move to the target element and perform a `mouseup`.
+
+This method drags the source element to the target element.
+It will first move to the source element, perform a `mousedown`,
+then move to the target element and perform a `mouseup`.
+
+**Usage**
 
 ```ruby
 page.drag_and_drop("#source", "#target")
@@ -290,16 +291,16 @@ page.drag_and_drop(
 )
 ```
 
-
-
 ## emulate_media
 
 ```
 def emulate_media(colorScheme: nil, forcedColors: nil, media: nil, reducedMotion: nil)
 ```
 
-This method changes the `CSS media type` through the `media` argument, and/or the `'prefers-colors-scheme'` media
-feature, using the `colorScheme` argument.
+
+This method changes the `CSS media type` through the `media` argument, and/or the `'prefers-colors-scheme'` media feature, using the `colorScheme` argument.
+
+**Usage**
 
 ```ruby
 page.evaluate("matchMedia('screen').matches") # => true
@@ -321,24 +322,21 @@ page.evaluate("matchMedia('(prefers-color-scheme: light)').matches") # => false
 page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches") # => false
 ```
 
-
-
 ## eval_on_selector
 
 ```
 def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
-> NOTE: This method does not wait for the element to pass actionability checks and therefore can lead to the flaky
-tests. Use [Locator#evaluate](./locator#evaluate), other [Locator](./locator) helper methods or web-first assertions instead.
 
 The method finds an element matching the specified selector within the page and passes it as a first argument to
-`expression`. If no elements match the selector, the method throws an error. Returns the value of `expression`.
+`expression`. If no elements match the selector, the method throws an error. Returns the value of
+`expression`.
 
 If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Page#eval_on_selector](./page#eval_on_selector) would wait for the promise to resolve and
 return its value.
 
-Examples:
+**Usage**
 
 ```ruby
 search_value = page.eval_on_selector("#search", "el => el.value")
@@ -346,16 +344,12 @@ preload_href = page.eval_on_selector("link[rel=preload]", "el => el.href")
 html = page.eval_on_selector(".main-container", "(e, suffix) => e.outer_html + suffix", arg: "hello")
 ```
 
-Shortcut for main frame's [Frame#eval_on_selector](./frame#eval_on_selector).
-
 ## eval_on_selector_all
 
 ```
 def eval_on_selector_all(selector, expression, arg: nil)
 ```
 
-> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
-better job.
 
 The method finds all elements matching the specified selector within the page and passes an array of matched elements as
 a first argument to `expression`. Returns the result of `expression` invocation.
@@ -363,28 +357,29 @@ a first argument to `expression`. Returns the result of `expression` invocation.
 If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Page#eval_on_selector_all](./page#eval_on_selector_all) would wait for the promise to resolve and
 return its value.
 
-Examples:
+**Usage**
 
 ```ruby
 div_counts = page.eval_on_selector_all("div", "(divs, min) => divs.length >= min", arg: 10)
 ```
 
-
-
 ## evaluate
 
 ```
 def evaluate(expression, arg: nil)
 ```
 
+
 Returns the value of the `expression` invocation.
 
 If the function passed to the [Page#evaluate](./page#evaluate) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Page#evaluate](./page#evaluate) would wait
 for the promise to resolve and return its value.
 
 If the function passed to the [Page#evaluate](./page#evaluate) returns a non-[Serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) value, then
-[Page#evaluate](./page#evaluate) resolves to `undefined`. Playwright also supports transferring some additional values that are
-not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+[Page#evaluate](./page#evaluate) resolves to `undefined`. Playwright also supports transferring some
+additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+
+**Usage**
 
 Passing argument to `expression`:
 
@@ -409,21 +404,21 @@ html = page.evaluate("([body, suffix]) => body.innerHTML + suffix", arg: [body_h
 body_handle.dispose
 ```
 
-Shortcut for main frame's [Frame#evaluate](./frame#evaluate).
-
 ## evaluate_handle
 
 ```
 def evaluate_handle(expression, arg: nil)
 ```
 
+
 Returns the value of the `expression` invocation as a [JSHandle](./js_handle).
 
-The only difference between [Page#evaluate](./page#evaluate) and [Page#evaluate_handle](./page#evaluate_handle) is that
-[Page#evaluate_handle](./page#evaluate_handle) returns [JSHandle](./js_handle).
+The only difference between [Page#evaluate](./page#evaluate) and [Page#evaluate_handle](./page#evaluate_handle) is that [Page#evaluate_handle](./page#evaluate_handle) returns [JSHandle](./js_handle).
+
+If the function passed to the [Page#evaluate_handle](./page#evaluate_handle) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Page#evaluate_handle](./page#evaluate_handle) would wait for the
+promise to resolve and return its value.
 
-If the function passed to the [Page#evaluate_handle](./page#evaluate_handle) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Page#evaluate_handle](./page#evaluate_handle)
-would wait for the promise to resolve and return its value.
+**Usage**
 
 ```ruby
 a_window_handle = page.evaluate_handle("Promise.resolve(window)")
@@ -445,23 +440,25 @@ puts result_handle.json_value
 result_handle.dispose
 ```
 
-
-
 ## expose_binding
 
 ```
 def expose_binding(name, callback, handle: nil)
 ```
 
-The method adds a function called `name` on the `window` object of every frame in this page. 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 this page. 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 [BrowserContext#expose_binding](./browser_context#expose_binding) for the context-wide version.
 
-> NOTE: Functions installed via [Page#expose_binding](./page#expose_binding) survive navigations.
+**NOTE**: Functions installed via [Page#expose_binding](./page#expose_binding) survive navigations.
+
+**Usage**
 
 An example of exposing page URL to all frames in a page:
 
@@ -500,22 +497,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 the page. 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 the page. 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 [BrowserContext#expose_function](./browser_context#expose_function) for context-wide exposed function.
 
-> NOTE: Functions installed via [Page#expose_function](./page#expose_function) survive navigations.
+**NOTE**: Functions installed via [Page#expose_function](./page#expose_function) survive navigations.
+
+**Usage**
 
 An example of adding a `sha256` function to the page:
 
@@ -539,8 +537,6 @@ HTML
 page.locator("button").click
 ```
 
-
-
 ## fill
 
 ```
@@ -553,18 +549,12 @@ def fill(
       timeout: nil)
 ```
 
-This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the
-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.
+This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, focuses the element, fills it and triggers an `input` event after filling. Note that you can pass an empty string to clear the input field.
 
-To send fine-grained keyboard events, use [Page#type](./page#type).
+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.
 
-Shortcut for main frame's [Frame#fill](./frame#fill).
+To send fine-grained keyboard events, use [Page#type](./page#type).
 
 ## focus
 
@@ -572,10 +562,9 @@ Shortcut for main frame's [Frame#fill](./frame#fill).
 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
-waits until a matching element appears in the DOM.
 
-Shortcut for main frame's [Frame#focus](./frame#focus).
+This method fetches an element with `selector` and focuses it. If there's no element matching
+`selector`, the method waits until a matching element appears in the DOM.
 
 ## frame
 
@@ -583,8 +572,11 @@ Shortcut for main frame's [Frame#focus](./frame#focus).
 def frame(name: nil, url: nil)
 ```
 
+
 Returns frame matching the specified criteria. Either `name` or `url` must be specified.
 
+**Usage**
+
 ```ruby
 frame = page.frame(name: "frame-name")
 ```
@@ -593,31 +585,33 @@ frame = page.frame(name: "frame-name")
 frame = page.frame(url: /.*domain.*/)
 ```
 
-
-
 ## frame_locator
 
 ```
 def frame_locator(selector)
 ```
 
-When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in
-that iframe. Following snippet locates element with text "Submit" in the iframe with id `my-frame`, like `<iframe
-id="my-frame">`:
+
+When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements
+in that iframe.
+
+**Usage**
+
+Following snippet locates element with text "Submit" in the iframe with id `my-frame`,
+like `<iframe id="my-frame">`:
 
 ```ruby
 locator = page.frame_locator("#my-iframe").get_by_text("Submit")
 locator.click
 ```
 
-
-
 ## frames
 
 ```
 def frames
 ```
 
+
 An array of all frames attached to the page.
 
 ## get_attribute
@@ -626,6 +620,7 @@ An array of all frames attached to the page.
 def get_attribute(selector, name, strict: nil, timeout: nil)
 ```
 
+
 Returns element attribute value.
 
 ## get_by_alt_text
@@ -634,42 +629,40 @@ Returns element attribute value.
 def get_by_alt_text(text, exact: nil)
 ```
 
+
 Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
 
 ```html
 <img alt='Castle'>
 ```
 
-
 ## get_by_label
 
 ```
 def get_by_label(text, exact: nil)
 ```
 
-Allows locating input elements by the text of the associated label. For example, this method will find the input by
-label text "Password" in the following DOM:
+
+Allows locating input elements by the text of the associated label. For example, this method will find the input by label text "Password" in the following DOM:
 
 ```html
 <label for="password-input">Password:</label>
 <input id="password-input">
 ```
 
-
 ## get_by_placeholder
 
 ```
 def get_by_placeholder(text, exact: nil)
 ```
 
-Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
-"Country":
+
+Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder "Country":
 
 ```html
 <input placeholder="Country">
 ```
 
-
 ## get_by_role
 
 ```
@@ -686,15 +679,10 @@ def get_by_role(
       selected: nil)
 ```
 
-Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles),
-[ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and
-[accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace**
-accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
 
-Note that many html elements have an implicitly
-[defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You
-can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not
-recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
+Allows locating elements by their [ARIA role](https://www.w3.org/TR/wai-aria-1.2/#roles), [ARIA attributes](https://www.w3.org/TR/wai-aria-1.2/#aria-attributes) and [accessible name](https://w3c.github.io/accname/#dfn-accessible-name). Note that role selector **does not replace** accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.
+
+Note that many html elements have an implicitly [defined role](https://w3c.github.io/html-aam/#html-element-role-mappings) that is recognized by the role selector. You can find all the [supported roles here](https://www.w3.org/TR/wai-aria-1.2/#role_definitions). ARIA guidelines **do not recommend** duplicating implicit roles and attributes by setting `role` and/or `aria-*` attributes to default values.
 
 ## get_by_test_id
 
@@ -702,10 +690,8 @@ recommend** duplicating implicit roles and attributes by setting `role` and/or `
 def get_by_test_id(testId)
 ```
 
-Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
-[Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
-
 
+Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use [Selectors#set_test_id_attribute](./selectors#set_test_id_attribute) to configure a different test id attribute if necessary.
 
 ## get_by_text
 
@@ -713,6 +699,7 @@ Locate element by the test id. By default, the `data-testid` attribute is used a
 def get_by_text(text, exact: nil)
 ```
 
+
 Allows locating elements that contain given text. Consider the following DOM structure:
 
 ```html
@@ -751,13 +738,11 @@ locator = page.get_by_text(/^hello$/i)
 expect(locator.evaluate('e => e.outerHTML')).to eq('<div>Hello</div>')
 ```
 
-See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter
-by the text content.
+See also [Locator#filter](./locator#filter) that allows to match by another criteria, like an accessible role, and then filter by the text content.
+
+**NOTE**: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.
 
-> NOTE: Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into
-one, turns line breaks into spaces and ignores leading and trailing whitespace.
-> NOTE: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For
-example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
+**NOTE**: Input elements of the type `button` and `submit` are matched by their `value` instead of the text content. For example, locating by text `"Log in"` matches `<input type=button value="Log in">`.
 
 ## get_by_title
 
@@ -765,19 +750,20 @@ example, locating by text `"Log in"` matches `<input type=button value="Log in">
 def get_by_title(text, exact: nil)
 ```
 
+
 Allows locating elements by their title. For example, this method will find the button by its title "Place the order":
 
 ```html
 <button title='Place the order'>Order Now</button>
 ```
 
-
 ## go_back
 
 ```
 def go_back(timeout: nil, waitUntil: nil)
 ```
 
+
 Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
 last redirect. If can not go back, returns `null`.
 
@@ -789,6 +775,7 @@ Navigate to the previous page in history.
 def go_forward(timeout: nil, waitUntil: nil)
 ```
 
+
 Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
 last redirect. If can not go forward, returns `null`.
 
@@ -800,6 +787,7 @@ Navigate to the next page in history.
 def goto(url, referer: nil, timeout: nil, waitUntil: nil)
 ```
 
+
 Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first
 non-redirect response.
 
@@ -814,12 +802,11 @@ The method will not throw an error when any valid HTTP status code is returned b
 Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
 [Response#status](./response#status).
 
-> NOTE: The method either throws an error or returns a main resource response. The only exceptions are navigation to
+**NOTE**: The method either throws an error or returns a main resource response. The only exceptions are navigation to
 `about:blank` or navigation to the same URL with a different hash, which would succeed and return `null`.
-> NOTE: Headless mode doesn't support navigation to a PDF document. See the
-[upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
 
-Shortcut for main frame's [Frame#goto](./frame#goto)
+**NOTE**: Headless mode doesn't support navigation to a PDF document. See the
+[upstream issue](https://bugs.chromium.org/p/chromium/issues/detail?id=761295).
 
 ## hover
 
@@ -835,18 +822,16 @@ def hover(
       trial: nil)
 ```
 
+
 This method hovers over an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to hover over the center of the element, or the specified `position`.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
-
-Shortcut for main frame's [Frame#hover](./frame#hover).
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## inner_html
 
@@ -854,6 +839,7 @@ Shortcut for main frame's [Frame#hover](./frame#hover).
 def inner_html(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.innerHTML`.
 
 ## inner_text
@@ -862,6 +848,7 @@ Returns `element.innerHTML`.
 def inner_text(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.innerText`.
 
 ## input_value
@@ -870,10 +857,10 @@ Returns `element.innerText`.
 def input_value(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `input.value` for the selected `<input>` or `<textarea>` or `<select>` element.
 
-Throws for non-input elements. 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), returns the value of the control.
+Throws for non-input elements. 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), returns the value of the control.
 
 ## checked?
 
@@ -881,6 +868,7 @@ Throws for non-input elements. However, if the element is inside the `<label>` e
 def checked?(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
 
 ## closed?
@@ -889,6 +877,7 @@ Returns whether the element is checked. Throws if the element is not a checkbox
 def closed?
 ```
 
+
 Indicates that the page has been closed.
 
 ## disabled?
@@ -897,7 +886,8 @@ Indicates that the page has been closed.
 def disabled?(selector, strict: nil, timeout: nil)
 ```
 
-Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability).
+
+Returns whether the element is disabled, the opposite of [enabled](https://playwright.dev/python/docs/actionability#enabled).
 
 ## editable?
 
@@ -905,7 +895,8 @@ Returns whether the element is disabled, the opposite of [enabled](https://playw
 def editable?(selector, strict: nil, timeout: nil)
 ```
 
-Returns whether the element is [editable](https://playwright.dev/python/docs/actionability).
+
+Returns whether the element is [editable](https://playwright.dev/python/docs/actionability#editable).
 
 ## enabled?
 
@@ -913,7 +904,8 @@ Returns whether the element is [editable](https://playwright.dev/python/docs/act
 def enabled?(selector, strict: nil, timeout: nil)
 ```
 
-Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability).
+
+Returns whether the element is [enabled](https://playwright.dev/python/docs/actionability#enabled).
 
 ## hidden?
 
@@ -921,8 +913,8 @@ Returns whether the element is [enabled](https://playwright.dev/python/docs/acti
 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
-match any elements is considered hidden.
+
+Returns whether the element is hidden, the opposite of [visible](https://playwright.dev/python/docs/actionability#visible).  `selector` that does not match any elements is considered hidden.
 
 ## visible?
 
@@ -930,8 +922,8 @@ match any elements is considered hidden.
 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.
+
+Returns whether the element is [visible](https://playwright.dev/python/docs/actionability#visible). `selector` that does not match any elements is considered not visible.
 
 ## locator
 
@@ -939,9 +931,9 @@ considered not visible.
 def locator(selector, has: nil, hasText: nil)
 ```
 
-The method returns an element locator that can be used to perform actions on this page / frame. 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.
+
+The method returns an element locator that can be used to perform actions on this page / frame.
+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.
 
 [Learn more about locators](https://playwright.dev/python/docs/locators).
 
@@ -951,6 +943,7 @@ on different DOM elements. That would happen if the DOM structure between those
 def main_frame
 ```
 
+
 The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
 
 ## opener
@@ -959,6 +952,7 @@ The page's main frame. Page is guaranteed to have a main frame which persists du
 def opener
 ```
 
+
 Returns the opener for popup pages and `null` for others. If the opener has been closed already the returns `null`.
 
 ## pause
@@ -967,14 +961,15 @@ Returns the opener for popup pages and `null` for others. If the opener has been
 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.
+
+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).
+**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
 
@@ -995,24 +990,28 @@ def pdf(
       width: nil)
 ```
 
+
 Returns the PDF buffer.
 
-> NOTE: Generating a pdf is currently only supported in Chromium headless.
+**NOTE**: Generating a pdf is currently only supported in Chromium headless.
 
 `page.pdf()` generates a pdf of the page with `print` css media. To generate a pdf with `screen` media, call
 [Page#emulate_media](./page#emulate_media) before calling `page.pdf()`:
 
-> NOTE: By default, `page.pdf()` generates a pdf with modified colors for printing. Use the
+**NOTE**: By default, `page.pdf()` generates a pdf with modified colors for printing. Use the
 [`-webkit-print-color-adjust`](https://developer.mozilla.org/en-US/docs/Web/CSS/-webkit-print-color-adjust) property to
 force rendering of exact colors.
 
+**Usage**
+
 ```ruby
 # generates a pdf with "screen" media type.
 page.emulate_media(media: "screen")
 page.pdf(path: "page.pdf")
 ```
 
-The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled values are treated as pixels.
+The `width`, `height`, and `margin` options accept values labeled with units. Unlabeled
+values are treated as pixels.
 
 A few examples:
 - `page.pdf({width: 100})` - prints with width set to 100 pixels
@@ -1038,8 +1037,8 @@ The `format` options are:
 - `A5`: 5.83in x 8.27in
 - `A6`: 4.13in x 5.83in
 
-> NOTE: `headerTemplate` and `footerTemplate` markup have the following limitations: > 1. Script tags inside templates
-are not evaluated. > 2. Page styles are not visible inside templates.
+**NOTE**: `headerTemplate` and `footerTemplate` markup have the following limitations: > 1. Script tags inside
+templates are not evaluated. > 2. Page styles are not visible inside templates.
 
 ## press
 
@@ -1053,10 +1052,12 @@ def press(
       timeout: nil)
 ```
 
+
 Focuses the element, and then uses [Keyboard#down](./keyboard#down) and [Keyboard#up](./keyboard#up).
 
-`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
+`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
 [here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). Examples of the keys are:
 
 `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`,
@@ -1066,12 +1067,14 @@ Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`,
 
 Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
 
-If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective
-texts.
+If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different
+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.
 
+**Usage**
+
 ```ruby
 page.goto("https://keycode.info")
 page.press("body", "A")
@@ -1082,42 +1085,36 @@ page.press("body", "Shift+O")
 page.screenshot(path: "o.png")
 ```
 
-
-
 ## query_selector
 
 ```
 def query_selector(selector, strict: nil)
 ```
 
-> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
 
 The method finds an element matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `null`. To wait for an element on the page, use [Locator#wait_for](./locator#wait_for).
 
-Shortcut for main frame's [Frame#query_selector](./frame#query_selector).
-
 ## query_selector_all
 
 ```
 def query_selector_all(selector)
 ```
 
-> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
 
 The method finds all elements matching the specified selector within the page. If no elements match the selector, the
 return value resolves to `[]`.
 
-Shortcut for main frame's [Frame#query_selector_all](./frame#query_selector_all).
-
 ## reload
 
 ```
 def reload(timeout: nil, waitUntil: nil)
 ```
 
-This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main
-resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
+
+This method reloads the current page, in the same way as if the user had triggered a browser refresh.
+Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
+last redirect.
 
 ## route
 
@@ -1125,14 +1122,16 @@ resource response. In case of multiple redirects, the navigation will resolve wi
 def route(url, handler, times: nil)
 ```
 
+
 Routing provides the capability to modify network requests that are made by a page.
 
 Once routing is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.
 
-> NOTE: The handler will only be called for the first url if the response is a redirect.
-> NOTE: [Page#route](./page#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**: The handler will only be called for the first url if the response is a redirect.
+
+**NOTE**: [Page#route](./page#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:
 
@@ -1148,8 +1147,7 @@ page.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)
@@ -1168,7 +1166,7 @@ matches both handlers.
 
 To remove a route with its handler you can use [Page#unroute](./page#unroute).
 
-> NOTE: Enabling routing disables http cache.
+**NOTE**: Enabling routing disables http cache.
 
 ## route_from_har
 
@@ -1176,12 +1174,10 @@ To remove a route with its handler you can use [Page#unroute](./page#unroute).
 def route_from_har(har, notFound: nil, update: nil, url: nil)
 ```
 
-If specified the network requests that are made in the page 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 page 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'`.
 
 ## screenshot
 
@@ -1200,6 +1196,7 @@ def screenshot(
       type: nil)
 ```
 
+
 Returns the buffer with the captured screenshot.
 
 ## select_option
@@ -1217,17 +1214,17 @@ def select_option(
       timeout: nil)
 ```
 
-This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits until
-all specified options are present in the `<select>` element and selects these options.
 
-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.
+This method waits for an element matching `selector`, waits for [actionability](https://playwright.dev/python/docs/actionability) checks, waits until all specified options are present in the `<select>` element and selects these options.
+
+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.
 
 Triggers a `change` and `input` event once all the provided options have been selected.
 
+**Usage**
+
 ```ruby
 # single selection matching the value
 page.select_option("select#colors", value: "blue")
@@ -1237,8 +1234,6 @@ page.select_option("select#colors", label: "blue")
 page.select_option("select#colors", value: ["red", "green", "blue"])
 ```
 
-Shortcut for main frame's [Frame#select_option](./frame#select_option).
-
 ## set_checked
 
 ```
@@ -1253,21 +1248,19 @@ def set_checked(
       trial: nil)
 ```
 
+
 This method checks or unchecks an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
 1. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
 1. If the element already has the right checked state, this method returns immediately.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to click in the center of the element.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 1. Ensure that the element is now checked or unchecked. If not, this method throws.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
-
-Shortcut for main frame's [Frame#set_checked](./frame#set_checked).
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## set_content
 
@@ -1285,6 +1278,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)
@@ -1294,7 +1288,7 @@ This setting will change the default maximum navigation time for the following m
 - [Page#expect_navigation](./page#expect_navigation)
 - [Page#wait_for_url](./page#wait_for_url)
 
-> NOTE: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout) takes priority over [Page#set_default_timeout](./page#set_default_timeout),
+**NOTE**: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout) takes priority over [Page#set_default_timeout](./page#set_default_timeout),
 [BrowserContext#set_default_timeout](./browser_context#set_default_timeout) and [BrowserContext#set_default_navigation_timeout](./browser_context#set_default_navigation_timeout).
 
 ## set_default_timeout
@@ -1304,9 +1298,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) takes priority over [Page#set_default_timeout](./page#set_default_timeout).
+**NOTE**: [Page#set_default_navigation_timeout](./page#set_default_navigation_timeout) takes priority over [Page#set_default_timeout](./page#set_default_timeout).
 
 ## set_extra_http_headers
 
@@ -1315,9 +1310,10 @@ def set_extra_http_headers(headers)
 ```
 alias: `extra_http_headers=`
 
+
 The extra HTTP headers will be sent with every request the page initiates.
 
-> NOTE: [Page#set_extra_http_headers](./page#set_extra_http_headers) does not guarantee the order of headers in the outgoing requests.
+**NOTE**: [Page#set_extra_http_headers](./page#set_extra_http_headers) does not guarantee the order of headers in the outgoing requests.
 
 ## set_input_files
 
@@ -1330,13 +1326,12 @@ def set_input_files(
       timeout: nil)
 ```
 
+
 Sets the value of the file input to these file paths or files. If some of the `filePaths` are relative paths, then they
 are resolved relative to the current working directory. For empty array, clears the selected files.
 
 This method expects `selector` to point to an
-[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). 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), targets the control instead.
+[input element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input). 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), targets the control instead.
 
 ## set_viewport_size
 
@@ -1345,21 +1340,20 @@ def set_viewport_size(viewportSize)
 ```
 alias: `viewport_size=`
 
+
 In the case of multiple pages in a single browser, each page can have its own viewport size. However,
 [Browser#new_context](./browser#new_context) allows to set viewport size (and more) for all pages in the context at once.
 
-[Page#set_viewport_size](./page#set_viewport_size) will resize the page. A lot of websites don't expect phones to change size, so you
-should set the viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen`
-size, use [Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these
-properties.
+[Page#set_viewport_size](./page#set_viewport_size) will resize the page. A lot of websites don't expect phones to change size, so you should set the
+viewport size before navigating to the page. [Page#set_viewport_size](./page#set_viewport_size) will also reset `screen` size, use [Browser#new_context](./browser#new_context) with `screen` and `viewport` parameters if you need better control of these properties.
+
+**Usage**
 
 ```ruby
 page.viewport_size = { width: 640, height: 480 }
 page.goto("https://example.com")
 ```
 
-
-
 ## tap_point
 
 ```
@@ -1374,20 +1368,18 @@ def tap_point(
       trial: nil)
 ```
 
+
 This method taps an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#touchscreen](./page#touchscreen) to tap the center of the element, or the specified `position`.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
-> NOTE: [Page#tap_point](./page#tap_point) requires that the `hasTouch` option of the browser context be set to true.
-
-Shortcut for main frame's [Frame#tap_point](./frame#tap_point).
+**NOTE**: [Page#tap_point](./page#tap_point) requires that the `hasTouch` option of the browser context be set to true.
 
 ## text_content
 
@@ -1395,6 +1387,7 @@ Shortcut for main frame's [Frame#tap_point](./frame#tap_point).
 def text_content(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.textContent`.
 
 ## title
@@ -1403,7 +1396,8 @@ Returns `element.textContent`.
 def title
 ```
 
-Returns the page's title. Shortcut for main frame's [Frame#title](./frame#title).
+
+Returns the page's title.
 
 ## type
 
@@ -1417,18 +1411,19 @@ def type(
       timeout: nil)
 ```
 
+
 Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `page.type` can be used to send
 fine-grained keyboard events. To fill values in form fields, use [Page#fill](./page#fill).
 
 To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./keyboard#press).
 
+**Usage**
+
 ```ruby
 page.type("#mytextarea", "hello") # types instantly
 page.type("#mytextarea", "world", delay: 100) # types slower, like a user
 ```
 
-Shortcut for main frame's [Frame#type](./frame#type).
-
 ## uncheck
 
 ```
@@ -1442,21 +1437,18 @@ def uncheck(
       trial: nil)
 ```
 
+
 This method unchecks an element matching `selector` by performing the following steps:
 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already
-   unchecked, this method returns immediately.
-1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the
-   element is detached during the checks, the whole action is retried.
+1. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
+1. Wait for [actionability](https://playwright.dev/python/docs/actionability) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
 1. Scroll the element into view if needed.
 1. Use [Page#mouse](./page#mouse) to click in the center of the element.
 1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
 1. Ensure that the element is now unchecked. If not, this method throws.
 
-When all steps combined have not finished during the specified `timeout`, this method throws a `TimeoutError`. Passing
-zero timeout disables this.
-
-Shortcut for main frame's [Frame#uncheck](./frame#uncheck).
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## unroute
 
@@ -1464,7 +1456,9 @@ Shortcut for main frame's [Frame#uncheck](./frame#uncheck).
 def unroute(url, handler: nil)
 ```
 
-Removes a route created with [Page#route](./page#route). When `handler` is not specified, removes all routes for the `url`.
+
+Removes a route created with [Page#route](./page#route). When `handler` is not specified, removes all routes for
+the `url`.
 
 ## url
 
@@ -1472,7 +1466,7 @@ Removes a route created with [Page#route](./page#route). When `handler` is not s
 def url
 ```
 
-Shortcut for main frame's [Frame#url](./frame#url).
+
 
 ## video
 
@@ -1480,6 +1474,7 @@ Shortcut for main frame's [Frame#url](./frame#url).
 def video
 ```
 
+
 Video object associated with this page.
 
 ## viewport_size
@@ -1496,9 +1491,10 @@ def viewport_size
 def expect_console_message(predicate: nil, timeout: nil, &block)
 ```
 
+
 Performs action and waits for a [ConsoleMessage](./console_message) to be logged by in the page. If predicate is provided, it passes
-[ConsoleMessage](./console_message) value into the `predicate` function and waits for `predicate(message)` to return a truthy value. Will
-throw an error if the page is closed before the [`event: Page.console`] event is fired.
+[ConsoleMessage](./console_message) value into the `predicate` function and waits for `predicate(message)` to return a truthy value.
+Will throw an error if the page is closed before the [`event: Page.console`] event is fired.
 
 ## expect_download
 
@@ -1506,9 +1502,10 @@ 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](./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.
+
+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.
 
 ## expect_event
 
@@ -1516,25 +1513,28 @@ closed before the download event is fired.
 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 page is closed before the event is fired. Returns the event data value.
 
+**Usage**
+
 ```ruby
 frame = page.expect_event("framenavigated") do
   page.get_by_role("button")
 end
 ```
 
-
 ## expect_file_chooser
 
 ```
 def expect_file_chooser(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a new [FileChooser](./file_chooser) to be created. If predicate is provided, it passes [FileChooser](./file_chooser) value
-into the `predicate` function and waits for `predicate.call(fileChooser)` to return a truthy value. Will throw an error if
-the page is closed before the file chooser is opened.
+
+Performs action and waits for a new [FileChooser](./file_chooser) to be created. If predicate is provided, it passes
+[FileChooser](./file_chooser) value into the `predicate` function and waits for `predicate.call(fileChooser)` to return a truthy value.
+Will throw an error if the page is closed before the file chooser is opened.
 
 ## wait_for_function
 
@@ -1542,8 +1542,11 @@ the page is closed before the file chooser is opened.
 def wait_for_function(expression, arg: nil, polling: nil, timeout: nil)
 ```
 
+
 Returns when the `expression` returns a truthy value. It resolves to a JSHandle of the truthy value.
 
+**Usage**
+
 The [Page#wait_for_function](./page#wait_for_function) can be used to observe viewport size change:
 
 ```ruby
@@ -1558,19 +1561,20 @@ selector = ".foo"
 page.wait_for_function("selector => !!document.querySelector(selector)", arg: selector)
 ```
 
-Shortcut for main frame's [Frame#wait_for_function](./frame#wait_for_function).
-
 ## wait_for_load_state
 
 ```
 def wait_for_load_state(state: nil, timeout: nil)
 ```
 
+
 Returns when the required load state has been reached.
 
 This resolves when the page reaches a required load state, `load` by default. The navigation must have been committed
 when this method is called. If current document has already reached the required state, resolves immediately.
 
+**Usage**
+
 ```ruby
 page.get_by_role("button").click # click triggers navigation.
 page.wait_for_load_state # the promise resolves after "load" event.
@@ -1581,22 +1585,23 @@ popup = page.expect_popup do
   page.get_by_role("button").click # click triggers a popup.
 end
 
-# Following resolves after "domcontentloaded" event.
+# Wait for the "DOMContentLoaded" event.
 popup.wait_for_load_state("domcontentloaded")
 puts popup.title # popup is ready to use.
 ```
 
-Shortcut for main frame's [Frame#wait_for_load_state](./frame#wait_for_load_state).
-
 ## expect_navigation
 
 ```
 def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
 ```
 
-Waits for the main frame navigation and returns the main resource response. In case of multiple redirects, the
-navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or
-navigation due to History API usage, the navigation will resolve with `null`.
+
+Waits for the main frame navigation and returns the main resource response. In case of multiple redirects, the navigation
+will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to
+History API usage, the navigation will resolve with `null`.
+
+**Usage**
 
 This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly
 cause the page to navigate. e.g. The click target has an `onclick` handler that triggers navigation from a `setTimeout`.
@@ -1604,14 +1609,13 @@ Consider this example:
 
 ```ruby
 page.expect_navigation do
-  page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
+  # This action triggers the navigation after a timeout.
+  page.get_by_text("Navigate after timeout").click
 end # 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.
-
-Shortcut for main frame's [Frame#expect_navigation](./frame#expect_navigation).
+**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.
 
 ## expect_popup
 
@@ -1619,7 +1623,10 @@ Shortcut for main frame's [Frame#expect_navigation](./frame#expect_navigation).
 def expect_popup(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a popup [Page](./page). If predicate is provided, it passes popup [Page](./page) value into the predicate function and waits for `predicate.call(page)` to return a truthy value. Will throw an error if the page is closed before the popup event is fired.
+
+Performs action and waits for a popup [Page](./page). If predicate is provided, it passes
+[Popup] value into the `predicate` function and waits for `predicate(page)` to return a truthy value.
+Will throw an error if the page is closed before the popup event is fired.
 
 ## expect_request
 
@@ -1627,37 +1634,38 @@ 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
-about events.
+
+Waits for the matching request and returns it. See [waiting for event](https://playwright.dev/python/docs/events#waiting-for-event) for more details about events.
+
+**Usage**
 
 ```ruby
-page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
+page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger request" /></form>'
 request = page.expect_request(/example.com\/resource/) do
-  page.click("input")
+  page.get_by_text("trigger request").click()
 end
 puts request.headers
 
 page.wait_for_load_state # wait for request finished.
 
 # or with a predicate
-page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
+page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger request" /></form>'
 request = page.expect_request(->(req) { req.url.start_with? 'https://example.com/resource' }) do
-  page.click("input")
+  page.get_by_text("trigger request").click()
 end
 puts request.headers
 ```
 
-
-
 ## expect_request_finished
 
 ```
 def expect_request_finished(predicate: nil, timeout: nil, &block)
 ```
 
-Performs action and waits for a [Request](./request) to finish loading. If predicate is provided, it passes [Request](./request) value into
-the `predicate` function and waits for `predicate(request)` to return a truthy value. Will throw an error if the page is
-closed before the [`event: Page.requestFinished`] event is fired.
+
+Performs action and waits for a [Request](./request) to finish loading. If predicate is provided, it passes
+[Request](./request) value into the `predicate` function and waits for `predicate(request)` to return a truthy value.
+Will throw an error if the page is closed before the [`event: Page.requestFinished`] event is fired.
 
 ## expect_response
 
@@ -1665,12 +1673,15 @@ closed before the [`event: Page.requestFinished`] event is fired.
 def expect_response(urlOrPredicate, timeout: nil, &block)
 ```
 
-Returns the matched response. See [waiting for event](https://playwright.dev/python/docs/events) for more details about events.
+
+Returns the matched response. See [waiting for event](https://playwright.dev/python/docs/events#waiting-for-event) for more details about events.
+
+**Usage**
 
 ```ruby
-page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
+page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger response" /></form>'
 response = page.expect_response(/example.com\/resource/) do
-  page.click("input")
+  page.get_by_text("trigger response").click()
 end
 puts response.body
 puts response.ok?
@@ -1678,31 +1689,33 @@ puts response.ok?
 page.wait_for_load_state # wait for request finished.
 
 # or with a predicate
-page.content = '<form action="https://example.com/resource"><input type="submit" /></form>'
+page.content = '<form action="https://example.com/resource"><input type="submit" value="trigger response" /></form>'
 response = page.expect_response(->(res) { res.url.start_with? 'https://example.com/resource' }) do
-  page.click("input")
+  page.get_by_text("trigger response").click()
 end
 puts response.body
 puts response.ok?
 ```
 
-
-
 ## wait_for_selector
 
 ```
 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
 `detached`.
 
-> NOTE: Playwright automatically waits for element to be ready before performing an action. Using [Locator](./locator) objects and
-web-first assertions makes the code wait-for-selector-free.
+**NOTE**: Playwright automatically waits for element to be ready before performing an action. Using
+[Locator](./locator) objects and web-first assertions makes the code wait-for-selector-free.
+
+Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become
+visible/hidden). If at the moment of calling the method `selector` already satisfies the condition, the method
+will return immediately. If the selector doesn't satisfy the condition for the `timeout` milliseconds, the
+function will throw.
 
-Wait for the `selector` to satisfy `state` option (either appear/disappear from dom, or become visible/hidden). If at
-the moment of calling the method `selector` already satisfies the condition, the method will return immediately. If the
-selector doesn't satisfy the condition for the `timeout` milliseconds, the function will throw.
+**Usage**
 
 This method works across navigations:
 
@@ -1714,47 +1727,50 @@ This method works across navigations:
 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.
 
+**Usage**
+
 ```ruby
 page.wait_for_timeout(1000)
 ```
 
-Shortcut for main frame's [Frame#wait_for_timeout](./frame#wait_for_timeout).
-
 ## wait_for_url
 
 ```
 def wait_for_url(url, timeout: nil, waitUntil: nil)
 ```
 
+
 Waits for the main frame to navigate to the given URL.
 
+**Usage**
+
 ```ruby
 page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
 page.wait_for_url("**/target.html")
 ```
 
-Shortcut for main frame's [Frame#wait_for_url](./frame#wait_for_url).
-
 ## expect_websocket
 
 ```
 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.
+
+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(webSocket)` to return a truthy value.
+Will throw an error if the page is closed before the WebSocket event is fired.
 
 ## expect_worker
 
@@ -1762,9 +1778,10 @@ Performs action and waits for a new [WebSocket](./web_socket). If predicate is p
 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.
+
+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
 
@@ -1772,23 +1789,21 @@ the worker event is fired.
 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
+**NOTE**: This does not contain ServiceWorkers
 
 ## accessibility
 
-**DEPRECATED** This property is deprecated. Please use other libraries such as [Axe](https://www.deque.com/axe/) if you
-need to test page accessibility. See our Node.js [guide](https://playwright.dev/docs/accessibility-testing) for
-integration with Axe.
-
 ## keyboard
 
 ## mouse
 
 ## request
 
+
 API testing helper associated with this page. This method returns the same instance as
 [BrowserContext#request](./browser_context#request) on the page's context. See [BrowserContext#request](./browser_context#request) for more details.