puppeteer/docs/api/puppeteer.page.emulate.md

71 lines
1.2 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
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).
2022-07-05 13:41:43 +00:00
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Page {
emulate(device: Device): Promise<void>;
2022-07-05 13:41:43 +00:00
}
```
## Parameters
<table><thead><tr><th>
2022-07-05 13:41:43 +00:00
Parameter
</th><th>
Type
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
device
</td><td>
[Device](./puppeteer.device.md)
</td><td>
</td></tr>
</tbody></table>
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;void&gt;
## Remarks
This method is a shortcut for calling two methods: [Page.setUserAgent()](./puppeteer.page.setuseragent.md) and [Page.setViewport()](./puppeteer.page.setviewport.md).
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.
2022-07-05 13:41:43 +00:00
## Example
```ts
import {KnownDevices} from 'puppeteer';
const iPhone = KnownDevices['iPhone 6'];
2022-07-05 13:41:43 +00:00
(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();
})();
```