thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move emulation documentation under page.emulate method. (#253)

Browse Source
This commit is contained in:
Andrey Lushnikov 2017-08-13 00:47:01 -07:00 committed by GitHub
parent 4269f6a1bb
commit 13e0965407
1 changed files with 20 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/api.md
View File

@ -5,7 +5,6 @@
<!-- toc --> <!-- toc -->
- [Puppeteer](#puppeteer) - [Puppeteer](#puppeteer)
* [Emulation](#emulation)
* [class: Browser](#class-browser) * [class: Browser](#class-browser)
+ [new Browser([options])](#new-browseroptions) + [new Browser([options])](#new-browseroptions)
+ [browser.close()](#browserclose) + [browser.close()](#browserclose)
@ -133,32 +132,6 @@ browser.newPage().then(async page => {
}); });
``` ```
### Emulation
Puppeteer supports device emulation with two primitives:
- [page.setUserAgent(userAgent)](#pagesetuseragentuseragent)
- [page.setViewport(viewport)](#pagesetviewportviewport)
To aid emulation, puppeteer provides a list of device descriptors which could be obtained via the `require('puppeteer/DeviceDescriptors')` command.
Below is an example of emulating iPhone 6 in puppeteer:
```js
const {Browser} = require('puppeteer');
const devices = require('puppeteer/DeviceDescriptors');
const iPhone = devices['iPhone 6'];
const browser = new Browser();
browser.newPage().then(async page => {
await Promise.all([
page.setUserAgent(iPhone.userAgent),
page.setViewport(iPhone.viewport)
]);
await page.goto('https://google.com');
// other actions...
browser.close();
});
```
List of all available devices is available in the source code: [DeviceDescriptors.js](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js).
### class: Browser ### class: Browser
Browser manages a browser instance, creating it with a predefined Browser manages a browser instance, creating it with a predefined
@ -400,7 +373,26 @@ Shortcut for [page.mainFrame().click(selector[, options])](#frameclickselector-o
- `userAgent` <[string]> user agent string - `userAgent` <[string]> user agent string
- returns: <[Promise]> Promise which resolves when emulation is performed. - returns: <[Promise]> Promise which resolves when emulation is performed.
Emulates given device metrics and user agent. Emulates given device metrics and user agent. This method is a shortcut for calling two methods:
- [page.setUserAgent(userAgent)](#pagesetuseragentuseragent)
- [page.setViewport(viewport)](#pagesetviewportviewport)
To aid emulation, puppeteer provides a list of device descriptors which could be obtained via the `require('puppeteer/DeviceDescriptors')` command.
Below is an example of emulating iPhone 6 in puppeteer:
```js
const {Browser} = require('puppeteer');
const devices = require('puppeteer/DeviceDescriptors');
const iPhone = devices['iPhone 6'];
const browser = new Browser();
browser.newPage().then(async page => {
await page.emulate(iPhone);
await page.goto('https://google.com');
// other actions...
browser.close();
});
```
List of all available devices is available in the source code: [DeviceDescriptors.js](https://github.com/GoogleChrome/puppeteer/blob/master/DeviceDescriptors.js).
#### page.evaluate(pageFunction, ...args) #### page.evaluate(pageFunction, ...args)
- `pageFunction` <[function]|[string]> Function to be evaluated in browser context - `pageFunction` <[function]|[string]> Function to be evaluated in browser context