playwright-ruby-client 1.28.1 → 1.29.0

data/documentation/docs/api/frame.md

@@ -4,15 +4,14 @@ sidebar_position: 10
 
 # Frame
 
+
 At every point of time, page exposes its current frame tree via the [Page#main_frame](./page#main_frame) and
 [Frame#child_frames](./frame#child_frames) methods.
 
 [Frame](./frame) object's lifecycle is controlled by three events, dispatched on the page object:
-- [`event: Page.frameAttached`] - fired when the frame gets attached to the page. A Frame can be attached to the page
-  only once.
+- [`event: Page.frameAttached`] - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
 - [`event: Page.frameNavigated`] - fired when the frame commits navigation to a different URL.
-- [`event: Page.frameDetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the
-  page only once.
+- [`event: Page.frameDetached`] - fired when the frame gets detached from the page.  A Frame can be detached from the page only once.
 
 An example of dumping frame tree:
 
@@ -28,14 +27,13 @@ page.goto("https://www.theverge.com")
 dump_frame_tree(page.main_frame)
 ```
 
-
-
 ## add_script_tag
 
 ```
 def add_script_tag(content: nil, path: nil, type: nil, url: nil)
 ```
 
+
 Returns the added tag when the script's onload fires or when the script content was injected into frame.
 
 Adds a `<script>` tag into the page with the desired url or content.
@@ -46,6 +44,7 @@ Adds a `<script>` tag into the page with the desired url or content.
 def add_style_tag(content: nil, path: nil, url: nil)
 ```
 
+
 Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.
 
 Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the
@@ -64,19 +63,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.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## child_frames
 
@@ -103,16 +101,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.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## content
 
@@ -120,6 +118,7 @@ zero timeout disables this.
 def content
 ```
 
+
 Gets the full HTML contents of the frame, including the doctype.
 
 ## dblclick
@@ -138,19 +137,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: `frame.dblclick()` dispatches two `click` events and a single `dblclick` event.
+**NOTE**: `frame.dblclick()` dispatches two `click` events and a single `dblclick` event.
 
 ## dispatch_event
 
@@ -163,18 +161,23 @@ 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
 frame.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)
@@ -191,8 +194,6 @@ data_transfer = frame.evaluate_handle("new DataTransfer()")
 frame.dispatch_event("#source", "dragstart", eventInit: { dataTransfer: data_transfer })
 ```
 
-
-
 ## drag_and_drop
 
 ```
@@ -216,19 +217,17 @@ def drag_and_drop(
 def eval_on_selector(selector, expression, arg: nil, strict: nil)
 ```
 
-Returns the return value of `expression`.
 
-> 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.
+Returns the return value of `expression`.
 
 The method finds an element matching the specified selector within the frame and passes it as a first argument to
-`expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, the
-method throws an error.
+`expression`. If no
+elements match the selector, the method throws an error.
 
-If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#eval_on_selector](./frame#eval_on_selector) would wait for the promise to resolve and
-return its value.
+If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#eval_on_selector](./frame#eval_on_selector) would wait for the promise to resolve and return its
+value.
 
-Examples:
+**Usage**
 
 ```ruby
 search_value = frame.eval_on_selector("#search", "el => el.value")
@@ -236,47 +235,44 @@ preload_href = frame.eval_on_selector("link[rel=preload]", "el => el.href")
 html = frame.eval_on_selector(".main-container", "(e, suffix) => e.outerHTML + suffix", arg: "hello")
 ```
 
-
-
 ## eval_on_selector_all
 
 ```
 def eval_on_selector_all(selector, expression, arg: nil)
 ```
 
-Returns the return value of `expression`.
 
-> NOTE: In most cases, [Locator#evaluate_all](./locator#evaluate_all), other [Locator](./locator) helper methods and web-first assertions do a
-better job.
+Returns the return value of `expression`.
 
 The method finds all elements matching the specified selector within the frame and passes an array of matched elements
-as a first argument to `expression`. See [Working with selectors](https://playwright.dev/python/docs/selectors) for more details.
+as a first argument to `expression`.
 
-If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#eval_on_selector_all](./frame#eval_on_selector_all) would wait for the promise to resolve and
-return its value.
+If `expression` returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#eval_on_selector_all](./frame#eval_on_selector_all) would wait for the promise to resolve and return its
+value.
 
-Examples:
+**Usage**
 
 ```ruby
 divs_counts = frame.eval_on_selector_all("div", "(divs, min) => divs.length >= min", arg: 10)
 ```
 
-
-
 ## evaluate
 
 ```
 def evaluate(expression, arg: nil)
 ```
 
+
 Returns the return value of `expression`.
 
-If the function passed to the [Frame#evaluate](./frame#evaluate) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#evaluate](./frame#evaluate) would wait
-for the promise to resolve and return its value.
+If the function passed to the [Frame#evaluate](./frame#evaluate) returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then [Frame#evaluate](./frame#evaluate) would wait for the promise to
+resolve and return its value.
 
 If the function passed to the [Frame#evaluate](./frame#evaluate) returns a non-[Serializable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#description) value, then
-[Frame#evaluate](./frame#evaluate) returns `undefined`. Playwright also supports transferring some additional values that are
-not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+[Frame#evaluate](./frame#evaluate) returns `undefined`. Playwright also supports transferring some
+additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`.
+
+**Usage**
 
 ```ruby
 result = frame.evaluate("([x, y]) => Promise.resolve(x * y)", arg: [7, 8])
@@ -299,14 +295,13 @@ html = frame.evaluate("([body, suffix]) => body.innerHTML + suffix", arg: [body_
 body_handle.dispose
 ```
 
-
-
 ## evaluate_handle
 
 ```
 def evaluate_handle(expression, arg: nil)
 ```
 
+
 Returns the return value of `expression` as a [JSHandle](./js_handle).
 
 The only difference between [Frame#evaluate](./frame#evaluate) and [Frame#evaluate_handle](./frame#evaluate_handle) is that
@@ -315,6 +310,8 @@ The only difference between [Frame#evaluate](./frame#evaluate) and [Frame#evalua
 If the function, passed to the [Frame#evaluate_handle](./frame#evaluate_handle), returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise), then
 [Frame#evaluate_handle](./frame#evaluate_handle) would wait for the promise to resolve and return its value.
 
+**Usage**
+
 ```ruby
 a_window_handle = frame.evaluate_handle("Promise.resolve(window)")
 a_window_handle # handle for the window object.
@@ -335,8 +332,6 @@ puts result_handle.json_value
 result_handle.dispose
 ```
 
-
-
 ## fill
 
 ```
@@ -349,14 +344,10 @@ 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.
+
+If the target element is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error. However, if the element is inside the `<label>` element that has an associated [control](https://developer.mozilla.org/en-US/docs/Web/API/HTMLLabelElement/control), the control will be filled instead.
 
 To send fine-grained keyboard events, use [Frame#type](./frame#type).
 
@@ -366,8 +357,9 @@ To send fine-grained keyboard events, use [Frame#type](./frame#type).
 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.
+
+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_element
 
@@ -375,6 +367,7 @@ waits until a matching element appears in the DOM.
 def frame_element
 ```
 
+
 Returns the `frame` or `iframe` element handle which corresponds to this frame.
 
 This is an inverse of [ElementHandle#content_frame](./element_handle#content_frame). Note that returned handle actually belongs to the parent
@@ -382,37 +375,40 @@ frame.
 
 This method throws an error if the frame has been detached before `frameElement()` returns.
 
+**Usage**
+
 ```ruby
 frame_element = frame.frame_element
 content_frame = frame_element.content_frame
 puts frame == content_frame # => true
 ```
 
-
-
 ## 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 = frame.frame_locator("#my-iframe").get_by_text("Submit")
 locator.click
 ```
 
-
-
 ## get_attribute
 
 ```
 def get_attribute(selector, name, strict: nil, timeout: nil)
 ```
 
+
 Returns element attribute value.
 
 ## get_by_alt_text
@@ -421,42 +417,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
 
 ```
@@ -473,15 +467,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
 
@@ -489,10 +478,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
 
@@ -500,6 +487,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
@@ -538,13 +526,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
 
@@ -552,19 +538,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>
 ```
 
-
 ## goto
 
 ```
 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 response of the
 last redirect.
 
@@ -575,13 +562,14 @@ The method will throw an error if:
 - the remote server does not respond or is unreachable.
 - the main resource failed to load.
 
-The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
-Found" and 500 "Internal Server Error".  The status code for such responses can be retrieved by calling
+The method will not throw an error when any valid HTTP status code is returned by the remote server, including 404
+"Not 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
+
+**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
@@ -598,16 +586,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.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## inner_html
 
@@ -615,6 +603,7 @@ zero timeout disables this.
 def inner_html(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.innerHTML`.
 
 ## inner_text
@@ -623,6 +612,7 @@ Returns `element.innerHTML`.
 def inner_text(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.innerText`.
 
 ## input_value
@@ -631,10 +621,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?
 
@@ -642,6 +632,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.
 
 ## detached?
@@ -650,6 +641,7 @@ Returns whether the element is checked. Throws if the element is not a checkbox
 def detached?
 ```
 
+
 Returns `true` if the frame has been detached, or `false` otherwise.
 
 ## disabled?
@@ -658,7 +650,8 @@ Returns `true` if the frame has been detached, or `false` otherwise.
 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?
 
@@ -666,7 +659,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?
 
@@ -674,7 +668,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?
 
@@ -682,8 +677,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?
 
@@ -691,8 +686,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
 
@@ -700,9 +695,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).
 
@@ -714,11 +709,12 @@ on different DOM elements. That would happen if the DOM structure between those
 def name
 ```
 
+
 Returns frame's name attribute as specified in the tag.
 
 If the name is empty, returns the id attribute instead.
 
-> NOTE: This value is calculated once when the frame is created, and will not update if the attribute is changed later.
+**NOTE**: This value is calculated once when the frame is created, and will not update if the attribute is changed later.
 
 ## page
 
@@ -726,6 +722,7 @@ If the name is empty, returns the id attribute instead.
 def page
 ```
 
+
 Returns the page containing this frame.
 
 ## parent_frame
@@ -734,6 +731,7 @@ Returns the page containing this frame.
 def parent_frame
 ```
 
+
 Parent frame, if any. Detached frames and main frames return `null`.
 
 ## press
@@ -748,8 +746,10 @@ def press(
       timeout: nil)
 ```
 
-`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`,
@@ -759,8 +759,8 @@ 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.
@@ -771,12 +771,13 @@ modifier, modifier is pressed and being held while the subsequent key is being p
 def query_selector(selector, strict: nil)
 ```
 
+
 Returns the ElementHandle pointing to the frame element.
 
-> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects and web-first assertions instead.
+**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 frame. See
-[Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns `null`.
+The method finds an element matching the specified selector within the frame. If no elements match the selector,
+returns `null`.
 
 ## query_selector_all
 
@@ -784,12 +785,13 @@ The method finds an element matching the specified selector within the frame. Se
 def query_selector_all(selector)
 ```
 
+
 Returns the ElementHandles pointing to the frame elements.
 
-> NOTE: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects instead.
+**NOTE**: The use of [ElementHandle](./element_handle) is discouraged, use [Locator](./locator) objects instead.
 
-The method finds all elements matching the specified selector within the frame. See
-[Working with selectors](https://playwright.dev/python/docs/selectors) for more details. If no elements match the selector, returns empty array.
+The method finds all elements matching the specified selector within the frame. If no elements match the selector,
+returns empty array.
 
 ## select_option
 
@@ -806,17 +808,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
 frame.select_option("select#colors", value: "blue")
@@ -826,8 +828,6 @@ frame.select_option("select#colors", label: "blue")
 frame.select_option("select#colors", value: ["red", "green", "blue"])
 ```
 
-
-
 ## set_checked
 
 ```
@@ -842,19 +842,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.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## set_content
 
@@ -876,13 +876,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.
 
 ## tap_point
 
@@ -898,18 +897,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: `frame.tap()` requires that the `hasTouch` option of the browser context be set to true.
+**NOTE**: `frame.tap()` requires that the `hasTouch` option of the browser context be set to true.
 
 ## text_content
 
@@ -917,6 +916,7 @@ zero timeout disables this.
 def text_content(selector, strict: nil, timeout: nil)
 ```
 
+
 Returns `element.textContent`.
 
 ## title
@@ -925,6 +925,7 @@ Returns `element.textContent`.
 def title
 ```
 
+
 Returns the page title.
 
 ## type
@@ -939,18 +940,19 @@ def type(
       timeout: nil)
 ```
 
+
 Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text. `frame.type` can be used to
 send fine-grained keyboard events. To fill values in form fields, use [Frame#fill](./frame#fill).
 
 To press a special key, like `Control` or `ArrowDown`, use [Keyboard#press](./keyboard#press).
 
+**Usage**
+
 ```ruby
 frame.type("#mytextarea", "hello") # types instantly
 frame.type("#mytextarea", "world", delay: 100) # types slower, like a user
 ```
 
-
-
 ## uncheck
 
 ```
@@ -964,19 +966,18 @@ def uncheck(
       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
-   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.
+When all steps combined have not finished during the specified `timeout`, this method throws a
+`TimeoutError`. Passing zero timeout disables this.
 
 ## url
 
@@ -984,6 +985,7 @@ zero timeout disables this.
 def url
 ```
 
+
 Returns frame's url.
 
 ## wait_for_function
@@ -992,8 +994,11 @@ Returns frame's url.
 def wait_for_function(expression, arg: nil, polling: nil, timeout: nil)
 ```
 
+
 Returns when the `expression` returns a truthy value, returns that value.
 
+**Usage**
+
 The [Frame#wait_for_function](./frame#wait_for_function) can be used to observe viewport size change:
 
 ```ruby
@@ -1008,36 +1013,38 @@ selector = ".foo"
 frame.wait_for_function("selector => !!document.querySelector(selector)", arg: selector)
 ```
 
-
-
 ## wait_for_load_state
 
 ```
 def wait_for_load_state(state: nil, timeout: nil)
 ```
 
+
 Waits for the required load state to be reached.
 
 This returns when the frame 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
 frame.click("button") # click triggers navigation.
 frame.wait_for_load_state # the promise resolves after "load" event.
 ```
 
-
-
 ## expect_navigation
 
 ```
 def expect_navigation(timeout: nil, url: nil, waitUntil: nil, &block)
 ```
 
+
 Waits for the 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 method waits for the frame to navigate to a new URL. It is useful for when you run code which will indirectly cause
 the frame to navigate. Consider this example:
 
@@ -1047,8 +1054,8 @@ frame.expect_navigation do
 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.
+**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.
 
 ## wait_for_selector
 
@@ -1056,15 +1063,19 @@ considered a navigation.
 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 make 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 make 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:
 
@@ -1077,14 +1088,13 @@ This method works across navigations:
 end
 ```
 
-
-
 ## wait_for_timeout
 
 ```
 def wait_for_timeout(timeout)
 ```
 
+
 Waits for the given `timeout` in milliseconds.
 
 Note that `frame.waitForTimeout()` should only be used for debugging. Tests using the timer in production are going to
@@ -1096,11 +1106,12 @@ be flaky. Use signals such as network events, selectors becoming visible and oth
 def wait_for_url(url, timeout: nil, waitUntil: nil)
 ```
 
+
 Waits for the frame to navigate to the given URL.
 
+**Usage**
+
 ```ruby
 frame.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
 frame.wait_for_url("**/target.html")
 ```
-
-