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.
- Sync
- Async
# 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()
# 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
mouse.click(x, y)
mouse.click(x, y, **kwargs)
Arguments
button
"left"|"right"|"middle" (optional)#Defaults to
left
.defaults to 1. See UIEvent.detail.
Time to wait between
mousedown
andmouseup
in milliseconds. Defaults to 0.
dblclick
Added in: v1.8Shortcut for mouse.move(), mouse.down(), mouse.up(), mouse.down() and mouse.up().
Usage
mouse.dblclick(x, y)
mouse.dblclick(x, y, **kwargs)
Arguments
button
"left"|"right"|"middle" (optional)#Defaults to
left
.Time to wait between
mousedown
andmouseup
in milliseconds. Defaults to 0.
down
Added in: v1.8Dispatches a mousedown
event.
Usage
mouse.down()
mouse.down(**kwargs)
Arguments
button
"left"|"right"|"middle" (optional)#Defaults to
left
.defaults to 1. See UIEvent.detail.
move
Added in: v1.8Dispatches a mousemove
event.
Usage
mouse.move(x, y)
mouse.move(x, y, **kwargs)
Arguments
up
Added in: v1.8Dispatches a mouseup
event.
Usage
mouse.up()
mouse.up(**kwargs)
Arguments
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
mouse.wheel(delta_x, delta_y)
Arguments