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().

// 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();

Methods​

click​

Added in: v1.8 mouse.click

Shortcut for Mouse.move(), Mouse.down(), Mouse.up().

Usage

Mouse.click(x, y);
Mouse.click(x, y, options);

Arguments

  • x double#
  • y double#
  • options Mouse.ClickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setClickCount int (optional)#

      defaults to 1. See UIEvent.detail.

    • setDelay double (optional)#

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

dblclick​

Added in: v1.8 mouse.dblclick

Shortcut for Mouse.move(), Mouse.down(), Mouse.up(), Mouse.down() and Mouse.up().

Usage

Mouse.dblclick(x, y);
Mouse.dblclick(x, y, options);

Arguments

  • x double#
  • y double#
  • options Mouse.DblclickOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setDelay double (optional)#

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

down​

Added in: v1.8 mouse.down

Dispatches a mousedown event.

Usage

Mouse.down();
Mouse.down(options);

Arguments

  • options Mouse.DownOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setClickCount int (optional)#

      defaults to 1. See UIEvent.detail.

move​

Added in: v1.8 mouse.move

Dispatches a mousemove event.

Usage

Mouse.move(x, y);
Mouse.move(x, y, options);

Arguments

  • x double#
  • y double#
  • options Mouse.MoveOptions (optional)

    • setSteps int (optional)#

      Defaults to 1. Sends intermediate mousemove events.

up​

Added in: v1.8 mouse.up

Dispatches a mouseup event.

Usage

Mouse.up();
Mouse.up(options);

Arguments

  • options Mouse.UpOptions (optional)

    • setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (optional)#

      Defaults to left.

    • setClickCount int (optional)#

      defaults to 1. See UIEvent.detail.

wheel​

Added in: v1.15 mouse.wheel

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

Mouse.wheel(deltaX, deltaY);

Arguments

  • deltaX double#

    Pixels to scroll horizontally.

  • deltaY double#

    Pixels to scroll vertically.