mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
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
58 lines
1.4 KiB
Markdown
58 lines
1.4 KiB
Markdown
---
|
|
sidebar_label: Page.setViewport
|
|
---
|
|
|
|
# Page.setViewport() method
|
|
|
|
`page.setViewport` will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport before navigating to the page.
|
|
|
|
In the case of multiple pages in a single browser, each page can have its own viewport size.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Page {
|
|
setViewport(viewport: Viewport): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ----------------------------------- | ----------- |
|
|
| viewport | [Viewport](./puppeteer.viewport.md) | |
|
|
|
|
**Returns:**
|
|
|
|
Promise<void>
|
|
|
|
## Remarks
|
|
|
|
Argument viewport have following properties:
|
|
|
|
- `width`: page width in pixels. required
|
|
|
|
- `height`: page height in pixels. required
|
|
|
|
- `deviceScaleFactor`: Specify device scale factor (can be thought of as DPR). Defaults to `1`.
|
|
|
|
- `isMobile`: Whether the meta viewport tag is taken into account. Defaults to `false`.
|
|
|
|
- `hasTouch`: Specifies if viewport supports touch events. Defaults to `false`
|
|
|
|
- `isLandScape`: Specifies if viewport is in landscape mode. Defaults to false.
|
|
|
|
NOTE: in certain cases, setting viewport will reload the page in order to set the isMobile or hasTouch properties.
|
|
|
|
## Example
|
|
|
|
```ts
|
|
const page = await browser.newPage();
|
|
await page.setViewport({
|
|
width: 640,
|
|
height: 480,
|
|
deviceScaleFactor: 1,
|
|
});
|
|
await page.goto('https://example.com');
|
|
```
|