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.
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();
Methods
ClickAsync
Added in: v1.8Shortcut for Mouse.MoveAsync(), Mouse.DownAsync(), Mouse.UpAsync().
Usage
await Mouse.ClickAsync(x, y, options);
Arguments
x
[float]#y
[float]#options
MouseClickOptions?
(optional)Button
enum MouseButton { Left, Right, Middle }?
(optional)#Defaults to
left
.defaults to 1. See UIEvent.detail.
Delay
[float]? (optional)#Time to wait between
mousedown
andmouseup
in milliseconds. Defaults to 0.
DblClickAsync
Added in: v1.8Shortcut for Mouse.MoveAsync(), Mouse.DownAsync(), Mouse.UpAsync(), Mouse.DownAsync() and Mouse.UpAsync().
Usage
await Mouse.DblClickAsync(x, y, options);
Arguments
DownAsync
Added in: v1.8Dispatches a mousedown
event.
Usage
await Mouse.DownAsync(options);
Arguments
options
MouseDownOptions?
(optional)Button
enum MouseButton { Left, Right, Middle }?
(optional)#Defaults to
left
.defaults to 1. See UIEvent.detail.
MoveAsync
Added in: v1.8Dispatches a mousemove
event.
Usage
await Mouse.MoveAsync(x, y, options);
Arguments
UpAsync
Added in: v1.8Dispatches a mouseup
event.
Usage
await Mouse.UpAsync(options);
Arguments
options
MouseUpOptions?
(optional)Button
enum MouseButton { Left, Right, Middle }?
(optional)#Defaults to
left
.defaults to 1. See UIEvent.detail.
WheelAsync
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.WheelAsync(deltaX, deltaY);
Arguments