class: Mouse

class: Mouse

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 page.mouse.

// 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();
  • mouse.click(x, y[, options])
  • mouse.dblclick(x, y[, options])
  • mouse.down([options])
  • mouse.move(x, y[, options])
  • mouse.up([options])

mouse.click(x, y[, options])

  • x <number “Number”)>
  • y <number “Number”)>
  • options <Object “Object”)>
    • button <“left”|”right“|“middle”> Defaults to left.
    • clickCount <number “Number”)> defaults to 1. See UIEvent.detail ”UIEvent.detail“).
    • delay <number “Number”)> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
  • returns: <Promise “Promise”)>

Shortcut for mouse.move, mouse.down and mouse.up.

mouse.dblclick(x, y[, options])

  • x <number “Number”)>
  • y <number “Number”)>
  • options <Object “Object”)>
    • button <“left”|”right“|“middle”> Defaults to left.
    • delay <number “Number”)> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
  • returns: <Promise “Promise”)>

Shortcut for mouse.move, mouse.down, mouse.up, mouse.down and mouse.up.

mouse.down([options])

  • options <Object “Object”)>
    • button <“left”|”right“|“middle”> Defaults to left.
    • clickCount <number “Number”)> defaults to 1. See UIEvent.detail ”UIEvent.detail“).
  • returns: <Promise “Promise”)>

Dispatches a mousedown event.

mouse.move(x, y[, options])

  • x <number “Number”)>
  • y <number “Number”)>
  • options <Object “Object”)>
    • steps <number “Number”)> defaults to 1. Sends intermediate mousemove events.
  • returns: <Promise “Promise”)>

Dispatches a mousemove event.

mouse.up([options])

  • options <Object “Object”)>
    • button <“left”|”right“|“middle”> Defaults to left.
    • clickCount <number “Number”)> defaults to 1. See UIEvent.detail ”UIEvent.detail“).
  • returns: <Promise “Promise”)>

Dispatches a mouseup event.