Mouse

Mouse 类在相对于视口左上角的主框架 CSS 像素中运行。

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

提示

如果你想调试鼠标移动的位置，可以使用 跟踪查看器 或 Playwright 检查器。每次鼠标操作都会显示一个红点，指示鼠标的位置。

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

每个 page 对象都有自己的鼠标，可通过 Page.Mouse 访问。

¥Every page object has its own Mouse, accessible with Page.Mouse.

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

---

方法

¥Methods

ClickAsync

Added before v1.9 mouse.ClickAsync

Mouse.MoveAsync()、Mouse.DownAsync()、Mouse.UpAsync() 的快捷方式。

¥Shortcut for Mouse.MoveAsync(), Mouse.DownAsync(), Mouse.UpAsync().

用法

¥Usage

await Mouse.ClickAsync(x, y, options);

参数

¥Arguments

• x [float]#

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

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

• y [float]#

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

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

• options MouseClickOptions?（可选）

  ¥options MouseClickOptions? (optional)

  • Button enum MouseButton { Left, Right, Middle }?（可选）#

    ¥Button enum MouseButton { Left, Right, Middle }? (optional)#

    默认为 left。

    ¥Defaults to left.

  • ClickCount int? (optional)#

默认为 1。参见 UIEvent.detail。

¥defaults to 1. See UIEvent.detail.

• Delay [float]? (optional)#

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

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

返回

¥Returns

• void#

---

DblClickAsync

Added before v1.9 mouse.DblClickAsync

Mouse.MoveAsync()、Mouse.DownAsync()、Mouse.UpAsync()、Mouse.DownAsync() 和 Mouse.UpAsync() 的快捷方式。

¥Shortcut for Mouse.MoveAsync(), Mouse.DownAsync(), Mouse.UpAsync(), Mouse.DownAsync() and Mouse.UpAsync().

用法

¥Usage

await Mouse.DblClickAsync(x, y, options);

参数

¥Arguments

• x [float]#

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

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

• y [float]#

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

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

• options MouseDblClickOptions?（可选）

  ¥options MouseDblClickOptions? (optional)

  • Button enum MouseButton { Left, Right, Middle }?（可选）#

    ¥Button enum MouseButton { Left, Right, Middle }? (optional)#

    默认为 left。

    ¥Defaults to left.

  • Delay [float]? (optional)#

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

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

返回

¥Returns

• void#

---

DownAsync

Added before v1.9 mouse.DownAsync

调度 mousedown 事件。

¥Dispatches a mousedown event.

用法

¥Usage

await Mouse.DownAsync(options);

参数

¥Arguments

• options MouseDownOptions?（可选）

  ¥options MouseDownOptions? (optional)

  • Button enum MouseButton { Left, Right, Middle }?（可选）#

    ¥Button enum MouseButton { Left, Right, Middle }? (optional)#

    默认为 left。

    ¥Defaults to left.

  • ClickCount int? (optional)#

默认为 1。参见 UIEvent.detail。

¥defaults to 1. See UIEvent.detail.

返回

¥Returns

• void#

---

MoveAsync

Added before v1.9 mouse.MoveAsync

调度 mousemove 事件。

¥Dispatches a mousemove event.

用法

¥Usage

await Mouse.MoveAsync(x, y, options);

参数

¥Arguments

• x [float]#

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

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

• y [float]#

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

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

• options MouseMoveOptions?（可选）

  ¥options MouseMoveOptions? (optional)

  • Steps int? (optional)#

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

¥Defaults to 1. Sends intermediate mousemove events.

返回

¥Returns

• void#

---

UpAsync

Added before v1.9 mouse.UpAsync

调度 mouseup 事件。

¥Dispatches a mouseup event.

用法

¥Usage

await Mouse.UpAsync(options);

参数

¥Arguments

• options MouseUpOptions?（可选）

  ¥options MouseUpOptions? (optional)

  • Button enum MouseButton { Left, Right, Middle }?（可选）#

    ¥Button enum MouseButton { Left, Right, Middle }? (optional)#

    默认为 left。

    ¥Defaults to left.

  • ClickCount int? (optional)#

默认为 1。参见 UIEvent.detail。

¥defaults to 1. See UIEvent.detail.

返回

¥Returns

• void#

---

WheelAsync

Added in: v1.15 mouse.WheelAsync

调度 wheel 事件。此方法通常用于手动滚动页面。有关滚动的其他方法，请参阅 scrolling。

¥Dispatches a wheel event. This method is usually used to manually scroll the page. See scrolling for alternative ways to scroll.

注意

滚轮事件如果不处理的话可能会导致滚动，并且该方法不会等待滚动完成才返回。

¥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.WheelAsync(deltaX, deltaY);

参数

¥Arguments

• deltaX [float]#

水平滚动的像素。

¥Pixels to scroll horizontally.

• deltaY [float]#

垂直滚动的像素。

¥Pixels to scroll vertically.

返回

¥Returns

• void#