f07ad2c661
This PR updates the docs regarding configuring puppeteer. In addition, some changes have been made to the documentation generator to show default values on the documentation site. Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
---
|
|
sidebar_label: Mouse.wheel
|
|
---
|
|
|
|
# Mouse.wheel() method
|
|
|
|
Dispatches a `mousewheel` event.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Mouse {
|
|
wheel(options?: MouseWheelOptions): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ----------------------------------------------------- | ----------------------------------------------------------- |
|
|
| options | [MouseWheelOptions](./puppeteer.mousewheeloptions.md) | <i>(Optional)</i> Optional: <code>MouseWheelOptions</code>. |
|
|
|
|
**Returns:**
|
|
|
|
Promise<void>
|
|
|
|
## Example
|
|
|
|
An example of zooming into an element:
|
|
|
|
```ts
|
|
await page.goto(
|
|
'https://mdn.mozillademos.org/en-US/docs/Web/API/Element/wheel_event$samples/Scaling_an_element_via_the_wheel?revision=1587366'
|
|
);
|
|
|
|
const elem = await page.$('div');
|
|
const boundingBox = await elem.boundingBox();
|
|
await page.mouse.move(
|
|
boundingBox.x + boundingBox.width / 2,
|
|
boundingBox.y + boundingBox.height / 2
|
|
);
|
|
|
|
await page.mouse.wheel({deltaY: -100});
|
|
```
|