Package com.microsoft.playwright

Interface Mouse

All Known Implementing Classes:
MouseImpl
public interface 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();

  • Method Details

    • click

      default void click(double x, double y)
      Shortcut for Mouse.move(), Mouse.down(), Mouse.up().
      Since:
      v1.8

    • click

      void click(double x, double y, Mouse.ClickOptions options)
      Shortcut for Mouse.move(), Mouse.down(), Mouse.up().
      Since:
      v1.8

    • dblclick

      default void dblclick(double x, double y)
      Shortcut for Mouse.move(), Mouse.down(), Mouse.up(), Mouse.down() and Mouse.up().
      Since:
      v1.8

    • dblclick

      void dblclick(double x, double y, Mouse.DblclickOptions options)
      Shortcut for Mouse.move(), Mouse.down(), Mouse.up(), Mouse.down() and Mouse.up().
      Since:
      v1.8

    • down

      default void down()
      Dispatches a mousedown event.
      Since:
      v1.8

    • down

      void down(Mouse.DownOptions options)
      Dispatches a mousedown event.
      Since:
      v1.8

    • move

      default void move(double x, double y)
      Dispatches a mousemove event.
      Since:
      v1.8

    • move

      void move(double x, double y, Mouse.MoveOptions options)
      Dispatches a mousemove event.
      Since:
      v1.8

    • up

      default void up()
      Dispatches a mouseup event.
      Since:
      v1.8

    • up

      void up(Mouse.UpOptions options)
      Dispatches a mouseup event.
      Since:
      v1.8

    • wheel

      void wheel(double deltaX, double deltaY)
      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.

      Parameters:
      deltaX - Pixels to scroll horizontally.
      deltaY - Pixels to scroll vertically.
      Since:
      v1.15