Mouse

Mouse 类操作相对于视口左上角的主框架 CSS 像素。

每个 page 对象都有自己的 Mouse 实例，可通过 page.mouse 访问。

// 使用 'page.mouse' 追踪绘制 100x100 的正方形
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();

---

方法

click

v1.9 之前版本添加 mouse.click

mouse.move()、mouse.down()、mouse.up() 的快捷操作。

用法

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

参数

• x number#

  相对于主框架视口的 X 坐标（CSS 像素单位）。

• y number#

  相对于主框架视口的 Y 坐标（CSS 像素单位）。

• options Object (可选)

  • button "left" | "right" | "middle" (可选)#

    默认为 left。

  • clickCount number (可选)#

    默认为 1。参见 UIEvent.detail。

  • delay number (可选)#

    mousedown 和 mouseup 之间的等待时间（毫秒）。默认为 0。

返回值

• Promise<void>#

---

dblclick

v1.9 版本前添加 mouse.dblclick

mouse.move()、mouse.down()、mouse.up()、mouse.down() 和 mouse.up() 的快捷操作。

用法

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

参数

• x number#

  相对于主框架视口的 X 坐标（CSS 像素单位）。

• y number#

  相对于主框架视口的 Y 坐标（CSS 像素单位）。

• options Object (可选)

  • button "left" | "right" | "middle" (可选)#

    默认为 left。

  • delay number (可选)#

    mousedown 和 mouseup 之间的等待时间（毫秒）。默认为 0。

返回值

• Promise<void>#

---

down

v1.9 版本前添加 mouse.down

触发一个 mousedown 事件。

用法

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

参数

• options Object (可选)

  • button "left" | "right" | "middle" (可选)#

    默认为 left。

  • clickCount number (可选)#

    默认为 1。参见 UIEvent.detail。

返回值

• Promise<void>#

---

move

在 v1.9 版本前添加 mouse.move

触发一个 mousemove 事件。

用法

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

参数

• x number#

  相对于主框架视口的 X 坐标（CSS 像素单位）。

• y number#

  相对于主框架视口的 Y 坐标（CSS 像素单位）。

• options Object (可选)

  • steps number (可选)#

    默认为 1。发送中间的 mousemove 事件。

返回值

• Promise<void>#

---

up

v1.9 版本前添加 mouse.up

触发一个 mouseup 事件。

用法

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

参数

• options Object (可选)

  • button "left" | "right" | "middle" (可选)#

    默认为 left。

  • clickCount number (可选)#

    默认为 1。参见 UIEvent.detail。

返回值

• Promise<void>#

---

wheel

添加于: v1.15 mouse.wheel

触发一个 wheel 滚轮事件。此方法通常用于手动滚动页面。关于其他滚动方式，请参阅滚动章节。

:::注意

如果滚轮事件未被处理，可能会导致页面滚动，且此方法不会等待滚动完成就会返回。 :::

用法

await mouse.wheel(deltaX, deltaY);

参数

• deltaX number#

  水平方向滚动的像素值。

• deltaY number#

  垂直方向滚动的像素值。

返回值

• Promise<void>#