Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

docs: mention trace viewer as debugging tool for the Mouse API class (#35857)

Gwenn Le Bihan0ace76a4b12e
diff --git a/docs/src/api/class-mouse.md b/docs/src/api/class-mouse.md
index 08eb74a072..1897482bac 100644
--- a/docs/src/api/class-mouse.md
+++ b/docs/src/api/class-mouse.md
@@ -3,6 +3,10 @@
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](../trace-viewer-intro.md) or [Playwright Inspector](../running-tests.md). 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 [`property: Page.mouse`].
```js
diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.ts
index a0f466d11b..dbd022dcc3 100644
--- a/packages/playwright-client/types/types.d.ts
+++ b/packages/playwright-client/types/types.d.ts
@@ -20161,6 +20161,10 @@ export interface Logger {
/**
* 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](https://playwright.dev/docs/trace-viewer-intro) or
+ * [Playwright Inspector](https://playwright.dev/docs/running-tests). 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](https://playwright.dev/docs/api/class-page#page-mouse).
*
diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.ts
index a0f466d11b..dbd022dcc3 100644
--- a/packages/playwright-core/types/types.d.ts
+++ b/packages/playwright-core/types/types.d.ts
@@ -20161,6 +20161,10 @@ export interface Logger {
/**
* 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](https://playwright.dev/docs/trace-viewer-intro) or
+ * [Playwright Inspector](https://playwright.dev/docs/running-tests). 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](https://playwright.dev/docs/api/class-page#page-mouse).
*