Skip to content
dev-docs

Mouse

Source URL: https://playwright.dev/docs/api/class-mouse

Mouse | Playwright

Section titled “Mouse | Playwright”

The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.

tip

If you want to debug where the mouse moved, you can use the Trace viewer or Playwright Inspector. A red dot showing the location of the mouse will be shown for every mouse action.

Every page object has its own Mouse, accessible with page.mouse.

    // 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​

Section titled “Methods​”

click​

Section titled “click​”

Added before v1.9 mouse.click

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

Usage

    await mouse.click(x, y);
    await mouse.click(x, y, options);

Arguments

X coordinate relative to the main frame’s viewport in CSS pixels.

Y coordinate relative to the main frame’s viewport in CSS pixels.

  • options Object (optional)
    • button “left” | “right” | “middle” (optional)#

Defaults to left.

* `clickCount` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number") _(optional)_[#](https://playwright.dev/docs/api/class-mouse#mouse-click-option-click-count)

defaults to 1. See UIEvent.detail.

* `delay` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number") _(optional)_[#](https://playwright.dev/docs/api/class-mouse#mouse-click-option-delay)

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

Returns

dblclick​

Section titled “dblclick​”

Added before v1.9 mouse.dblclick

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

Usage

    await mouse.dblclick(x, y);
    await mouse.dblclick(x, y, options);

Arguments

X coordinate relative to the main frame’s viewport in CSS pixels.

Y coordinate relative to the main frame’s viewport in CSS pixels.

  • options Object (optional)
    • button “left” | “right” | “middle” (optional)#

Defaults to left.

* `delay` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number") _(optional)_[#](https://playwright.dev/docs/api/class-mouse#mouse-dblclick-option-delay)

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

Returns

down​

Section titled “down​”

Added before v1.9 mouse.down

Dispatches a mousedown event.

Usage

    await mouse.down();
    await mouse.down(options);

Arguments

  • options Object (optional)
    • button “left” | “right” | “middle” (optional)#

Defaults to left.

* `clickCount` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number") _(optional)_[#](https://playwright.dev/docs/api/class-mouse#mouse-down-option-click-count)

defaults to 1. See UIEvent.detail.

Returns

move​

Section titled “move​”

Added before v1.9 mouse.move

Dispatches a mousemove event.

Usage

    await mouse.move(x, y);
    await mouse.move(x, y, options);

Arguments

X coordinate relative to the main frame’s viewport in CSS pixels.

Y coordinate relative to the main frame’s viewport in CSS pixels.

Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright’s current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.

Returns

up​

Section titled “up​”

Added before v1.9 mouse.up

Dispatches a mouseup event.

Usage

    await mouse.up();
    await mouse.up(options);

Arguments

  • options Object (optional)
    • button “left” | “right” | “middle” (optional)#

Defaults to left.

* `clickCount` [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number") _(optional)_[#](https://playwright.dev/docs/api/class-mouse#mouse-up-option-click-count)

defaults to 1. See UIEvent.detail.

Returns

wheel​

Section titled “wheel​”

Added in: v1.15 mouse.wheel

Dispatches a wheel event. This method is usually used to manually scroll the page. See scrolling for alternative ways to scroll.

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

Arguments

Pixels to scroll horizontally.

Pixels to scroll vertically.

Returns