playwright-ruby-client 0.0.8 → 1.58.1.alpha1

data/lib/playwright_api/mouse.rb

@@ -1,31 +1,11 @@
 module Playwright
+  #
   # The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
-  # 
+  #
+  # **NOTE**: If you want to debug where the mouse moved, you can use the [Trace viewer](../trace-viewer-intro.md) or [Playwright Inspector](../running-tests.md). A red dot showing the location of the mouse will be shown for every mouse action.
+  #
   # Every `page` object has its own Mouse, accessible with [`property: Page.mouse`].
-  # 
   #
-  # ```js
-  # // Using ‘page.mouse’ to trace a 100x100 square.
-  # await page.mouse.move(0, 0);
-  # await page.mouse.down();
-  # await page.mouse.move(0, 100);
-  # await page.mouse.move(100, 100);
-  # await page.mouse.move(100, 0);
-  # await page.mouse.move(0, 0);
-  # await page.mouse.up();
-  # ```
-  # 
-  # ```python async
-  # # using ‘page.mouse’ to trace a 100x100 square.
-  # await page.mouse.move(0, 0)
-  # await page.mouse.down()
-  # await page.mouse.move(0, 100)
-  # await page.mouse.move(100, 100)
-  # await page.mouse.move(100, 0)
-  # await page.mouse.move(0, 0)
-  # await page.mouse.up()
-  # ```
-  # 
   # ```python sync
   # # using ‘page.mouse’ to trace a 100x100 square.
   # page.mouse.move(0, 0)
@@ -38,6 +18,7 @@ module Playwright
   # ```
   class Mouse < PlaywrightApi
 
+    #
     # Shortcut for [`method: Mouse.move`], [`method: Mouse.down`], [`method: Mouse.up`].
     def click(
           x,
@@ -45,28 +26,41 @@ module Playwright
           button: nil,
           clickCount: nil,
           delay: nil)
-      raise NotImplementedError.new('click is not implemented yet.')
+      wrap_impl(@impl.click(unwrap_impl(x), unwrap_impl(y), button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay)))
     end
 
+    #
     # Shortcut for [`method: Mouse.move`], [`method: Mouse.down`], [`method: Mouse.up`], [`method: Mouse.down`] and
     # [`method: Mouse.up`].
     def dblclick(x, y, button: nil, delay: nil)
-      raise NotImplementedError.new('dblclick is not implemented yet.')
+      wrap_impl(@impl.dblclick(unwrap_impl(x), unwrap_impl(y), button: unwrap_impl(button), delay: unwrap_impl(delay)))
     end
 
+    #
     # Dispatches a `mousedown` event.
     def down(button: nil, clickCount: nil)
-      raise NotImplementedError.new('down is not implemented yet.')
+      wrap_impl(@impl.down(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
     end
 
+    #
     # Dispatches a `mousemove` event.
     def move(x, y, steps: nil)
-      raise NotImplementedError.new('move is not implemented yet.')
+      wrap_impl(@impl.move(unwrap_impl(x), unwrap_impl(y), steps: unwrap_impl(steps)))
     end
 
+    #
     # Dispatches a `mouseup` event.
     def up(button: nil, clickCount: nil)
-      raise NotImplementedError.new('up is not implemented yet.')
+      wrap_impl(@impl.up(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
+    end
+
+    #
+    # Dispatches a `wheel` event. This method is usually used to manually scroll the page. See [scrolling](../input.md#scrolling) for alternative ways to scroll.
+    #
+    # **NOTE**: Wheel events may cause scrolling if they are not handled, and this method does not
+    # wait for the scrolling to finish before returning.
+    def wheel(deltaX, deltaY)
+      wrap_impl(@impl.wheel(unwrap_impl(deltaX), unwrap_impl(deltaY)))
     end
   end
 end