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

click​

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

Usage

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

Arguments

• x number
• y number
• options Object (optional)

  • button "left" | "right" | "middle" (optional)

    Defaults to left.

  • clickCount number (optional)

    defaults to 1. See UIEvent.detail.

  • delay number (optional)

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

Returns

• Promise<void>

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 number
• y number
• options Object (optional)

  • button "left" | "right" | "middle" (optional)

    Defaults to left.

  • delay number (optional)

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

Returns

• Promise<void>

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

    defaults to 1. See UIEvent.detail.

Returns

• Promise<void>

move​

Dispatches a mousemove event.

Usage

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

Arguments

• x number
• y number
• options Object (optional)

  • steps number (optional)

    Defaults to 1. Sends intermediate mousemove events.

Returns

• Promise<void>

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

    defaults to 1. See UIEvent.detail.

Returns

• Promise<void>

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

await mouse.wheel(deltaX, deltaY);

Arguments

• deltaX number

  Pixels to scroll horizontally.

• deltaY number

  Pixels to scroll vertically.

Returns

• Promise<void>