class: Page

Page provides methods to interact with a single tab in a Browser, or an extension background page in Chromium. One Browser instance might have multiple Page instances.

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

  1. const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
  3. (async () => {
  4.   const browser = await webkit.launch();
  5.   const context = await browser.newContext();
  6.   const page = await context.newPage();
  7.   await page.goto('https://example.com');
  8.   await page.screenshot({path: 'screenshot.png'});
  9.   await browser.close();
  10. })();

The Page class emits various events (described below) which can be handled using any of Node’s native EventEmitter methods, such as on, once or removeListener.

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

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

To unsubscribe from events use the removeListener method:

  1. function logRequest(interceptedRequest) {
  2.   console.log('A request was made:', interceptedRequest.url());
  3. }
  4. page.on('request', logRequest);
  5. // Sometime later...
  6. page.removeListener('request', logRequest);

event: ‘close’

Emitted when the page closes.

event: ‘console’

Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir. Also emitted if the page throws an error or a warning.

The arguments passed into console.log appear as arguments on the event handler.

An example of handling console event:

  1. page.on('console', msg => {
  2.   for (let i = 0; i < msg.args().length; ++i)
  3.     console.log(`${i}: ${msg.args()[i]}`);
  4. });
  5. page.evaluate(() => console.log('hello', 5, {foo: 'bar'}));

event: ‘crash’

Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory.

event: ‘dialog’

Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Playwright can respond to the dialog via Dialog‘s accept or dismiss methods.

event: ‘domcontentloaded’

Emitted when the JavaScript DOMContentLoaded event is dispatched.

event: ‘download’

Emitted when attachment download started. User can access basic file operations on downloaded content via the passed Download instance.

NOTE Browser context must be created with the acceptDownloads set to true when user needs access to the downloaded content. If acceptDownloads is not set or set to false, download events are emitted, but the actual download is not performed and user has no access to the downloaded files.

event: ‘filechooser’

Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>. Playwright can respond to it via setting the input files using fileChooser.setFiles that can be uploaded after that.

  1. page.on('filechooser', async (fileChooser) => {
  2.   await fileChooser.setFiles('/tmp/myfile.pdf');
  3. });

event: ‘frameattached’

Emitted when a frame is attached.

event: ‘framedetached’

Emitted when a frame is detached.

event: ‘framenavigated’

Emitted when a frame is navigated to a new url.

event: ‘load’

Emitted when the JavaScript load event is dispatched.

event: ‘pageerror’

  • <Error> The exception message

Emitted when an uncaught exception happens within the page.

event: ‘popup’

  • <Page> Page corresponding to “popup” window

Emitted when the page opens a new tab or window. This event is emitted in addition to the browserContext.on('page'), but only for popups relevant to this page.

The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to “http://example.com“ is done and its response has started loading in the popup.

  1. const [popup] = await Promise.all([
  2.   page.waitForEvent('popup'),
  3.   page.evaluate(() => window.open('https://example.com')),
  4. ]);
  5. console.log(await popup.evaluate('location.href'));

NOTE Use page.waitForLoadState([state[, options]]) to wait until the page gets to a particular state (you should not need it in most cases).

event: ‘request’

Emitted when a page issues a request. The request object is read-only. In order to intercept and mutate requests, see page.route() or browserContext.route().

event: ‘requestfailed’

Emitted when a request fails, for example by timing out.

NOTE HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with 'requestfinished' event and not with 'requestfailed'.

event: ‘requestfinished’

Emitted when a request finishes successfully.

event: ‘response’

Emitted when a response is received.

event: ‘worker’

Emitted when a dedicated WebWorker is spawned by the page.

page.$(selector)

The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null.

Shortcut for page.mainFrame().$(selector).

page.$$(selector)

The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to [].

Shortcut for page.mainFrame().$$(selector).

page.$eval(selector, pageFunction[, arg])

The method finds an element matching the specified selector within the page and passes it as a first argument to pageFunction. If no elements match the selector, the method throws an error.

If pageFunction returns a Promise, then page.$eval would wait for the promise to resolve and return its value.

Examples:

  1. const searchValue = await page.$eval('#search', el => el.value);
  2. const preloadHref = await page.$eval('link[rel=preload]', el => el.href);
  3. const html = await page.$eval('.main-container', (e, suffix) => e.outerHTML + suffix, 'hello');

Shortcut for page.mainFrame().$eval(selector, pageFunction).

page.$$eval(selector, pageFunction[, arg])

The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction.

If pageFunction returns a Promise, then page.$$eval would wait for the promise to resolve and return its value.

Examples:

  1. const divsCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);

page.accessibility

page.addInitScript(script[, arg])

Adds a script which would be evaluated in one of the following scenarios:

  • Whenever the page is navigated.
  • Whenever the child frame is attached or navigated. In this case, the scritp is evaluated in the context of the newly attached frame.

The script is evaluated 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.

An example of overriding Math.random before the page loads:

  1. // preload.js
  2. Math.random = () => 42;
  4. // In your playwright script, assuming the preload.js file is in same folder
  5. const preloadFile = fs.readFileSync('./preload.js', 'utf8');
  6. await page.addInitScript(preloadFile);

NOTE The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.

page.addScriptTag(options)

  • options <Object>
    • url <string> URL of a script to be added.
    • path <string> Path to the JavaScript file to be injected into frame. If path is a relative path, then it is resolved relative to current working directory.
    • content <string> Raw JavaScript content to be injected into frame.
    • type <string> Script type. Use ‘module’ in order to load a Javascript ES6 module. See script for more details.
  • returns: <Promise<ElementHandle>> which resolves to the added tag when the script’s onload fires or when the script content was injected into frame.

Adds a <script> tag into the page with the desired url or content.

Shortcut for page.mainFrame().addScriptTag(options).

page.addStyleTag(options)

  • options <Object>
    • url <string> URL of the <link> tag.
    • path <string> Path to the CSS file to be injected into frame. If path is a relative path, then it is resolved relative to current working directory.
    • content <string> Raw CSS content to be injected into frame.
  • returns: <Promise<ElementHandle>> which resolves to the added tag when the stylesheet’s onload fires or when the CSS content was injected into frame.

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 page.mainFrame().addStyleTag(options).

page.check(selector, [options])

  • selector <string> A selector to search for checkbox or radio button to check. If there are multiple elements satisfying the selector, the first will be checked. See working with selectors for more details.
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. By default actions wait until the element is:
      • displayed: has non-empty bounding box and no visibility:hidden (note that elements of zero size or with display:none are considered not displayed),
      • is not moving (for example, css transition has finished),
      • receives pointer events at the action point (for example, element is not covered by other elements). Even if the action is forced, it will wait for the element matching selector to be in the DOM. Defaults to false.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully checked. The Promise will be rejected if there is no element matching selector.

This method fetches an element with selector, if element is not already checked, it scrolls it into view if needed, and then uses page.click to click in the center of the element. If there’s no element matching selector, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.

Shortcut for page.mainFrame().check(selector[, options]).

page.click(selector[, options])

  • selector <string> A selector to search for element to click. If there are multiple elements satisfying the selector, the first will be clicked. See working with selectors for more details.
  • options <Object>
    • button <”left”|”right”|”middle”> Defaults to left.
    • clickCount <number> defaults to 1. See UIEvent.detail.
    • delay <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
    • position <Object> A point to click relative to the top-left corner of element padding box. If not specified, clicks to some visible point of the element.
    • modifiers <Array<”Alt”|”Control”|”Meta”|”Shift”>> Modifier keys to press. Ensures that only these modifiers are pressed during the click, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
    • force <boolean> Whether to bypass the actionability checks. By default actions wait until the element is:
      • displayed: has non-empty bounding box and no visibility:hidden (note that elements of zero size or with display:none are considered not displayed),
      • is not moving (for example, css transition has finished),
      • receives pointer events at the action point (for example, element is not covered by other elements). Even if the action is forced, it will wait for the element matching selector to be in the DOM. Defaults to false.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully clicked. The Promise will be rejected if there is no element matching selector.

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 waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.

Shortcut for page.mainFrame().click(selector[, options]).

page.close([options])

By default, page.close() does not run beforeunload handlers.

NOTE if runBeforeUnload is passed as true, a beforeunload dialog might be summoned and should be handled manually via page’s ‘dialog’ event.

page.content()

Gets the full HTML contents of the page, including the doctype.

page.context()

Get the browser context that the page belongs to.

page.coverage

Browser-specific Coverage implementation, only available for Chromium atm. See ChromiumCoverage for more details.

page.dblclick(selector[, options])

  • selector <string> A selector to search for element to double click. If there are multiple elements satisfying the selector, the first will be double clicked. See working with selectors for more details.
  • options <Object>
    • button <”left”|”right”|”middle”> Defaults to left.
    • delay <number> Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.
    • position <Object> A point to double click relative to the top-left corner of element padding box. If not specified, double clicks to some visible point of the element.
    • modifiers <Array<”Alt”|”Control”|”Meta”|”Shift”>> Modifier keys to press. Ensures that only these modifiers are pressed during the double click, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
    • force <boolean> Whether to bypass the actionability checks. By default actions wait until the element is:
      • displayed: has non-empty bounding box and no visibility:hidden (note that elements of zero size or with display:none are considered not displayed),
      • is not moving (for example, css transition has finished),
      • receives pointer events at the action point (for example, element is not covered by other elements). Even if the action is forced, it will wait for the element matching selector to be in the DOM. Defaults to false.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully double clicked. The Promise will be rejected if there is no element matching selector.

This method fetches an element with selector, scrolls it into view if needed, and then uses page.mouse to double click in the center of the element. If there’s no element matching selector, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.

Bear in mind that if the first click of the dblclick() triggers a navigation event, there will be an exception.

NOTE page.dblclick() dispatches two click events and a single dblclick event.

Shortcut for page.mainFrame().dblclick(selector[, options]).

page.dispatchEvent(selector, type[, eventInit, options])

The snippet below dispatches the click event on the element. Regardless of the visibility state of the elment, click is dispatched. This is equivalend to calling element.click().

  1. await page.dispatchEvent('button#submit', 'click');

Under the hood, it creates an instance of an event based on the given type, initializes it with eventInit properties and dispatches it on the element. Events are composed, cancelable and bubble by default.

Since eventInit is event-specific, please refer to the events documentation for the lists of initial properties:

You can also specify JSHandle as the property value if you want live objects to be passed into the event:

  1. // Note you can only create DataTransfer in Chromium and Firefox
  2. const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
  3. await page.dispatchEvent('#source', 'dragstart', { dataTransfer });

page.emulateMedia(options)

  • options <Object>
    • media <”screen”|”print”> Changes the CSS media type of the page. The only allowed values are 'screen', 'print' and null. Passing null disables CSS media emulation.
    • colorScheme <”dark”|”light”|”no-preference”> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'.
  • returns: <Promise>
  1. await page.evaluate(() => matchMedia('screen').matches);
  2. // → true
  3. await page.evaluate(() => matchMedia('print').matches);
  4. // → false
  6. await page.emulateMedia({ media: 'print' });
  7. await page.evaluate(() => matchMedia('screen').matches);
  8. // → false
  9. await page.evaluate(() => matchMedia('print').matches);
  10. // → true
  12. await page.emulateMedia({});
  13. await page.evaluate(() => matchMedia('screen').matches);
  14. // → true
  15. await page.evaluate(() => matchMedia('print').matches);
  16. // → false
  1. await page.emulateMedia({ colorScheme: 'dark' }] });
  2. await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
  3. // → true
  4. await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
  5. // → false
  6. await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
  7. // → false

page.evaluate(pageFunction[, arg])

If the function passed to the page.evaluate returns a Promise, then page.evaluate would wait for the promise to resolve and return its value.

If the function passed to the page.evaluate returns a non-Serializable value, then page.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals.

Passing argument to pageFunction:

  1. const result = await page.evaluate(([x, y]) => {
  2.   return Promise.resolve(x * y);
  3. }, [7, 8]);
  4. console.log(result); // prints "56"

A string can also be passed in instead of a function:

  1. console.log(await page.evaluate('1 + 2')); // prints "3"
  2. const x = 10;
  3. console.log(await page.evaluate(`1 + ${x}`)); // prints "11"

ElementHandle instances can be passed as an argument to the page.evaluate:

  1. const bodyHandle = await page.$('body');
  2. const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
  3. await bodyHandle.dispose();

Shortcut for page.mainFrame().evaluate(pageFunction[, arg]).

page.evaluateHandle(pageFunction[, arg])

  • pageFunction <function|string> Function to be evaluated in the page context
  • arg <Serializable|JSHandle> Optional argument to pass to pageFunction
  • returns: <Promise<JSHandle>> Promise which resolves to the return value of pageFunction as in-page object (JSHandle)

The only difference between page.evaluate and page.evaluateHandle is that page.evaluateHandle returns in-page object (JSHandle).

If the function passed to the page.evaluateHandle returns a Promise, then page.evaluateHandle would wait for the promise to resolve and return its value.

A string can also be passed in instead of a function:

  1. const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'

JSHandle instances can be passed as an argument to the page.evaluateHandle:

  1. const aHandle = await page.evaluateHandle(() => document.body);
  2. const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
  3. console.log(await resultHandle.jsonValue());
  4. await resultHandle.dispose();

page.exposeBinding(name, playwrightBinding)

  • name <string> Name of the function on the window object.
  • playwrightBinding <function> Callback function that will be called in the Playwright’s context.
  • returns: <Promise>

The method adds a function called name on the window object of every frame in this page. When called, the function executes playwrightBinding in Node.js and returns a Promise which resolves to the return value of playwrightBinding. If the playwrightBinding returns a Promise, it will be awaited.

The first argument of the playwrightBinding function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.

See browserContext.exposeBinding(name, playwrightBinding) for the context-wide version.

NOTE Functions installed via page.exposeBinding survive navigations.

An example of exposing page URL to all frames in a page:

  1. const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
  3. (async () => {
  4.   const browser = await webkit.launch({ headless: false });
  5.   const context = await browser.newContext();
  6.   const page = await context.newPage();
  7.   await page.exposeBinding('pageURL', ({ page }) => page.url());
  8.   await page.setContent(`
  9.     <script>
  10.       async function onClick() {
  11.         document.querySelector('div').textContent = await window.pageURL();
  12.       }
  13.     </script>
  14.     <button onclick="onClick()">Click me</button>
  15.     <div></div>
  16.   `);
  17.   await page.click('button');
  18. })();

page.exposeFunction(name, playwrightFunction)

  • name <string> Name of the function on the window object
  • playwrightFunction <function> Callback function which will be called in Playwright’s context.
  • returns: <Promise>

The method adds a function called name on the window object of every frame in the page. When called, the function executes playwrightFunction in Node.js and returns a Promise which resolves to the return value of playwrightFunction.

If the playwrightFunction returns a Promise, it will be awaited.

See browserContext.exposeFunction(name, playwrightFunction) for context-wide exposed function.

NOTE Functions installed via page.exposeFunction survive navigations.

An example of adding an md5 function to the page:

  1. const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
  2. const crypto = require('crypto');
  4. (async () => {
  5.   const browser = await webkit.launch({ headless: false });
  6.   const page = await browser.newPage();
  7.   await page.exposeFunction('md5', text => crypto.createHash('md5').update(text).digest('hex'));
  8.   await page.setContent(`
  9.     <script>
  10.       async function onClick() {
  11.         document.querySelector('div').textContent = await window.md5('PLAYWRIGHT');
  12.       }
  13.     </script>
  14.     <button onclick="onClick()">Click me</button>
  15.     <div></div>
  16.   `);
  17.   await page.click('button');
  18. })();

An example of adding a window.readfile function to the page:

  1. const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
  2. const fs = require('fs');
  4. (async () => {
  5.   const browser = await chromium.launch();
  6.   const page = await browser.newPage();
  7.   page.on('console', msg => console.log(msg.text()));
  8.   await page.exposeFunction('readfile', async filePath => {
  9.     return new Promise((resolve, reject) => {
  10.       fs.readFile(filePath, 'utf8', (err, text) => {
  11.         if (err)
  12.           reject(err);
  13.         else
  14.           resolve(text);
  15.       });
  16.     });
  17.   });
  18.   await page.evaluate(async () => {
  19.     // use window.readfile to read contents of a file
  20.     const content = await window.readfile('/etc/hosts');
  21.     console.log(content);
  22.   });
  23.   await browser.close();
  24. })();

page.fill(selector, value[, options])

  • selector <string> A selector to query page for. See working with selectors for more details.
  • value <string> Value to fill for the <input>, <textarea> or [contenteditable] element.
  • options <Object>
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully filled. The promise will be rejected if there is no element matching selector.

This method focuses the element and triggers an input event after filling. If there’s no text <input>, <textarea> or [contenteditable] element matching selector, the method throws an error. Note that you can pass an empty string to clear the input field.

To send fine-grained keyboard events, use page.type.

Shortcut for page.mainFrame().fill()

page.focus(selector[, options])

  • selector <string> A selector of an element to focus. If there are multiple elements satisfying the selector, the first will be focused. See working with selectors for more details.
  • options <Object>
  • returns: <Promise> Promise which resolves when the element matching selector is successfully focused. The promise will be rejected if there is no element matching selector.

This method fetches an element with selector and focuses it. If there’s no element matching selector, the method waits until a matching element appears in the DOM.

Shortcut for page.mainFrame().focus(selector).

page.frame(options)

  • options <string|Object> Frame name or other frame lookup options.
    • name <string> frame name specified in the iframe‘s name attribute
    • url <string|RegExp|Function> A glob pattern, regex pattern or predicate receiving frame’s url as a URL object.
  • returns: <?Frame> frame matching the criteria. Returns null if no frame matches.
  1. const frame = page.frame('frame-name');
  1. const frame = page.frame({ url: /.*domain.*/ });

Returns frame matching the specified criteria. Either name or url must be specified.

page.frames()

  • returns: <Array<Frame>> An array of all frames attached to the page.

page.getAttribute(selector, name[, options])

Returns element attribute value.

page.goBack([options])

  • options <Object> Navigation parameters which might have the following properties:
  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go back, resolves to null.

Navigate to the previous page in history.

page.goForward([options])

  • options <Object> Navigation parameters which might have the following properties:
  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go forward, resolves to null.

Navigate to the next page in history.

page.goto(url[, options])

  • url <string> URL to navigate page to. The url should include scheme, e.g. https://.
  • options <Object> Navigation parameters which might have the following properties:
  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

page.goto will throw an error if:

  • there’s an SSL error (e.g. in case of self-signed certificates).
  • target URL is invalid.
  • the timeout is exceeded during navigation.
  • the remote server does not respond or is unreachable.
  • the main resource failed to load.

page.goto will not throw an error when any valid HTTP status code is returned by the remote server, including 404 “Not Found” and 500 “Internal Server Error”. The status code for such responses can be retrieved by calling response.status().

NOTE page.goto either throws an error or returns a main resource response. The only exceptions are navigation to about:blank or navigation to the same URL with a different hash, which would succeed and return null.

NOTE Headless mode doesn’t support navigation to a PDF document. See the upstream issue.

Shortcut for page.mainFrame().goto(url[, options])

page.hover(selector[, options])

  • selector <string> A selector to search for element to hover. If there are multiple elements satisfying the selector, the first will be hovered. See working with selectors for more details.
  • options <Object>
    • position <Object> A point to hover relative to the top-left corner of element padding box. If not specified, hovers over some visible point of the element.
    • modifiers <Array<”Alt”|”Control”|”Meta”|”Shift”>> Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
    • force <boolean> Whether to bypass the actionability checks. By default actions wait until the element is:
      • displayed: has non-empty bounding box and no visibility:hidden (note that elements of zero size or with display:none are considered not displayed),
      • is not moving (for example, css transition has finished),
      • receives pointer events at the action point (for example, element is not covered by other elements). Even if the action is forced, it will wait for the element matching selector to be in the DOM. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully hovered. Promise gets rejected if there’s no element matching 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 waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.

Shortcut for page.mainFrame().hover(selector[, options]).

page.innerHTML(selector[, options])

Resolves to the element.innerHTML.

page.innerText(selector[, options])

Resolves to the element.innerText.

page.isClosed()

Indicates that the page has been closed.

page.keyboard

page.mainFrame()

  • returns: <Frame> The page’s main frame.

Page is guaranteed to have a main frame which persists during navigations.

page.mouse

page.opener()

  • returns: <Promise<?Page>> Promise which resolves to the opener for popup pages and null for others. If the opener has been closed already the promise may resolve to null.

page.pdf([options])

  • options <Object> Options object which might have the following properties:
    • path <string> The file path to save the PDF to. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the PDF won’t be saved to the disk.
    • scale <number> Scale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.
    • displayHeaderFooter <boolean> Display header and footer. Defaults to false.
    • headerTemplate <string> HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
      • 'date' formatted print date
      • 'title' document title
      • 'url' document location
      • 'pageNumber' current page number
      • 'totalPages' total pages in the document
    • footerTemplate <string> HTML template for the print footer. Should use the same format as the headerTemplate.
    • printBackground <boolean> Print background graphics. Defaults to false.
    • landscape <boolean> Paper orientation. Defaults to false.
    • pageRanges <string> Paper ranges to print, e.g., ‘1-5, 8, 11-13’. Defaults to the empty string, which means print all pages.
    • format <string> Paper format. If set, takes priority over width or height options. Defaults to ‘Letter’.
    • width <string|number> Paper width, accepts values labeled with units.
    • height <string|number> Paper height, accepts values labeled with units.
    • margin <Object> Paper margins, defaults to none.
      • top <string|number> Top margin, accepts values labeled with units. Defaults to 0.
      • right <string|number> Right margin, accepts values labeled with units. Defaults to 0.
      • bottom <string|number> Bottom margin, accepts values labeled with units. Defaults to 0.
      • left <string|number> Left margin, accepts values labeled with units. Defaults to 0.
    • preferCSSPageSize <boolean> Give any CSS @page size declared in the page priority over what is declared in width and height or format options. Defaults to false, which will scale the content to fit the paper size.
  • returns: <Promise<Buffer>> Promise which resolves with PDF buffer.

NOTE Generating a pdf is currently only supported in Chromium headless.

page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia({ media: ‘screen’ }) before calling page.pdf():

NOTE By default, page.pdf() generates a pdf with modified colors for printing. Use the -webkit-print-color-adjust property to force rendering of exact colors.

  1. // Generates a PDF with 'screen' media type.
  2. await page.emulateMedia({media: 'screen'});
  3. await page.pdf({path: 'page.pdf'});

The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.

A few examples:

  • page.pdf({width: 100}) - prints with width set to 100 pixels
  • page.pdf({width: '100px'}) - prints with width set to 100 pixels
  • page.pdf({width: '10cm'}) - prints with width set to 10 centimeters.

All possible units are:

  • px - pixel
  • in - inch
  • cm - centimeter
  • mm - millimeter

The format options are:

  • Letter: 8.5in x 11in
  • Legal: 8.5in x 14in
  • Tabloid: 11in x 17in
  • Ledger: 17in x 11in
  • A0: 33.1in x 46.8in
  • A1: 23.4in x 33.1in
  • A2: 16.54in x 23.4in
  • A3: 11.7in x 16.54in
  • A4: 8.27in x 11.7in
  • A5: 5.83in x 8.27in
  • A6: 4.13in x 5.83in

NOTE headerTemplate and footerTemplate markup have the following limitations:

  1. Script tags inside templates are not evaluated.
  2. Page styles are not visible inside templates.

page.press(selector, key[, options])

  • selector <string> A selector of an element to type into. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.
  • key <string> Name of the key to press or a character to generate, such as ArrowLeft or a.
  • options <Object>
    • delay <number> Time to wait between keydown and keyup in milliseconds. Defaults to 0.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise>

Focuses the element, and then uses keyboard.down and keyboard.up.

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrayRight, ArrowUp, etc.

Following modification shortcuts are also suported: Shift, Control, Alt, Meta, ShiftLeft.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

  1. const page = await browser.newPage();
  2. await page.goto('https://keycode.info');
  3. await page.press('body', 'A');
  4. await page.screenshot({ path: 'A.png' });
  5. await page.press('body', 'ArrowLeft');
  6. await page.screenshot({ path: 'ArrowLeft.png' });
  7. await page.press('body', 'Shift+O');
  8. await page.screenshot({ path: 'O.png' });
  9. await browser.close();

page.reload([options])

  • options <Object> Navigation parameters which might have the following properties:
  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

page.route(url, handler)

Routing provides the capability to modify network requests that are made by a page.

Once routing is enabled, every request matching the url pattern will stall unless it’s continued, fulfilled or aborted.

An example of a naïve handler that aborts all image requests:

  1. const page = await browser.newPage();
  2. await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
  3. await page.goto('https://example.com');
  4. await browser.close();

or the same snippet using a regex pattern instead:

  1. const page = await browser.newPage();
  2. await page.route(/(\.png$)|(\.jpg$)/, route => route.abort());
  3. await page.goto('https://example.com');
  4. await browser.close();

Page routes take precedence over browser context routes (set up with browserContext.route(url, handler)) when request matches both handlers.

NOTE Enabling routing disables http cache.

page.screenshot([options])

  • options <Object> Options object which might have the following properties:
    • path <string> The file path to save the image to. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, the image won’t be saved to the disk.
    • type <”png”|”jpeg”> Specify screenshot type, defaults to png.
    • quality <number> The quality of the image, between 0-100. Not applicable to png images.
    • fullPage <boolean> When true, takes a screenshot of the full scrollable page, instead of the currently visibvle viewport. Defaults to false.
    • clip <Object> An object which specifies clipping of the resulting image. Should have the following fields:
      • x <number> x-coordinate of top-left corner of clip area
      • y <number> y-coordinate of top-left corner of clip area
      • width <number> width of clipping area
      • height <number> height of clipping area
    • omitBackground <boolean> Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. Defaults to false.
  • returns: <Promise<Buffer>> Promise which resolves to buffer with the captured screenshot.

NOTE Screenshots take at least 1/6 second on Chromium OS X and Chromium Windows. See https://crbug.com/741689 for discussion.

page.selectOption(selector, values[, options])

  • selector <string> A selector to query page for. See working with selectors for more details.
  • values <string|ElementHandle|Array<string>|Object|Array<ElementHandle>|Array<Object>> Options to select. If the <select> has the multiple attribute, all matching options are selected, otherwise only the first option matching one of the passed options is selected. String values are equivalent to {value:'string'}. Option is considered matching if all specified properties match.
    • value <string> Matches by option.value.
    • label <string> Matches by option.label.
    • index <number> Matches by the index.
  • options <Object>
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise<Array<string>>> An array of option values that have been successfully selected.

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.

  1. // single selection matching the value
  2. page.selectOption('select#colors', 'blue');
  4. // single selection matching both the value and the label
  5. page.selectOption('select#colors', { label: 'Blue' });
  7. // multiple selection
  8. page.selectOption('select#colors', ['red', 'green', 'blue']);

Shortcut for page.mainFrame().selectOption()

page.setContent(html[, options])

  • html <string> HTML markup to assign to the page.
  • options <Object> Parameters which might have the following properties:
    • timeout <number> Maximum time in milliseconds for resources to load, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout), browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
    • waitUntil <”load”|”domcontentloaded”|”networkidle”> When to consider setting markup succeeded, defaults to load. Given an array of event strings, setting content is considered to be successful after all events have been fired. Events can be either:
      • 'load' - consider setting content to be finished when the load event is fired.
      • 'domcontentloaded' - consider setting content to be finished when the DOMContentLoaded event is fired.
      • 'networkidle' - consider setting content to be finished when there are no network connections for at least 500 ms.
  • returns: <Promise>

page.setDefaultNavigationTimeout(timeout)

  • timeout <number> Maximum navigation time in milliseconds

This setting will change the default maximum navigation time for the following methods and related shortcuts:

NOTE page.setDefaultNavigationTimeout takes priority over page.setDefaultTimeout, browserContext.setDefaultTimeout and browserContext.setDefaultNavigationTimeout.

page.setDefaultTimeout(timeout)

  • timeout <number> Maximum time in milliseconds

This setting will change the default maximum time for all the methods accepting timeout option.

NOTE page.setDefaultNavigationTimeout takes priority over page.setDefaultTimeout.

page.setExtraHTTPHeaders(headers)

  • headers <Object<string, string>> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
  • returns: <Promise>

The extra HTTP headers will be sent with every request the page initiates.

NOTE page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests.

page.setInputFiles(selector, files[, options])

This method expects selector to point to an input element.

Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the current working directory. For empty array, clears the selected files.

page.setViewportSize(viewportSize)

  • viewportSize <Object>
    • width <number> page width in pixels. required
    • height <number> page height in pixels. required
  • returns: <Promise>

In the case of multiple pages in a single browser, each page can have its own viewport size. However, browser.newContext([options]) allows to set viewport size (and more) for all pages in the context at once.

page.setViewportSize will resize the page. A lot of websites don’t expect phones to change size, so you should set the viewport size before navigating to the page.

  1. const page = await browser.newPage();
  2. await page.setViewportSize({
  3.   width: 640,
  4.   height: 480,
  5. });
  6. await page.goto('https://example.com');

page.textContent(selector[, options])

Resolves to the element.textContent.

page.title()

Shortcut for page.mainFrame().title().

page.type(selector, text[, options])

  • selector <string> A selector of an element to type into. If there are multiple elements satisfying the selector, the first will be used. See working with selectors for more details.
  • text <string> A text to type into a focused element.
  • options <Object>
    • delay <number> Time to wait between key presses in milliseconds. Defaults to 0.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise>

Sends a keydown, keypress/input, and keyup event for each character in the text. page.type can be used to send fine-grained keyboard events. To fill values in form fields, use page.fill.

To press a special key, like Control or ArrowDown, use keyboard.press.

  1. await page.type('#mytextarea', 'Hello'); // Types instantly
  2. await page.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user

Shortcut for page.mainFrame().type(selector, text[, options]).

page.uncheck(selector, [options])

  • selector <string> A selector to search for uncheckbox to check. If there are multiple elements satisfying the selector, the first will be checked. See working with selectors for more details.
  • options <Object>
    • force <boolean> Whether to bypass the actionability checks. By default actions wait until the element is:
      • displayed: has non-empty bounding box and no visibility:hidden (note that elements of zero size or with display:none are considered not displayed),
      • is not moving (for example, css transition has finished),
      • receives pointer events at the action point (for example, element is not covered by other elements). Even if the action is forced, it will wait for the element matching selector to be in the DOM. Defaults to false.
    • noWaitAfter <boolean> Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to false.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise> Promise which resolves when the element matching selector is successfully unchecked. The Promise will be rejected if there is no element matching selector.

This method fetches an element with selector, if element is not already unchecked, it scrolls it into view if needed, and then uses page.click to click in the center of the element. If there’s no element matching selector, the method waits until a matching element appears in the DOM. If the element is detached during the actionability checks, the action is retried.

Shortcut for page.mainFrame().uncheck(selector[, options]).

page.unroute(url[, handler])

Removes a route created with page.route(url, handler). When handler is not specified, removes all routes for the url.

page.url()

This is a shortcut for page.mainFrame().url()

page.viewportSize()

  • returns: <?Object>
    • width <number> page width in pixels.
    • height <number> page height in pixels.

page.waitForEvent(event[, optionsOrPredicate])

  • event <string> Event name, same one would pass into page.on(event).
  • optionsOrPredicate <Function|Object> Either a predicate that receives an event or an options object.
  • returns: <Promise<Object>> Promise which resolves to the event data value.

Waits for event to fire and passes its value into the predicate function. Resolves when the predicate returns truthy value. Will throw an error if the page is closed before the event is fired.

page.waitForFunction(pageFunction[, arg, options])

  • pageFunction <function|string> Function to be evaluated in browser context
  • arg <Serializable|JSHandle> Optional argument to pass to pageFunction
  • options <Object> Optional waiting parameters
    • polling <number|”raf”> If polling is 'raf', then pageFunction is constantly executed in requestAnimationFrame callback. If polling is a number, then it is treated as an interval in milliseconds at which the function would be executed. Defaults to raf.
    • timeout <number> maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the page.setDefaultTimeout(timeout) method.
  • returns: <Promise<JSHandle>> Promise which resolves when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.

The waitForFunction can be used to observe viewport size change:

  1. const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
  3. (async () => {
  4.   const browser = await webkit.launch();
  5.   const page = await browser.newPage();
  6.   const watchDog = page.waitForFunction('window.innerWidth < 100');
  7.   await page.setViewportSize({width: 50, height: 50});
  8.   await watchDog;
  9.   await browser.close();
  10. })();

To pass an argument from Node.js to the predicate of page.waitForFunction function:

  1. const selector = '.foo';
  2. await page.waitForFunction(selector => !!document.querySelector(selector), selector);

Shortcut for [page.mainFrame().waitForFunction(pageFunction, arg, options]])](#framewaitforfunctionpagefunction-arg-options).

page.waitForLoadState([state[, options]])

This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.

  1. await page.click('button'); // Click triggers navigation.
  2. await page.waitForLoadState(); // The promise resolves after 'load' event.
  1. const [popup] = await Promise.all([
  2.   page.waitForEvent('popup'),
  3.   page.click('button'), // Click triggers a popup.
  4. ])
  5. await popup.waitForLoadState('domcontentloaded'); // The promise resolves after 'domcontentloaded' event.
  6. console.log(await popup.title()); // Popup is ready to use.

Shortcut for page.mainFrame().waitForLoadState([options]).

page.waitForNavigation([options])

  • options <Object> Navigation parameters which might have the following properties:
  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. In case of navigation to a different anchor or navigation due to History API usage, the navigation will resolve with null.

This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly cause the page to navigate. Consider this example:

  1. const [response] = await Promise.all([
  2.   page.waitForNavigation(), // The promise resolves after navigation has finished
  3.   page.click('a.my-link'), // Clicking the link will indirectly cause a navigation
  4. ]);

NOTE Usage of the History API to change the URL is considered a navigation.

Shortcut for page.mainFrame().waitForNavigation(options).

page.waitForRequest(urlOrPredicate[, options])

  1. const firstRequest = await page.waitForRequest('http://example.com/resource');
  2. const finalRequest = await page.waitForRequest(request => request.url() === 'http://example.com' && request.method() === 'GET');
  3. return firstRequest.url();
  1. await page.waitForRequest(request => request.url().searchParams.get('foo') === 'bar' && request.url().searchParams.get('foo2') === 'bar2');

page.waitForResponse(urlOrPredicate[, options])

  1. const firstResponse = await page.waitForResponse('https://example.com/resource');
  2. const finalResponse = await page.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);
  3. return finalResponse.ok();

page.waitForSelector(selector[, options])

  • selector <string> A selector of an element to wait for. See working with selectors for more details.
  • options <Object>
    • state <”attached”|”detached”|”visible”|”hidden”> Defaults to 'visible'. Can be either:
      • 'attached' - wait for element to be present in DOM.
      • 'detached' - wait for element to not be present in DOM.
      • 'visible' - wait for element to have non-empty bounding box and no visibility:hidden. Note that element without any content or with display:none has an empty bounding box and is not considered visible.
      • 'hidden' - wait for element to be either detached from DOM, or have an empty bounding box or visibility:hidden. This is opposite to the 'visible' option.
    • timeout <number> Maximum time in milliseconds, defaults to 30 seconds, pass 0 to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
  • returns: <Promise<?ElementHandle>> Promise which resolves when element specified by selector satisfies state option. Resolves to null if waiting for hidden or detached.

Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn’t satisfy the condition for the timeout milliseconds, the function will throw.

This method works across navigations:

  1. const { chromium } = require('playwright');  // Or 'firefox' or 'webkit'.
  3. (async () => {
  4.   const browser = await chromium.launch();
  5.   const page = await browser.newPage();
  6.   let currentURL;
  7.   page
  8.     .waitForSelector('img')
  9.     .then(() => console.log('First URL with image: ' + currentURL));
  10.   for (currentURL of ['https://example.com', 'https://google.com', 'https://bbc.com']) {
  11.     await page.goto(currentURL);
  12.   }
  13.   await browser.close();
  14. })();

Shortcut for page.mainFrame().waitForSelector(selector[, options]).

page.waitForTimeout(timeout)

Returns a promise that resolves after the timeout.

Note that page.waitForTimeout() should only be used for debugging. Tests using the timer in production are going to be flaky. Use signals such as network events, selectors becoming visible and others instead.

  1. // wait for 1 second
  2. await page.waitForTimeout(1000);

Shortcut for page.mainFrame().waitForTimeout(timeout).

page.workers()

NOTE This does not contain ServiceWorkers