docs/src/api/class-mouse.md
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 [property: 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();
// 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();
# 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()
# 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()
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();
Shortcut for [method: Mouse.move], [method: Mouse.down], [method: Mouse.up].
x <[float]>X coordinate relative to the main frame's viewport in CSS pixels.
y <[float]>Y coordinate relative to the main frame's viewport in CSS pixels.
Shortcut for [method: Mouse.move], [method: Mouse.down], [method: Mouse.up], [method: Mouse.down] and
[method: Mouse.up].
x <[float]>X coordinate relative to the main frame's viewport in CSS pixels.
y <[float]>Y coordinate relative to the main frame's viewport in CSS pixels.
Dispatches a mousedown event.
Dispatches a mousemove event.
x <[float]>X coordinate relative to the main frame's viewport in CSS pixels.
y <[float]>Y coordinate relative to the main frame's viewport in CSS pixels.
Dispatches a mouseup event.
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. :::
deltaX <[float]>Pixels to scroll horizontally.
deltaY <[float]>Pixels to scroll vertically.