playwright-ruby-client 1.26.0 → 1.28.0

data/lib/playwright_api/frame_locator.rb

@@ -4,7 +4,7 @@ module Playwright
   # [`method: Locator.frameLocator`] method.
   #
   # ```python sync
-  # locator = page.frame_locator("my-frame").locator("text=Submit")
+  # locator = page.frame_locator("my-frame").get_by_text("Submit")
   # locator.click()
   # ```
   #
@@ -15,10 +15,10 @@ module Playwright
   #
   # ```python sync
   # # Throws if there are several frames in DOM:
-  # page.frame_locator('.result-frame').locator('button').click()
+  # page.frame_locator('.result-frame').get_by_role('button').click()
   #
   # # Works because we explicitly tell locator to pick the first frame:
-  # page.frame_locator('.result-frame').first.locator('button').click()
+  # page.frame_locator('.result-frame').first.get_by_role('button').click()
   # ```
   #
   # **Converting Locator to FrameLocator**
@@ -27,7 +27,7 @@ module Playwright
   # [`:scope`](https://developer.mozilla.org/en-US/docs/Web/CSS/:scope) CSS selector:
   #
   # ```python sync
-  # frameLocator = locator.frame_locator(":scope");
+  # frameLocator = locator.frame_locator(":scope")
   # ```
   class FrameLocator < PlaywrightApi
 
@@ -42,12 +42,120 @@ module Playwright
       wrap_impl(@impl.frame_locator(unwrap_impl(selector)))
     end
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    def get_by_alt_text(text, exact: nil)
+      wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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">
+    # ```
+    def get_by_label(text, exact: nil)
+      wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
+    # "Country":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    def get_by_placeholder(text, exact: nil)
+      wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          exact: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    end
+
+    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
+    # [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text. Consider the following DOM structure:
+    #
+    # ```html
+    # <div>Hello <span>world</span></div>
+    # <div>Hello</div>
+    # ```
+    #
+    # You can locate by text substring, exact string, or a regular expression:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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: 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">`.
+    def get_by_text(text, exact: nil)
+      wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Returns locator to the last matching frame.
     def last
       wrap_impl(@impl.last)
     end
 
-    # The method finds an element matching the specified selector in the FrameLocator's subtree.
+    # The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options,
+    # similar to [`method: Locator.filter`] method.
+    #
+    # [Learn more about locators](../locators.md).
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end

data/lib/playwright_api/js_handle.rb

@@ -59,7 +59,7 @@ module Playwright
     # The method returns a map with **own property names** as keys and JSHandle instances for the property values.
     #
     # ```python sync
-    # handle = page.evaluate_handle("{window, document}")
+    # handle = page.evaluate_handle("({window, document})")
     # properties = handle.get_properties()
     # window_handle = properties.get("window")
     # document_handle = properties.get("document")
@@ -88,12 +88,6 @@ module Playwright
       wrap_impl(@impl.to_s)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -106,6 +100,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/keyboard.rb

@@ -1,6 +1,6 @@
 module Playwright
   # Keyboard provides an api for managing a virtual keyboard. The high level api is [`method: Keyboard.type`], which takes
-  # raw characters and generates proper keydown, keypress/input, and keyup events on your page.
+  # raw characters and generates proper `keydown`, `keypress`/`input`, and `keyup` events on your page.
   #
   # For finer control, you can use [`method: Keyboard.down`], [`method: Keyboard.up`], and [`method: Keyboard.insertText`]
   # to manually fire events as if they were generated from a real keyboard.

data/lib/playwright_api/locator.rb

@@ -15,6 +15,11 @@ module Playwright
       wrap_impl(@impl.all_text_contents)
     end
 
+    # Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur) on the element.
+    def blur(timeout: nil)
+      wrap_impl(@impl.blur(timeout: unwrap_impl(timeout)))
+    end
+
     # This method returns the bounding box of the element, or `null` if the element is not visible. The bounding box is
     # calculated relative to the main frame viewport - which is usually the same as the browser window.
     #
@@ -58,6 +63,17 @@ module Playwright
       wrap_impl(@impl.check(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
+    # This method waits for [actionability](../actionability.md) checks, focuses the element, clears it and triggers an
+    # `input` event after clearing.
+    #
+    # 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 cleared
+    # instead.
+    def clear(force: nil, noWaitAfter: nil, timeout: nil)
+      wrap_impl(@impl.clear(force: unwrap_impl(force), noWaitAfter: unwrap_impl(noWaitAfter), timeout: unwrap_impl(timeout)))
+    end
+
     # This method clicks the element by performing the following steps:
     # 1. Wait for [actionability](../actionability.md) checks on the element, unless `force` option is set.
     # 1. Scroll the element into view if needed.
@@ -142,6 +158,21 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(type), eventInit: unwrap_impl(eventInit), timeout: unwrap_impl(timeout)))
     end
 
+    # This method drags the locator to another target locator or target position. It will first move to the source element,
+    # perform a `mousedown`, then move to the target element or position and perform a `mouseup`.
+    #
+    # ```python sync
+    # source = page.locator("#source")
+    # target = page.locator("#target")
+    #
+    # source.drag_to(target)
+    # # or specify exact positions relative to the top-left corners of the elements:
+    # source.drag_to(
+    #   target,
+    #   source_position={"x": 34, "y": 7},
+    #   target_position={"x": 10, "y": 20}
+    # )
+    # ```
     def drag_to(
           target,
           force: nil,
@@ -232,7 +263,7 @@ module Playwright
     # # ...
     # row_locator
     #     .filter(has_text="text in column 1")
-    #     .filter(has=page.locator("tr", has_text="column 2 button"))
+    #     .filter(has=page.get_by_role("button", name="column 2 button"))
     #     .screenshot()
     # ```
     def filter(has: nil, hasText: nil)
@@ -253,7 +284,7 @@ module Playwright
     # that iframe:
     #
     # ```python sync
-    # locator = page.frame_locator("iframe").locator("text=Submit")
+    # locator = page.frame_locator("iframe").get_by_text("Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -266,6 +297,111 @@ module Playwright
     end
     alias_method :[], :get_attribute
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    def get_by_alt_text(text, exact: nil)
+      wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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">
+    # ```
+    def get_by_label(text, exact: nil)
+      wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
+    # "Country":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    def get_by_placeholder(text, exact: nil)
+      wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          exact: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    end
+
+    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
+    # [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text. Consider the following DOM structure:
+    #
+    # ```html
+    # <div>Hello <span>world</span></div>
+    # <div>Hello</div>
+    # ```
+    #
+    # You can locate by text substring, exact string, or a regular expression:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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: 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">`.
+    def get_by_text(text, exact: nil)
+      wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # Highlight the corresponding element(s) on the screen. Useful for debugging, don't commit the code that uses
     # [`method: Locator.highlight`].
     def highlight
@@ -285,10 +421,11 @@ module Playwright
     def hover(
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns the `element.innerHTML`.
@@ -344,8 +481,10 @@ module Playwright
       wrap_impl(@impl.last)
     end
 
-    # The method finds an element matching the specified selector in the `Locator`'s subtree. It also accepts filter options,
+    # The method finds an element matching the specified selector in the locator's subtree. It also accepts filter options,
     # similar to [`method: Locator.filter`] method.
+    #
+    # [Learn more about locators](../locators.md).
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
@@ -524,8 +663,8 @@ module Playwright
     # An example of typing into a text field and then submitting the form:
     #
     # ```python sync
-    # element = page.locator("input")
-    # element.type("some text")
+    # element = page.get_by_label("Password")
+    # element.type("my password")
     # element.press("Enter")
     # ```
     def type(text, delay: nil, noWaitAfter: nil, timeout: nil)

data/lib/playwright_api/page.rb

@@ -250,6 +250,19 @@ module Playwright
       wrap_impl(@impl.dispatch_event(unwrap_impl(selector), unwrap_impl(type), eventInit: unwrap_impl(eventInit), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # 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`.
+    #
+    # ```python sync
+    # page.drag_and_drop("#source", "#target")
+    # # or specify exact positions relative to the top-left corners of the elements:
+    # page.drag_and_drop(
+    #   "#source",
+    #   "#target",
+    #   source_position={"x": 34, "y": 7},
+    #   target_position={"x": 10, "y": 20}
+    # )
+    # ```
     def drag_and_drop(
           source,
           target,
@@ -553,7 +566,7 @@ module Playwright
     # id="my-frame">`:
     #
     # ```python sync
-    # locator = page.frame_locator("#my-iframe").locator("text=Submit")
+    # locator = page.frame_locator("#my-iframe").get_by_text("Submit")
     # locator.click()
     # ```
     def frame_locator(selector)
@@ -570,6 +583,111 @@ module Playwright
       wrap_impl(@impl.get_attribute(unwrap_impl(selector), unwrap_impl(name), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
+    # Allows locating elements by their alt text. For example, this method will find the image by alt text "Castle":
+    #
+    # ```html
+    # <img alt='Castle'>
+    # ```
+    def get_by_alt_text(text, exact: nil)
+      wrap_impl(@impl.get_by_alt_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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">
+    # ```
+    def get_by_label(text, exact: nil)
+      wrap_impl(@impl.get_by_label(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # Allows locating input elements by the placeholder text. For example, this method will find the input by placeholder
+    # "Country":
+    #
+    # ```html
+    # <input placeholder="Country">
+    # ```
+    def get_by_placeholder(text, exact: nil)
+      wrap_impl(@impl.get_by_placeholder(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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.
+    def get_by_role(
+          role,
+          checked: nil,
+          disabled: nil,
+          exact: nil,
+          expanded: nil,
+          includeHidden: nil,
+          level: nil,
+          name: nil,
+          pressed: nil,
+          selected: nil)
+      wrap_impl(@impl.get_by_role(unwrap_impl(role), checked: unwrap_impl(checked), disabled: unwrap_impl(disabled), exact: unwrap_impl(exact), expanded: unwrap_impl(expanded), includeHidden: unwrap_impl(includeHidden), level: unwrap_impl(level), name: unwrap_impl(name), pressed: unwrap_impl(pressed), selected: unwrap_impl(selected)))
+    end
+
+    # Locate element by the test id. By default, the `data-testid` attribute is used as a test id. Use
+    # [`method: Selectors.setTestIdAttribute`] to configure a different test id attribute if necessary.
+    def get_by_test_id(testId)
+      wrap_impl(@impl.get_by_test_id(unwrap_impl(testId)))
+    end
+
+    # Allows locating elements that contain given text. Consider the following DOM structure:
+    #
+    # ```html
+    # <div>Hello <span>world</span></div>
+    # <div>Hello</div>
+    # ```
+    #
+    # You can locate by text substring, exact string, or a regular expression:
+    #
+    # ```python sync
+    # # Matches <span>
+    # page.get_by_text("world")
+    #
+    # # Matches first <div>
+    # page.get_by_text("Hello world")
+    #
+    # # Matches second <div>
+    # page.get_by_text("Hello", exact=True)
+    #
+    # # Matches both <div>s
+    # page.get_by_text(re.compile("Hello"))
+    #
+    # # Matches second <div>
+    # page.get_by_text(re.compile("^hello$", re.IGNORECASE))
+    # ```
+    #
+    # See also [`method: 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: 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">`.
+    def get_by_text(text, exact: nil)
+      wrap_impl(@impl.get_by_text(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
+    # 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>
+    # ```
+    def get_by_title(text, exact: nil)
+      wrap_impl(@impl.get_by_title(unwrap_impl(text), exact: unwrap_impl(exact)))
+    end
+
     # 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`.
     #
@@ -626,11 +744,12 @@ module Playwright
           selector,
           force: nil,
           modifiers: nil,
+          noWaitAfter: nil,
           position: nil,
           strict: nil,
           timeout: nil,
           trial: nil)
-      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
+      wrap_impl(@impl.hover(unwrap_impl(selector), force: unwrap_impl(force), modifiers: unwrap_impl(modifiers), noWaitAfter: unwrap_impl(noWaitAfter), position: unwrap_impl(position), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout), trial: unwrap_impl(trial)))
     end
 
     # Returns `element.innerHTML`.
@@ -688,13 +807,11 @@ module Playwright
       wrap_impl(@impl.visible?(unwrap_impl(selector), strict: unwrap_impl(strict), timeout: unwrap_impl(timeout)))
     end
 
-    # The method returns an element locator that can be used to perform actions on the page. 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](../locators.md).
-    #
-    # Shortcut for main frame's [`method: Frame.locator`].
     def locator(selector, has: nil, hasText: nil)
       wrap_impl(@impl.locator(unwrap_impl(selector), has: unwrap_impl(has), hasText: unwrap_impl(hasText)))
     end
@@ -1177,7 +1294,7 @@ module Playwright
     #
     # ```python sync
     # with page.expect_event("framenavigated") as event_info:
-    #     page.click("button")
+    #     page.get_by_role("button")
     # frame = event_info.value
     # ```
     def expect_event(event, predicate: nil, timeout: nil, &block)
@@ -1228,13 +1345,13 @@ module Playwright
     # when this method is called. If current document has already reached the required state, resolves immediately.
     #
     # ```python sync
-    # page.click("button") # click triggers navigation.
+    # page.get_by_role("button").click() # click triggers navigation.
     # page.wait_for_load_state() # the promise resolves after "load" event.
     # ```
     #
     # ```python sync
     # with page.expect_popup() as page_info:
-    #     page.click("button") # click triggers a popup.
+    #     page.get_by_role("button").click() # click triggers a popup.
     # popup = page_info.value
     #  # Following resolves after "domcontentloaded" event.
     # popup.wait_for_load_state("domcontentloaded")
@@ -1437,12 +1554,6 @@ module Playwright
       wrap_impl(@impl.stop_css_coverage)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -1455,6 +1566,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end

data/lib/playwright_api/playwright.rb

@@ -96,12 +96,6 @@ module Playwright
       wrap_impl(@impl.electron)
     end
 
-    # -- inherited from EventEmitter --
-    # @nodoc
-    def off(event, callback)
-      event_emitter_proxy.off(event, callback)
-    end
-
     # -- inherited from EventEmitter --
     # @nodoc
     def once(event, callback)
@@ -114,6 +108,12 @@ module Playwright
       event_emitter_proxy.on(event, callback)
     end
 
+    # -- inherited from EventEmitter --
+    # @nodoc
+    def off(event, callback)
+      event_emitter_proxy.off(event, callback)
+    end
+
     private def event_emitter_proxy
       @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl)
     end