effect-playwright
    Preparing search index...

    Interface Mouse

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

    NOTE 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();
    interface Mouse {
        click(
            x: number,
            y: number,
            options?: {
                button?: "left" | "right" | "middle";
                clickCount?: number;
                delay?: number;
            },
        ): Promise<void>;
        dblclick(
            x: number,
            y: number,
            options?: { button?: "left" | "right" | "middle"; delay?: number },
        ): Promise<void>;
        down(
            options?: { button?: "left" | "right" | "middle"; clickCount?: number },
        ): Promise<void>;
        move(x: number, y: number, options?: { steps?: number }): Promise<void>;
        up(
            options?: { button?: "left" | "right" | "middle"; clickCount?: number },
        ): Promise<void>;
        wheel(deltaX: number, deltaY: number): Promise<void>;
    }
    Index
    click dblclick down move up wheel

    • Shortcut for mouse.move(x, y[, options]), mouse.down([options]), mouse.up([options]).

      Parameters

      • x: number

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

      • y: number

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

      • Optionaloptions: { button?: "left" | "right" | "middle"; clickCount?: number; delay?: number }
        • Optionalbutton?: "left" | "right" | "middle"

          Defaults to left.

        • OptionalclickCount?: number

          defaults to 1. See [UIEvent.detail].

        • Optionaldelay?: number

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

      Returns Promise<void>

    • Shortcut for mouse.move(x, y[, options]), mouse.down([options]), mouse.up([options]), mouse.down([options]) and mouse.up([options]).

      Parameters

      • x: number

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

      • y: number

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

      • Optionaloptions: { button?: "left" | "right" | "middle"; delay?: number }
        • Optionalbutton?: "left" | "right" | "middle"

          Defaults to left.

        • Optionaldelay?: number

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

      Returns Promise<void>

    • Dispatches a mousedown event.

      Parameters

      • Optionaloptions: { button?: "left" | "right" | "middle"; clickCount?: number }
        • Optionalbutton?: "left" | "right" | "middle"

          Defaults to left.

        • OptionalclickCount?: number

          defaults to 1. See [UIEvent.detail].

      Returns Promise<void>

    • Dispatches a mousemove event.

      Parameters

      • x: number

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

      • y: number

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

      • Optionaloptions: { steps?: number }
        • Optionalsteps?: number

          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 Promise<void>

    • Dispatches a mouseup event.

      Parameters

      • Optionaloptions: { button?: "left" | "right" | "middle"; clickCount?: number }
        • Optionalbutton?: "left" | "right" | "middle"

          Defaults to left.

        • OptionalclickCount?: number

          defaults to 1. See [UIEvent.detail].

      Returns Promise<void>

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

      Parameters

      • deltaX: number

        Pixels to scroll horizontally.

      • deltaY: number

        Pixels to scroll vertically.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods