Skip to main content

class: Mouse

Added in: v1.8

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

async method: Mouse.click​

Added in: v1.8

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

param: Mouse.click.x​

Added in: v1.8

  • x <float>

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

param: Mouse.click.y​

Added in: v1.8

  • y <float>

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

option: Mouse.click.button = %%-input-button-%%​

Added in: v1.8

option: Mouse.click.clickCount = %%-input-click-count-%%​

Added in: v1.8

option: Mouse.click.delay = %%-input-down-up-delay-%%​

Added in: v1.8

async method: Mouse.dblclick​

Added in: v1.8

Languages: (all)

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

param: Mouse.dblclick.x​

Added in: v1.8

  • x <float>

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

param: Mouse.dblclick.y​

Added in: v1.8

  • y <float>

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

option: Mouse.dblclick.button = %%-input-button-%%​

Added in: v1.8

option: Mouse.dblclick.delay = %%-input-down-up-delay-%%​

Added in: v1.8

async method: Mouse.down​

Added in: v1.8

Dispatches a mousedown event.

option: Mouse.down.button = %%-input-button-%%​

Added in: v1.8

option: Mouse.down.clickCount = %%-input-click-count-%%​

Added in: v1.8

async method: Mouse.move​

Added in: v1.8

Dispatches a mousemove event.

param: Mouse.move.x​

Added in: v1.8

  • x <float>

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

param: Mouse.move.y​

Added in: v1.8

  • y <float>

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

option: Mouse.move.steps = %%-input-mousemove-steps-%%​

Added in: v1.8

async method: Mouse.up​

Added in: v1.8

Dispatches a mouseup event.

option: Mouse.up.button = %%-input-button-%%​

Added in: v1.8

option: Mouse.up.clickCount = %%-input-click-count-%%​

Added in: v1.8

async method: Mouse.wheel​

Added in: v1.15

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.

param: Mouse.wheel.deltaX​

Added in: v1.15

  • deltaX <float>

Pixels to scroll horizontally.

param: Mouse.wheel.deltaY​

Added in: v1.15

  • deltaY <float>

Pixels to scroll vertically.