playwright/docs/src/api/class-touchscreen.md

42 lines
1.4 KiB
Markdown
Raw Normal View History

# class: Touchscreen
2022-07-05 16:24:50 -08:00
* since: v1.8
The Touchscreen class operates in main-frame CSS pixels relative to the top-left corner of the viewport. Methods on the
2021-03-26 18:47:16 +01:00
touchscreen can only be used in browser contexts that have been initialized with `hasTouch` set to true.
## async method: Touchscreen.tap
2022-07-05 16:24:50 -08:00
* since: v1.8
Dispatches a `touchstart` and `touchend` event with a single touch at the position ([`param: x`],[`param: y`]).
:::note
[`method: Page.tap`] the method will throw if [`option: hasTouch`] option of the browser context is false.
:::
### param: Touchscreen.tap.x
2022-07-05 16:24:50 -08:00
* since: v1.8
- `x` <[float]>
### param: Touchscreen.tap.y
2022-07-05 16:24:50 -08:00
* since: v1.8
- `y` <[float]>
## async method: Touchscreen.touch
* since: v1.46
Synthesizes a touch event.
### param: Touchscreen.touch.type
* since: v1.46
- `type` <[TouchType]<"touchstart"|"touchend"|"touchmove"|"touchcancel">>
Type of the touch event.
### param: Touchscreen.touch.touches
* since: v1.46
- `touchPoints` <[Array]<[Object]>>
- `x` <[float]> x coordinate of the event in CSS pixels.
- `y` <[float]> y coordinate of the event in CSS pixels.
- `id` ?<[int]> Identifier used to track the touch point between events, must be unique within an event. Optional.
List of touch points for this event. `id` is a unique identifier of a touch point that helps identify it between touch events for the duration of its movement around the surface.