59 lines
1.5 KiB
Markdown
59 lines
1.5 KiB
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Page](./puppeteer.page.md) > [setViewport](./puppeteer.page.setviewport.md)
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
setViewport(viewport: Viewport): Promise<void>;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| viewport | [Viewport](./puppeteer.viewport.md) | |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
|
||
|
|
```js
|
||
|
|
const page = await browser.newPage();
|
||
|
|
await page.setViewport({
|
||
|
|
width: 640,
|
||
|
|
height: 480,
|
||
|
|
deviceScaleFactor: 1,
|
||
|
|
});
|
||
|
|
await page.goto('https://example.com');
|
||
|
|
|
||
|
|
```
|
||
|
|
|