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();
Methods
click
Added in: v1.8Shortcut for mouse.move(), mouse.down(), mouse.up().
Usage
await mouse.click(x, y);
await mouse.click(x, y, options);
Arguments
dblclick
Added in: v1.8Shortcut for mouse.move(), mouse.down(), mouse.up(), mouse.down() and mouse.up().
Usage
await mouse.dblclick(x, y);
await mouse.dblclick(x, y, options);
Arguments
down
Added in: v1.8Dispatches a mousedown
event.
Usage
await mouse.down();
await mouse.down(options);
Arguments
options
Object (optional)-
button
"left"|"right"|"middle" (optional)#Defaults to
left
. -
defaults to 1. See UIEvent.detail.
-
move
Added in: v1.8Dispatches a mousemove
event.
Usage
await mouse.move(x, y);
await mouse.move(x, y, options);
Arguments
up
Added in: v1.8Dispatches a mouseup
event.
Usage
await mouse.up();
await mouse.up(options);
Arguments
options
Object (optional)-
button
"left"|"right"|"middle" (optional)#Defaults to
left
. -
defaults to 1. See UIEvent.detail.
-
wheel
Added in: v1.15Dispatches a wheel
event.
Wheel events may cause scrolling if they are not handled, and this method does not wait for the scrolling to finish before returning.
Usage
await mouse.wheel(deltaX, deltaY);
Arguments