mirror of
https://github.com/microsoft/playwright.git
synced 2025-06-26 21:40:17 +00:00
132 lines
6.4 KiB
Markdown
132 lines
6.4 KiB
Markdown
---
|
||
id: class-mouse
|
||
title: "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](api/class-page.md#pagemouse).
|
||
|
||
```js
|
||
// 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();
|
||
```
|
||
|
||
|
||
- [mouse.click(x, y[, options])](api/class-mouse.md#mouseclickx-y-options)
|
||
- [mouse.dblclick(x, y[, options])](api/class-mouse.md#mousedblclickx-y-options)
|
||
- [mouse.down([options])](api/class-mouse.md#mousedownoptions)
|
||
- [mouse.move(x, y[, options])](api/class-mouse.md#mousemovex-y-options)
|
||
- [mouse.up([options])](api/class-mouse.md#mouseupoptions)
|
||
|
||
## mouse.click(x, y[, options])
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Shortcut for [mouse.move(x, y[, options])](api/class-mouse.md#mousemovex-y-options), [mouse.down([options])](api/class-mouse.md#mousedownoptions), [mouse.up([options])](api/class-mouse.md#mouseupoptions).
|
||
|
||
## mouse.dblclick(x, y[, options])
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `delay` <[number]> Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
|
||
- returns: <[Promise]>
|
||
|
||
Shortcut for [mouse.move(x, y[, options])](api/class-mouse.md#mousemovex-y-options), [mouse.down([options])](api/class-mouse.md#mousedownoptions), [mouse.up([options])](api/class-mouse.md#mouseupoptions), [mouse.down([options])](api/class-mouse.md#mousedownoptions) and [mouse.up([options])](api/class-mouse.md#mouseupoptions).
|
||
|
||
## mouse.down([options])
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mousedown` event.
|
||
|
||
## mouse.move(x, y[, options])
|
||
- `x` <[number]>
|
||
- `y` <[number]>
|
||
- `options` <[Object]>
|
||
- `steps` <[number]> defaults to 1. Sends intermediate `mousemove` events.
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mousemove` event.
|
||
|
||
## mouse.up([options])
|
||
- `options` <[Object]>
|
||
- `button` <"left"|"right"|"middle"> Defaults to `left`.
|
||
- `clickCount` <[number]> defaults to 1. See [UIEvent.detail].
|
||
- returns: <[Promise]>
|
||
|
||
Dispatches a `mouseup` event.
|
||
|
||
[Playwright]: api/class-playwright.md "Playwright"
|
||
[Browser]: api/class-browser.md "Browser"
|
||
[BrowserContext]: api/class-browsercontext.md "BrowserContext"
|
||
[Page]: api/class-page.md "Page"
|
||
[Frame]: api/class-frame.md "Frame"
|
||
[ElementHandle]: api/class-elementhandle.md "ElementHandle"
|
||
[JSHandle]: api/class-jshandle.md "JSHandle"
|
||
[ConsoleMessage]: api/class-consolemessage.md "ConsoleMessage"
|
||
[Dialog]: api/class-dialog.md "Dialog"
|
||
[Download]: api/class-download.md "Download"
|
||
[Video]: api/class-video.md "Video"
|
||
[FileChooser]: api/class-filechooser.md "FileChooser"
|
||
[Keyboard]: api/class-keyboard.md "Keyboard"
|
||
[Mouse]: api/class-mouse.md "Mouse"
|
||
[Touchscreen]: api/class-touchscreen.md "Touchscreen"
|
||
[Request]: api/class-request.md "Request"
|
||
[Response]: api/class-response.md "Response"
|
||
[Selectors]: api/class-selectors.md "Selectors"
|
||
[Route]: api/class-route.md "Route"
|
||
[WebSocket]: api/class-websocket.md "WebSocket"
|
||
[TimeoutError]: api/class-timeouterror.md "TimeoutError"
|
||
[Accessibility]: api/class-accessibility.md "Accessibility"
|
||
[Worker]: api/class-worker.md "Worker"
|
||
[BrowserServer]: api/class-browserserver.md "BrowserServer"
|
||
[BrowserType]: api/class-browsertype.md "BrowserType"
|
||
[Logger]: api/class-logger.md "Logger"
|
||
[ChromiumBrowser]: api/class-chromiumbrowser.md "ChromiumBrowser"
|
||
[ChromiumBrowserContext]: api/class-chromiumbrowsercontext.md "ChromiumBrowserContext"
|
||
[ChromiumCoverage]: api/class-chromiumcoverage.md "ChromiumCoverage"
|
||
[CDPSession]: api/class-cdpsession.md "CDPSession"
|
||
[FirefoxBrowser]: api/class-firefoxbrowser.md "FirefoxBrowser"
|
||
[WebKitBrowser]: api/class-webkitbrowser.md "WebKitBrowser"
|
||
[Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"
|
||
[Buffer]: https://nodejs.org/api/buffer.html#buffer_class_buffer "Buffer"
|
||
[ChildProcess]: https://nodejs.org/api/child_process.html "ChildProcess"
|
||
[Element]: https://developer.mozilla.org/en-US/docs/Web/API/element "Element"
|
||
[Error]: https://nodejs.org/api/errors.html#errors_class_error "Error"
|
||
[Evaluation Argument]: ./core-concepts.md#evaluationargument "Evaluation Argument"
|
||
[Map]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map "Map"
|
||
[Object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object "Object"
|
||
[Promise]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise "Promise"
|
||
[RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp "RegExp"
|
||
[Serializable]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Description "Serializable"
|
||
[UIEvent.detail]: https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail "UIEvent.detail"
|
||
[URL]: https://nodejs.org/api/url.html "URL"
|
||
[USKeyboardLayout]: ../src/usKeyboardLayout.ts "USKeyboardLayout"
|
||
[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
|
||
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
|
||
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
|
||
[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols "Iterator"
|
||
[null]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null "null"
|
||
[number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type "Number"
|
||
[origin]: https://developer.mozilla.org/en-US/docs/Glossary/Origin "Origin"
|
||
[selector]: https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors "selector"
|
||
[Readable]: https://nodejs.org/api/stream.html#stream_class_stream_readable "Readable"
|
||
[string]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type "string"
|
||
[xpath]: https://developer.mozilla.org/en-US/docs/Web/XPath "xpath"
|