puppeteer/docs/api/puppeteer.page.emulate.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
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

1.0 KiB

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.

Signature:

class Page {
  emulate(device: Device): Promise<void>;
}

Parameters

Parameter Type Description
device Device

Returns:

Promise<void>

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

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();
})();