puppeteer/website/versioned_docs/version-19.3.0/api/puppeteer.page.md

sidebar_label
Page

Page class

Page provides methods to interact with a single tab or extension background page in Chromium.

:::note

One Browser instance might have multiple Page instances.

:::

Signature:

export declare class Page extends EventEmitter

Extends: EventEmitter

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Page class.

Example 1

This example creates a page, navigates it to a URL, and then saves a screenshot:

const puppeteer = require('puppeteer');

(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  await page.goto('https://example.com');
  await page.screenshot({path: 'screenshot.png'});
  await browser.close();
})();

The Page class extends from Puppeteer's EventEmitter class and will emit various events which are documented in the PageEmittedEvents enum.

Example 2

This example logs a message for a single page load event:

page.once('load', () => console.log('Page loaded!'));

To unsubscribe from events use the Page.off() method:

function logRequest(interceptedRequest) {
  console.log('A request was made:', interceptedRequest.url());
}
page.on('request', logRequest);
// Sometime later...
page.off('request', logRequest);

Properties

Property	Modifiers	Type	Description
accessibility	readonly	Accessibility
coverage	readonly	Coverage
keyboard	readonly	Keyboard
mouse	readonly	Mouse
touchscreen	readonly	Touchscreen
tracing	readonly	Tracing

Methods

Method	Modifiers	Description
$(selector)		Runs document.querySelector within the page. If no element matches the selector, the return value resolves to null.
$$(selector)		The method runs document.querySelectorAll within the page. If no elements match the selector, the return value resolves to [].
$$eval(selector, pageFunction, args)		This method runs Array.from(document.querySelectorAll(selector)) within the page and passes the result as the first argument to the pageFunction.
$eval(selector, pageFunction, args)		This method runs document.querySelector within the page and passes the result as the first argument to the pageFunction.
$x(expression)		The method evaluates the XPath expression relative to the page document as its context node. If there are no such elements, the method resolves to an empty array.
addScriptTag(options)		Adds a <script> tag into the page with the desired URL or content.
addStyleTag(options)		Adds a <link rel="stylesheet"> tag into the page with the desired URL or a <style type="text/css"> tag with the content. Shortcut for .
addStyleTag(options)
addStyleTag(options)
authenticate(credentials)		Provide credentials for HTTP authentication.
bringToFront()		Brings page to front (activates tab).
browser()		Get the browser the page belongs to.
browserContext()		Get the browser context that the page belongs to.
click(selector, options)		This method fetches an element with selector, scrolls it into view if needed, and then uses Page.mouse to click in the center of the element. If there's no element matching selector, the method throws an error.
close(options)
content()
cookies(urls)		If no URLs are specified, this method returns cookies for the current page URL. If URLs are specified, only cookies for those URLs are returned.
createPDFStream(options)		Generates a PDF of the page with the print CSS media type.
deleteCookie(cookies)
emulate(device)		Emulates a given device's metrics and user agent. To aid emulation, Puppeteer provides a list of known devices that can be via KnownDevices.
emulateCPUThrottling(factor)		Enables CPU throttling to emulate slow CPUs.
emulateIdleState(overrides)		Emulates the idle state. If no arguments set, clears idle state emulation.
emulateMediaFeatures(features)
emulateMediaType(type)
emulateNetworkConditions(networkConditions)		This does not affect WebSockets and WebRTC PeerConnections (see https://crbug.com/563644). To set the page offline, you can use Page.setOfflineMode(). A list of predefined network conditions can be used by importing PredefinedNetworkConditions.
emulateTimezone(timezoneId)
emulateVisionDeficiency(type)		Simulates the given vision deficiency on the page.
evaluate(pageFunction, args)		Evaluates a function in the page's context and returns the result. If the function passed to page.evaluteHandle returns a Promise, the function will wait for the promise to resolve and return its value.
evaluateHandle(pageFunction, args)
evaluateOnNewDocument(pageFunction, args)		Adds a function which would be invoked in one of the following scenarios: - whenever the page is navigated - whenever the child frame is attached or navigated. In this case, the function is invoked in the context of the newly attached frame. The function is invoked after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.
exposeFunction(name, pptrFunction)		The method adds a function called name on the page's window object. When called, the function executes puppeteerFunction in node.js and returns a Promise which resolves to the return value of puppeteerFunction. If the puppeteerFunction returns a Promise, it will be awaited. :::note Functions installed via page.exposeFunction survive navigations. :::note
focus(selector)		This method fetches an element with selector and focuses it. If there's no element matching selector, the method throws an error.
frames()
getDefaultTimeout()
goBack(options)		This method navigate to the previous page in history.
goForward(options)		This method navigate to the next page in history.
goto(url, options)
hover(selector)		This method fetches an element with selector, scrolls it into view if needed, and then uses Page.mouse to hover over the center of the element. If there's no element matching selector, the method throws an error.
isClosed()		Indicates that the page has been closed.
isDragInterceptionEnabled()
isJavaScriptEnabled()
mainFrame()
metrics()
off(eventName, handler)
on(eventName, handler)		Listen to page events. :::note This method exists to define event typings and handle proper wireup of cooperative request interception. Actual event listening and dispatching is delegated to EventEmitter. :::
once(eventName, handler)
pdf(options)
queryObjects(prototypeHandle)		This method iterates the JavaScript heap and finds all objects with the given prototype.
reload(options)
screenshot(options)
select(selector, values)		Triggers a change and input event once all the provided options have been selected. If there's no <select> element matching selector, the method throws an error.
setBypassCSP(enabled)		Toggles bypassing page's Content-Security-Policy.
setCacheEnabled(enabled)		Toggles ignoring cache for each request based on the enabled state. By default, caching is enabled.
setContent(html, options)
setCookie(cookies)
setDefaultNavigationTimeout(timeout)		This setting will change the default maximum navigation time for the following methods and related shortcuts: - page.goBack(options) - page.goForward(options) - page.goto(url,options) - page.reload(options) - page.setContent(html,options) - page.waitForNavigation(options)
setDefaultTimeout(timeout)
setDragInterception(enabled)
setExtraHTTPHeaders(headers)		The extra HTTP headers will be sent with every request the page initiates. :::tip All HTTP header names are lowercased. (HTTP headers are case-insensitive, so this shouldn’t impact your server code.) ::: :::note page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests. :::
setGeolocation(options)		Sets the page's geolocation.
setJavaScriptEnabled(enabled)
setOfflineMode(enabled)		Sets the network connection to offline. It does not change the parameters used in Page.emulateNetworkConditions()
setRequestInterception(value)		Activating request interception enables HTTPRequest.abort(), HTTPRequest.continue() and HTTPRequest.respond() methods. This provides the capability to modify network requests that are made by a page. Once request interception is enabled, every request will stall unless it's continued, responded or aborted; or completed using the browser cache. Enabling request interception disables page caching. See the Request interception guide for more details.
setUserAgent(userAgent, userAgentMetadata)
setViewport(viewport)		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.
tap(selector)		This method fetches an element with selector, scrolls it into view if needed, and then uses Page.touchscreen to tap in the center of the element. If there's no element matching selector, the method throws an error.
target()
title()
type(selector, text, options)		Sends a keydown, keypress/input, and keyup event for each character in the text. To press a special key, like Control or ArrowDown, use Keyboard.press().
url()
viewport()
waitForFileChooser(options)		This method is typically coupled with an action that triggers file choosing. :::caution This must be called before the file chooser is launched. It will not return a currently active file chooser. :::
waitForFrame(urlOrPredicate, options)
waitForFunction(pageFunction, options, args)		Waits for a function to finish evaluating in the page's context.
waitForNavigation(options)		Waits for the page to navigate to a new URL or to reload. It is useful when you run code that will indirectly cause the page to navigate.
waitForNetworkIdle(options)
waitForRequest(urlOrPredicate, options)
waitForResponse(urlOrPredicate, options)
waitForSelector(selector, options)		Wait for the selector to appear in page. If at the moment of calling the method the selector already exists, the method will return immediately. If the selector doesn't appear after the timeout milliseconds of waiting, the function will throw. This method works across navigations:

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  let currentURL;
  page
    .waitForSelector('img')
    .then(() => console.log('First URL with image: ' + currentURL));
  for (currentURL of [
    'https://example.com',
    'https://google.com',
    'https://bbc.com',
  ]) {
    await page.goto(currentURL);
  }
  await browser.close();
})();

| | waitForTimeout(milliseconds) | | | | waitForXPath(xpath, options) | |

Wait for the xpath to appear in page. If at the moment of calling the method the xpath already exists, the method will return immediately. If the xpath doesn't appear after the timeout milliseconds of waiting, the function will throw.

This method works across navigation

const puppeteer = require('puppeteer');
(async () => {
  const browser = await puppeteer.launch();
  const page = await browser.newPage();
  let currentURL;
  page
    .waitForXPath('//img')
    .then(() => console.log('First URL with image: ' + currentURL));
  for (currentURL of [
    'https://example.com',
    'https://google.com',
    'https://bbc.com',
  ]) {
    await page.goto(currentURL);
  }
  await browser.close();
})();

| | workers() | | |