playwright-ruby-client 0.0.3 → 0.0.4

data/lib/playwright_api/file_chooser.rb

@@ -1,5 +1,6 @@
 module Playwright
-  # FileChooser objects are dispatched by the page in the page.on('filechooser') event.
+  # `FileChooser` objects are dispatched by the page in the [`event: Page.filechooser`] event.
+  # 
   #
   # ```js
   # page.on('filechooser', async (fileChooser) => {
@@ -23,7 +24,8 @@ module Playwright
       raise NotImplementedError.new('page is not implemented yet.')
     end
 
-    # Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then they are resolved relative to the the current working directory. For empty array, clears the selected files.
+    # Sets the value of the file input this chooser is associated with. If some of the `filePaths` are relative paths, then
+    # they are resolved relative to the the current working directory. For empty array, clears the selected files.
     def set_files(files, noWaitAfter: nil, timeout: nil)
       raise NotImplementedError.new('set_files is not implemented yet.')
     end

data/lib/playwright_api/frame.rb

@@ -1,12 +1,16 @@
 module Playwright
-  # At every point of time, page exposes its current frame tree via the `page.mainFrame()` and `frame.childFrames()` methods.
-  # Frame object's lifecycle is controlled by three events, dispatched on the page object:
+  # At every point of time, page exposes its current frame tree via the [`method: Page.mainFrame`] and
+  # [`method: Frame.childFrames`] methods.
   # 
-  # page.on('frameattached') - fired when the frame gets attached to the page. A Frame can be attached to the page only once.
-  # page.on('framenavigated') - fired when the frame commits navigation to a different URL.
-  # page.on('framedetached') - fired when the frame gets detached from the page.  A Frame can be detached from the page only once.
+  # `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.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.
   # 
   # An example of dumping frame tree:
+  # 
   #
   # ```js
   # const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
@@ -26,7 +30,9 @@ module Playwright
   #   }
   # })();
   # ```
+  # 
   # An example of getting text from an iframe element:
+  # 
   #
   # ```js
   # const frame = page.frames().find(frame => frame.name() === 'myframe');
@@ -36,66 +42,89 @@ module Playwright
   class Frame < PlaywrightApi
 
     # Returns the ElementHandle pointing to the frame element.
-    # The method finds an element matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns `null`.
-    def S(selector)
-      raise NotImplementedError.new('S is not implemented yet.')
+    # 
+    # The method finds an element matching the specified selector within the frame. See
+    # [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector,
+    # returns `null`.
+    def query_selector(selector)
+      raise NotImplementedError.new('query_selector is not implemented yet.')
     end
 
     # Returns the ElementHandles pointing to the frame elements.
-    # The method finds all elements matching the specified selector within the frame. See Working with selectors for more details. If no elements match the selector, returns empty array.
-    def SS(selector)
-      raise NotImplementedError.new('SS is not implemented yet.')
+    # 
+    # The method finds all elements matching the specified selector within the frame. See
+    # [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements match the selector,
+    # returns empty array.
+    def query_selector_all(selector)
+      raise NotImplementedError.new('query_selector_all is not implemented yet.')
     end
 
     # Returns the return value of `pageFunction`
-    # The method finds an element matching the specified selector within the frame and passes it as a first argument to `pageFunction`. See Working with selectors for more details. If no elements match the selector, the method throws an error.
-    # If `pageFunction` returns a Promise, then `frame.$eval` would wait for the promise to resolve and return its value.
+    # 
+    # The method finds an element matching the specified selector within the frame and passes it as a first argument to
+    # `pageFunction`. See [Working with selectors](./selectors.md#working-with-selectors) for more details. If no elements
+    # match the selector, the method throws an error.
+    # 
+    # If `pageFunction` returns a [Promise], then `frame.$eval` would wait for the promise to resolve and return its value.
+    # 
     # Examples:
+    # 
     #
     # ```js
     # const searchValue = await frame.$eval('#search', el => el.value);
     # const preloadHref = await frame.$eval('link[rel=preload]', el => el.href);
     # const html = await frame.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');
     # ```
-    def Seval(selector, pageFunction, arg: nil)
-      raise NotImplementedError.new('Seval is not implemented yet.')
+    def eval_on_selector(selector, pageFunction, arg: nil)
+      raise NotImplementedError.new('eval_on_selector is not implemented yet.')
     end
 
     # Returns the return value of `pageFunction`
-    # The method finds all elements matching the specified selector within the frame and passes an array of matched elements as a first argument to `pageFunction`. See Working with selectors for more details.
-    # If `pageFunction` returns a Promise, then `frame.$$eval` would wait for the promise to resolve and return its value.
+    # 
+    # The method finds all elements matching the specified selector within the frame and passes an array of matched elements
+    # as a first argument to `pageFunction`. See [Working with selectors](./selectors.md#working-with-selectors) for more
+    # details.
+    # 
+    # If `pageFunction` returns a [Promise], then `frame.$$eval` would wait for the promise to resolve and return its value.
+    # 
     # Examples:
+    # 
     #
     # ```js
     # const divsCounts = await frame.$$eval('div', (divs, min) => divs.length >= min, 10);
     # ```
-    def SSeval(selector, pageFunction, arg: nil)
-      raise NotImplementedError.new('SSeval is not implemented yet.')
+    def eval_on_selector_all(selector, pageFunction, arg: nil)
+      raise NotImplementedError.new('eval_on_selector_all is not implemented yet.')
     end
 
     # 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.
-    def add_script_tag(params)
+    def add_script_tag(content: nil, path: nil, type: nil, url: nil)
       raise NotImplementedError.new('add_script_tag is not implemented yet.')
     end
 
     # 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 content.
-    def add_style_tag(params)
+    # 
+    # Adds a `<link rel="stylesheet">` tag into the page with the desired url or a `<style type="text/css">` tag with the
+    # content.
+    def add_style_tag(content: nil, path: nil, url: nil)
       raise NotImplementedError.new('add_style_tag is not implemented yet.')
     end
 
     # This method checks an element matching `selector` by performing the following steps:
+    # 1. Find an element match 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 rejects. If the element is already
+    #    checked, this method returns immediately.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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 rejects.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.mouse to click in the center of the element.
-    # Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
-    # Ensure that the element is now checked. If not, this method rejects.
-    # 
-    # When all steps combined have not finished during the specified `timeout`, this method rejects with a TimeoutError. Passing zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method rejects with a `TimeoutError`.
+    # Passing zero timeout disables this.
     def check(selector, force: nil, noWaitAfter: nil, timeout: nil)
       raise NotImplementedError.new('check is not implemented yet.')
     end
@@ -105,23 +134,24 @@ module Playwright
     end
 
     # This method clicks an element matching `selector` by performing the following steps:
+    # 1. Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.mouse to click in the center of the element, or the specified `position`.
-    # 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 rejects with a TimeoutError. Passing zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method rejects with a `TimeoutError`.
+    # Passing zero timeout disables this.
     def click(
           selector,
           button: nil,
           clickCount: nil,
           delay: nil,
-          position: nil,
-          modifiers: nil,
           force: nil,
+          modifiers: nil,
           noWaitAfter: nil,
+          position: nil,
           timeout: nil)
       raise NotImplementedError.new('click is not implemented yet.')
     end
@@ -132,45 +162,53 @@ module Playwright
     end
 
     # This method double clicks an element matching `selector` by performing the following steps:
+    # 1. Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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 reject.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.mouse to double click in the center of the element, or the specified `position`.
-    # 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 reject.
-    # 
-    # When all steps combined have not finished during the specified `timeout`, this method rejects with a TimeoutError. Passing zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method rejects with 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.
     def dblclick(
           selector,
           button: nil,
           delay: nil,
-          position: nil,
-          modifiers: nil,
           force: nil,
+          modifiers: nil,
           noWaitAfter: nil,
+          position: nil,
           timeout: nil)
       raise NotImplementedError.new('dblclick is not implemented yet.')
     end
 
-    # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the elment, `click` is dispatched. This is equivalend to calling element.click().
+    # The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the elment, `click`
+    # is dispatched. This is equivalend to calling
+    # [element.click()](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/click).
+    # 
     #
     # ```js
     # await frame.dispatchEvent('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.
-    # Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
     # 
-    # DragEvent
-    # FocusEvent
-    # KeyboardEvent
-    # MouseEvent
-    # PointerEvent
-    # TouchEvent
-    # Event
+    # 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:
+    # - [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)
+    # - [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent)
+    # - [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent/PointerEvent)
+    # - [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent/TouchEvent)
+    # - [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event/Event)
     # 
     # You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
+    # 
     #
     # ```js
     # // Note you can only create DataTransfer in Chromium and Firefox
@@ -182,8 +220,14 @@ module Playwright
     end
 
     # Returns the return value of `pageFunction`
-    # If the function passed to the `frame.evaluate` returns a Promise, then `frame.evaluate` would wait for the promise to resolve and return its value.
-    # If the function passed to the `frame.evaluate` returns a non-Serializable value, then `frame.evaluate` returns `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`: `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
+    # 
+    # If the function passed to the `frame.evaluate` returns a [Promise], then `frame.evaluate` would wait for the promise to
+    # resolve and return its value.
+    # 
+    # If the function passed to the `frame.evaluate` returns a non-[Serializable] value, then `frame.evaluate` returns
+    # `undefined`. DevTools Protocol also supports transferring some additional values that are not serializable by `JSON`:
+    # `-0`, `NaN`, `Infinity`, `-Infinity`, and bigint literals.
+    # 
     #
     # ```js
     # const result = await frame.evaluate(([x, y]) => {
@@ -191,12 +235,16 @@ module Playwright
     # }, [7, 8]);
     # console.log(result); // prints "56"
     # ```
+    # 
     # A string can also be passed in instead of a function.
+    # 
     #
     # ```js
     # console.log(await frame.evaluate('1 + 2')); // prints "3"
     # ```
-    # ElementHandle instances can be passed as an argument to the `frame.evaluate`:
+    # 
+    # `ElementHandle` instances can be passed as an argument to the `frame.evaluate`:
+    # 
     #
     # ```js
     # const bodyHandle = await frame.$('body');
@@ -208,19 +256,28 @@ module Playwright
     end
 
     # Returns the return value of `pageFunction` as in-page object (JSHandle).
-    # The only difference between `frame.evaluate` and `frame.evaluateHandle` is that `frame.evaluateHandle` returns in-page object (JSHandle).
-    # If the function, passed to the `frame.evaluateHandle`, returns a Promise, then `frame.evaluateHandle` would wait for the promise to resolve and return its value.
+    # 
+    # The only difference between `frame.evaluate` and `frame.evaluateHandle` is that `frame.evaluateHandle` returns in-page
+    # object (JSHandle).
+    # 
+    # If the function, passed to the `frame.evaluateHandle`, returns a [Promise], then `frame.evaluateHandle` would wait for
+    # the promise to resolve and return its value.
+    # 
     #
     # ```js
     # const aWindowHandle = await frame.evaluateHandle(() => Promise.resolve(window));
     # aWindowHandle; // Handle for the window object.
     # ```
+    # 
     # A string can also be passed in instead of a function.
+    # 
     #
     # ```js
     # const aHandle = await frame.evaluateHandle('document'); // Handle for the 'document'.
     # ```
-    # JSHandle instances can be passed as an argument to the `frame.evaluateHandle`:
+    # 
+    # `JSHandle` instances can be passed as an argument to the `frame.evaluateHandle`:
+    # 
     #
     # ```js
     # const aHandle = await frame.evaluateHandle(() => document.body);
@@ -232,20 +289,29 @@ module Playwright
       raise NotImplementedError.new('evaluate_handle is not implemented yet.')
     end
 
-    # This method waits for an element matching `selector`, waits for actionability checks, focuses the element, fills it and triggers an `input` event after filling. If the element matching `selector` is not an `<input>`, `<textarea>` or `[contenteditable]` element, this method throws an error. Note that you can pass an empty string to clear the input field.
-    # To send fine-grained keyboard events, use `frame.type(selector, text[, options])`.
+    # This method waits for an element matching `selector`, waits for [actionability](./actionability.md) checks, focuses the
+    # element, fills it and triggers an `input` event after filling. If the element matching `selector` is not an `<input>`,
+    # `<textarea>` or `[contenteditable]` element, this method throws an error. Note that you can pass an empty string to
+    # clear the input field.
+    # 
+    # To send fine-grained keyboard events, use [`method: Frame.type`].
     def fill(selector, value, noWaitAfter: nil, timeout: nil)
       raise NotImplementedError.new('fill is not implemented yet.')
     end
 
-    # 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.
     def focus(selector, timeout: nil)
       raise NotImplementedError.new('focus is not implemented yet.')
     end
 
     # Returns the `frame` or `iframe` element handle which corresponds to this frame.
-    # This is an inverse of `elementHandle.contentFrame()`. Note that returned handle actually belongs to the parent frame.
+    # 
+    # This is an inverse of [`method: ElementHandle.contentFrame`]. Note that returned handle actually belongs to the parent
+    # frame.
+    # 
     # This method throws an error if the frame has been detached before `frameElement()` returns.
+    # 
     #
     # ```js
     # const frameElement = await frame.frameElement();
@@ -261,37 +327,43 @@ module Playwright
       raise NotImplementedError.new('get_attribute is not implemented yet.')
     end
 
-    # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
-    # `frame.goto` will throw an error if:
+    # Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
+    # last redirect.
     # 
-    # there's an SSL error (e.g. in case of self-signed certificates).
-    # target URL is invalid.
-    # the `timeout` is exceeded during navigation.
-    # the remote server does not respond or is unreachable.
-    # the main resource failed to load.
+    # `frame.goto` will throw an error if:
+    # - there's an SSL error (e.g. in case of self-signed certificates).
+    # - target URL is invalid.
+    # - the `timeout` is exceeded during navigation.
+    # - the remote server does not respond or is unreachable.
+    # - the main resource failed to load.
     # 
-    # `frame.goto` 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()`.
+    # `frame.goto` 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
+    # [`method: Response.status`].
     # 
-    # **NOTE** `frame.goto` 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.
-    def goto(url, timeout: nil, waitUntil: nil, referer: nil)
-      wrap_channel_owner(@channel_owner.goto(url, timeout: timeout, waitUntil: waitUntil, referer: referer))
+    # > **NOTE** `frame.goto` 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).
+    def goto(url, referer: nil, timeout: nil, waitUntil: nil)
+      wrap_channel_owner(@channel_owner.goto(url, referer: referer, timeout: timeout, waitUntil: waitUntil))
     end
 
     # This method hovers over an element matching `selector` by performing the following steps:
+    # 1. Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.mouse to hover over the center of the element, or the specified `position`.
-    # 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 rejects with a TimeoutError. Passing zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method rejects with a `TimeoutError`.
+    # Passing zero timeout disables this.
     def hover(
           selector,
-          position: nil,
-          modifiers: nil,
           force: nil,
+          modifiers: nil,
+          position: nil,
           timeout: nil)
       raise NotImplementedError.new('hover is not implemented yet.')
     end
@@ -306,15 +378,47 @@ module Playwright
       raise NotImplementedError.new('inner_text is not implemented yet.')
     end
 
+    # Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
+    def checked?(selector, timeout: nil)
+      raise NotImplementedError.new('checked? is not implemented yet.')
+    end
+
     # Returns `true` if the frame has been detached, or `false` otherwise.
     def detached?
       raise NotImplementedError.new('detached? is not implemented yet.')
     end
 
+    # Returns whether the element is disabled, the opposite of [enabled](./actionability.md#enabled).
+    def disabled?(selector, timeout: nil)
+      raise NotImplementedError.new('disabled? is not implemented yet.')
+    end
+
+    # Returns whether the element is [editable](./actionability.md#editable).
+    def editable?(selector, timeout: nil)
+      raise NotImplementedError.new('editable? is not implemented yet.')
+    end
+
+    # Returns whether the element is [enabled](./actionability.md#enabled).
+    def enabled?(selector, timeout: nil)
+      raise NotImplementedError.new('enabled? is not implemented yet.')
+    end
+
+    # Returns whether the element is hidden, the opposite of [visible](./actionability.md#visible).
+    def hidden?(selector, timeout: nil)
+      raise NotImplementedError.new('hidden? is not implemented yet.')
+    end
+
+    # Returns whether the element is [visible](./actionability.md#visible).
+    def visible?(selector, timeout: nil)
+      raise NotImplementedError.new('visible? is not implemented yet.')
+    end
+
     # 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.
     def name
       raise NotImplementedError.new('name is not implemented yet.')
     end
@@ -329,12 +433,22 @@ module Playwright
       raise NotImplementedError.new('parent_frame is not implemented yet.')
     end
 
-    # `key` can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the `key` values can be found here. Examples of the keys are:
-    # `F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`, `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
-    # Following modification shortcuts are also suported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
+    # `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`,
+    # `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
+    # 
+    # Following modification shortcuts are also supported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
+    # 
     # 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.
-    # Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
+    # 
+    # 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 speficied with the
+    # modifier, modifier is pressed and being held while the subsequent key is being pressed.
     def press(
           selector,
           key,
@@ -345,7 +459,10 @@ module Playwright
     end
 
     # 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. If there's no `<select>` element matching `selector`, the method throws an error.
+    # 
+    # Triggers a `change` and `input` event once all the provided options have been selected. If there's no `<select>` element
+    # matching `selector`, the method throws an error.
+    # 
     #
     # ```js
     # // single selection matching the value
@@ -365,29 +482,33 @@ module Playwright
       raise NotImplementedError.new('set_content is not implemented yet.')
     end
 
-    # This method expects `selector` to point to an input element.
-    # 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 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).
+    # 
+    # 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 the current working directory. For empty array, clears the selected files.
     def set_input_files(selector, files, noWaitAfter: nil, timeout: nil)
       raise NotImplementedError.new('set_input_files is not implemented yet.')
     end
 
     # This method taps an element matching `selector` by performing the following steps:
+    # 1. Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.touchscreen to tap the center of the element, or the specified `position`.
-    # 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 rejects with a `TimeoutError`.
+    # Passing zero timeout disables this.
     # 
-    # When all steps combined have not finished during the specified `timeout`, this method rejects with 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.
     def tap_point(
           selector,
-          position: nil,
+          force: nil,
           modifiers: nil,
           noWaitAfter: nil,
-          force: nil,
+          position: nil,
           timeout: nil)
       raise NotImplementedError.new('tap_point is not implemented yet.')
     end
@@ -402,8 +523,11 @@ module Playwright
       raise NotImplementedError.new('title is not implemented yet.')
     end
 
-    # 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(selector, value[, options])`.
-    # To press a special key, like `Control` or `ArrowDown`, use `keyboard.press(key[, options])`.
+    # 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 [`method: Frame.fill`].
+    # 
+    # To press a special key, like `Control` or `ArrowDown`, use [`method: Keyboard.press`].
+    # 
     #
     # ```js
     # await frame.type('#mytextarea', 'Hello'); // Types instantly
@@ -419,16 +543,18 @@ module Playwright
     end
 
     # This method checks an element matching `selector` by performing the following steps:
+    # 1. Find an element match 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 rejects. If the element is already
+    #    unchecked, this method returns immediately.
+    # 1. Wait for [actionability](./actionability.md) 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 [`property: 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 rejects.
     # 
-    # Find an element match matching `selector`. If there is none, wait until a matching element is attached to the DOM.
-    # Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.
-    # Wait for actionability checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried.
-    # Scroll the element into view if needed.
-    # Use page.mouse to click in the center of the element.
-    # Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
-    # Ensure that the element is now unchecked. If not, this method rejects.
-    # 
-    # When all steps combined have not finished during the specified `timeout`, this method rejects with a TimeoutError. Passing zero timeout disables this.
+    # When all steps combined have not finished during the specified `timeout`, this method rejects with a `TimeoutError`.
+    # Passing zero timeout disables this.
     def uncheck(selector, force: nil, noWaitAfter: nil, timeout: nil)
       raise NotImplementedError.new('uncheck is not implemented yet.')
     end
@@ -439,7 +565,9 @@ module Playwright
     end
 
     # Returns when the `pageFunction` returns a truthy value, returns that value.
+    # 
     # The `waitForFunction` can be used to observe viewport size change:
+    # 
     #
     # ```js
     # const { firefox } = require('playwright');  // Or 'chromium' or 'webkit'.
@@ -453,7 +581,9 @@ module Playwright
     #   await browser.close();
     # })();
     # ```
+    # 
     # To pass an argument to the predicate of `frame.waitForFunction` function:
+    # 
     #
     # ```js
     # const selector = '.foo';
@@ -464,7 +594,10 @@ module Playwright
     end
 
     # 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.
+    # 
+    # 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.
+    # 
     #
     # ```js
     # await frame.click('button'); // Click triggers navigation.
@@ -474,8 +607,13 @@ module Playwright
       raise NotImplementedError.new('wait_for_load_state is not implemented yet.')
     end
 
-    # 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`.
-    # 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:
+    # 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`.
+    # 
+    # 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:
+    # 
     #
     # ```js
     # const [response] = await Promise.all([
@@ -483,14 +621,22 @@ module Playwright
     #   frame.click('a.my-link'), // Clicking the link will indirectly cause a navigation
     # ]);
     # ```
-    # **NOTE** Usage of the 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.
     def wait_for_navigation(timeout: nil, url: nil, waitUntil: nil)
       raise NotImplementedError.new('wait_for_navigation is not implemented yet.')
     end
 
-    # Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or `detached`.
-    # 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.
+    # Returns when element specified by selector satisfies `state` option. Returns `null` if waiting for `hidden` or
+    # `detached`.
+    # 
+    # 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.
+    # 
     # This method works across navigations:
+    # 
     #
     # ```js
     # const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
@@ -513,7 +659,9 @@ module Playwright
     end
 
     # 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 be flaky. Use signals such as network events, selectors becoming visible and others instead.
+    # 
+    # Note that `frame.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.
     def wait_for_timeout(timeout)
       raise NotImplementedError.new('wait_for_timeout is not implemented yet.')
     end