Skip to main content
Page mouse methods for the Puppeteer driver.

​
mouse.click

Click at specific coordinates.
​
x
number
required
​
y
number
required
​
options
PuppeteerMouseClickOptions
await page.mouse.click(0, 0);

​
mouse.move

Move mouse to specific coordinates.
​
x
number
required
​
y
number
required
​
options
PuppeteerMouseMoveOptions
await page.mouse.move(0, 0);

​
mouse.down

Press mouse button down.
​
options
PuppeteerMouseOptions
await page.mouse.down();

​
mouse.up

Release mouse button.
​
options
PuppeteerMouseOptions
await page.mouse.up();

​
mouse.wheel

Scroll mouse wheel.
​
options
PuppeteerMouseWheelOptions
await page.mouse.wheel();

​
mouse.drag

Dispatches a drag event.
​
start
PuppeteerPoint
required
​
target
PuppeteerPoint
required
​
result
PuppeteerDragData
Return value
await page.mouse.drag(/* PuppeteerPoint */, /* PuppeteerPoint */);

​
mouse.dragAndDrop

Perform a drag and drop operation.
​
start
PuppeteerPoint
required
​
target
PuppeteerPoint
required
​
options
{ delay?: number }
await page.mouse.dragAndDrop(/* PuppeteerPoint */, /* PuppeteerPoint */);

​
mouse.dragEnter

Dispatches a dragenter event.
​
target
PuppeteerPoint
required
​
data
PuppeteerDragData
required
await page.mouse.dragEnter(/* PuppeteerPoint */, /* PuppeteerDragData */);

​
mouse.dragOver

Dispatches a dragover event.
​
target
PuppeteerPoint
required
​
data
PuppeteerDragData
required
await page.mouse.dragOver(/* PuppeteerPoint */, /* PuppeteerDragData */);

​
mouse.drop

Performs a dragenter, dragover, and drop in sequence.
​
target
PuppeteerPoint
required
​
data
PuppeteerDragData
required
await page.mouse.drop(/* PuppeteerPoint */, /* PuppeteerDragData */);

​
mouse.reset

Resets the mouse to the default state. 
await page.mouse.reset();