0
0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
puppeteer/docs/api/puppeteer.page.emulate.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer ()
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
2022-10-24 09:07:05 +02:00

48 lines
1.0 KiB
Markdown

---
sidebar_label: Page.emulate
---
# Page.emulate() method
Emulates a given device's metrics and user agent.
To aid emulation, Puppeteer provides a list of known devices that can be via [KnownDevices](./puppeteer.knowndevices.md).
#### Signature:
```typescript
class Page {
emulate(device: Device): Promise<void>;
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------- | ----------- |
| device | [Device](./puppeteer.device.md) | |
**Returns:**
Promise&lt;void&gt;
## Remarks
This method will resize the page. A lot of websites don't expect phones to change size, so you should emulate before navigating to the page.
## Example
```ts
import {KnownDevices} from 'puppeteer';
const iPhone = KnownDevices['iPhone 6'];
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.emulate(iPhone);
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
```