Class: Playwright::Mouse

Inherits:
PlaywrightApi show all
Defined in:
lib/playwright_api/mouse.rb

Overview

The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.

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(); “`

“‘java // Using ‘page.mouse’ to trace a 100x100 square. page.mouse().move(0, 0); page.mouse().down(); page.mouse().move(0, 100); page.mouse().move(100, 100); page.mouse().move(100, 0); page.mouse().move(0, 0); 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) page.mouse.down() page.mouse.move(0, 100) page.mouse.move(100, 100) page.mouse.move(100, 0) page.mouse.move(0, 0) page.mouse.up() “`

“‘csharp await Page.Mouse.MoveAsync(0, 0); await Page.Mouse.DownAsync(); await Page.Mouse.MoveAsync(0, 100); await Page.Mouse.MoveAsync(100, 100); await Page.Mouse.MoveAsync(100, 0); await Page.Mouse.MoveAsync(0, 0); await Page.Mouse.UpAsync(); “`

Instance Method Summary collapse

Methods inherited from PlaywrightApi

#==, #initialize, wrap

Constructor Details

This class inherits a constructor from Playwright::PlaywrightApi

Instance Method Details

#click(x, y, button: nil, clickCount: nil, delay: nil) ⇒ Object

Shortcut for [‘method: Mouse.move`], [`method: Mouse.down`], [`method: Mouse.up`].



63
64
65
66
67
68
69
70
 
# File 'lib/playwright_api/mouse.rb', line 63

def click(
      x,
      y,
      button: nil,
      clickCount: nil,
      delay: nil)
  wrap_impl(@impl.click(unwrap_impl(x), unwrap_impl(y), button: unwrap_impl(button), clickCount: unwrap_impl(clickCount), delay: unwrap_impl(delay)))
end

#dblclick(x, y, button: nil, delay: nil) ⇒ Object

Shortcut for [‘method: Mouse.move`], [`method: Mouse.down`], [`method: Mouse.up`], [`method: Mouse.down`] and [`method: Mouse.up`].



74
75
76
 
# File 'lib/playwright_api/mouse.rb', line 74

def dblclick(x, y, button: nil, delay: nil)
  wrap_impl(@impl.dblclick(unwrap_impl(x), unwrap_impl(y), button: unwrap_impl(button), delay: unwrap_impl(delay)))
end

#down(button: nil, clickCount: nil) ⇒ Object

Dispatches a ‘mousedown` event.



79
80
81
 
# File 'lib/playwright_api/mouse.rb', line 79

def down(button: nil, clickCount: nil)
  wrap_impl(@impl.down(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
end

#move(x, y, steps: nil) ⇒ Object

Dispatches a ‘mousemove` event.



84
85
86
 
# File 'lib/playwright_api/mouse.rb', line 84

def move(x, y, steps: nil)
  wrap_impl(@impl.move(unwrap_impl(x), unwrap_impl(y), steps: unwrap_impl(steps)))
end

#up(button: nil, clickCount: nil) ⇒ Object

Dispatches a ‘mouseup` event.



89
90
91
 
# File 'lib/playwright_api/mouse.rb', line 89

def up(button: nil, clickCount: nil)
  wrap_impl(@impl.up(button: unwrap_impl(button), clickCount: unwrap_impl(clickCount)))
end