Skip to main content

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.8mouse.ClickAsync

Shortcut 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.

    • ClickCount int? (optional)#

      defaults to 1. See UIEvent.detail.

    • Delay [float]? (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

DblClickAsync​

Added in: v1.8mouse.DblClickAsync

Shortcut for Mouse.MoveAsync(), Mouse.DownAsync(), Mouse.UpAsync(), Mouse.DownAsync() and Mouse.UpAsync().

Usage

await Mouse.DblClickAsync(x, y, options);

Arguments

  • x [float]#
  • y [float]#
  • options MouseDblClickOptions? (optional)

    • Button enum MouseButton { Left, Right, Middle }? (optional)#

      Defaults to left.

    • Delay [float]? (optional)#

      Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.

DownAsync​

Added in: v1.8mouse.DownAsync

Dispatches a mousedown event.

Usage

await Mouse.DownAsync(options);

Arguments

  • options MouseDownOptions? (optional)

    • Button enum MouseButton { Left, Right, Middle }? (optional)#

      Defaults to left.

    • ClickCount int? (optional)#

      defaults to 1. See UIEvent.detail.

MoveAsync​

Added in: v1.8mouse.MoveAsync

Dispatches a mousemove event.

Usage

await Mouse.MoveAsync(x, y, options);

Arguments

  • x [float]#
  • y [float]#
  • options MouseMoveOptions? (optional)

    • Steps int? (optional)#

      Defaults to 1. Sends intermediate mousemove events.

UpAsync​

Added in: v1.8mouse.UpAsync

Dispatches a mouseup event.

Usage

await Mouse.UpAsync(options);

Arguments

  • options MouseUpOptions? (optional)

    • Button enum MouseButton { Left, Right, Middle }? (optional)#

      Defaults to left.

    • ClickCount int? (optional)#

      defaults to 1. See UIEvent.detail.

WheelAsync​

Added in: v1.15mouse.WheelAsync

Dispatches a wheel event.

note

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

  • deltaX [float]#

    Pixels to scroll horizontally.

  • deltaY [float]#

    Pixels to scroll vertically.