A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://playwright.dev/docs/api/class-page below:

Page | Playwright

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:

const { webkit } = require('playwright');  

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

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:

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

To unsubscribe from events use the removeListener method:

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

page.removeListener('request', logRequest);
Methods​ addInitScript​Added before v1.9 page.addInitScript

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

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.

Usage

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


await page.addInitScript({ path: './preload.js' });
await page.addInitScript(mock => {
  window.mock = mock;
}, mock);

Arguments

Returns

addLocatorHandler​Added in: v1.42 page.addLocatorHandler

When testing a web page, sometimes unexpected overlays like a "Sign up" dialog appear and block actions you want to automate, e.g. clicking a button. These overlays don't always show up in the same way or at the same time, making them tricky to handle in automated tests.

This method lets you set up a special function, called a handler, that activates when it detects that overlay is visible. The handler's job is to remove the overlay, allowing your test to continue as if the overlay wasn't there.

Things to keep in mind:

warning

Running the handler will alter your page state mid-test. For example it will change the currently focused element and move the mouse. Make sure that actions that run after the handler are self-contained and do not rely on the focus and mouse state being unchanged.

For example, consider a test that calls locator.focus() followed by keyboard.press(). If your handler clicks a button between these two actions, the focused element most likely will be wrong, and key press will happen on the unexpected element. Use locator.press() instead to avoid this problem.

Another example is a series of mouse actions, where mouse.move() is followed by mouse.down(). Again, when the handler runs between these two actions, the mouse position will be wrong during the mouse down. Prefer self-contained actions like locator.click() that do not rely on the state being unchanged by a handler.

Usage

An example that closes a "Sign up to the newsletter" dialog when it appears:


await page.addLocatorHandler(page.getByText('Sign up to the newsletter'), async () => {
  await page.getByRole('button', { name: 'No thanks' }).click();
});


await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

An example that skips the "Confirm your security details" page when it is shown:


await page.addLocatorHandler(page.getByText('Confirm your security details'), async () => {
  await page.getByRole('button', { name: 'Remind me later' }).click();
});


await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

An example with a custom callback on every actionability check. It uses a <body> locator that is always visible, so the handler is called before every actionability check. It is important to specify noWaitAfter, because the handler does not hide the <body> element.


await page.addLocatorHandler(page.locator('body'), async () => {
  await page.evaluate(() => window.removeObstructionsForTestIfNeeded());
}, { noWaitAfter: true });


await page.goto('https://example.com');
await page.getByRole('button', { name: 'Start here' }).click();

Handler takes the original locator as an argument. You can also automatically remove the handler after a number of invocations by setting times:

await page.addLocatorHandler(page.getByLabel('Close'), async locator => {
  await locator.click();
}, { times: 1 });

Arguments

Returns

addScriptTag​Added before v1.9 page.addScriptTag

Adds a <script> tag into the page with the desired url or content. Returns the added tag when the script's onload fires or when the script content was injected into frame.

Usage

await page.addScriptTag();
await page.addScriptTag(options);

Arguments

Returns

addStyleTag​Added before v1.9 page.addStyleTag

Adds a <link rel="stylesheet"> tag into the page with the desired url or a <style type="text/css"> tag with the content. Returns the added tag when the stylesheet's onload fires or when the CSS content was injected into frame.

Usage

await page.addStyleTag();
await page.addStyleTag(options);

Arguments

Returns

bringToFront​Added before v1.9 page.bringToFront

Brings page to front (activates tab).

Usage

await page.bringToFront();

Returns

close​Added before v1.9 page.close

If runBeforeUnload is false, does not run any unload handlers and waits for the page to be closed. If runBeforeUnload is true the method will run unload handlers, but will not wait for the page to close.

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

Usage

await page.close();
await page.close(options);

Arguments

Returns

content​Added before v1.9 page.content

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

Usage

Returns

context​Added before v1.9 page.context

Get the browser context that the page belongs to.

Usage

Returns

dragAndDrop​Added in: v1.13 page.dragAndDrop

This method drags the source element to the target element. It will first move to the source element, perform a mousedown, then move to the target element and perform a mouseup.

Usage

await page.dragAndDrop('#source', '#target');

await page.dragAndDrop('#source', '#target', {
  sourcePosition: { x: 34, y: 7 },
  targetPosition: { x: 10, y: 20 },
});

Arguments

Returns

emulateMedia​Added before v1.9 page.emulateMedia

This method changes the CSS media type through the media argument, and/or the 'prefers-colors-scheme' media feature, using the colorScheme argument.

Usage

await page.evaluate(() => matchMedia('screen').matches);

await page.evaluate(() => matchMedia('print').matches);


await page.emulateMedia({ media: 'print' });
await page.evaluate(() => matchMedia('screen').matches);

await page.evaluate(() => matchMedia('print').matches);


await page.emulateMedia({});
await page.evaluate(() => matchMedia('screen').matches);

await page.evaluate(() => matchMedia('print').matches);

await page.emulateMedia({ colorScheme: 'dark' });
await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);

await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);

Arguments

Returns

evaluate​Added before v1.9 page.evaluate

Returns the value of the pageFunction invocation.

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. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

Usage

Passing argument to pageFunction:

const result = await page.evaluate(([x, y]) => {
  return Promise.resolve(x * y);
}, [7, 8]);
console.log(result);

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

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

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

const bodyHandle = await page.evaluate('document.body');
const html = await page.evaluate<string, HTMLElement>(([body, suffix]) =>
  body.innerHTML + suffix, [bodyHandle, 'hello']
);
await bodyHandle.dispose();

Arguments

Returns

evaluateHandle​Added before v1.9 page.evaluateHandle

Returns the value of the pageFunction invocation as a JSHandle.

The only difference between page.evaluate() and page.evaluateHandle() is that page.evaluateHandle() returns 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.

Usage


const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));

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

const aHandle = await page.evaluateHandle('document');

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

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

Arguments

Returns

exposeBinding​Added before v1.9 page.exposeBinding

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

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

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

Usage

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

const { webkit } = require('playwright');  

(async () => {
  const browser = await webkit.launch({ headless: false });
  const context = await browser.newContext();
  const page = await context.newPage();
  await page.exposeBinding('pageURL', ({ page }) => page.url());
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.pageURL();
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();

Arguments

Returns

exposeFunction​Added before v1.9 page.exposeFunction

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

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

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

Usage

An example of adding a sha256 function to the page:

const { webkit } = require('playwright');  
const crypto = require('crypto');

(async () => {
  const browser = await webkit.launch({ headless: false });
  const page = await browser.newPage();
  await page.exposeFunction('sha256', text =>
    crypto.createHash('sha256').update(text).digest('hex'),
  );
  await page.setContent(`
    <script>
      async function onClick() {
        document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');
      }
    </script>
    <button onclick="onClick()">Click me</button>
    <div></div>
  `);
  await page.click('button');
})();

Arguments

Returns

frame​Added before v1.9 page.frame

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

Usage

const frame = page.frame('frame-name');
const frame = page.frame({ url: /.*domain.*/ });

Arguments

Returns

frameLocator​Added in: v1.17 page.frameLocator

When working with iframes, you can create a frame locator that will enter the iframe and allow selecting elements in that iframe.

Usage

Following snippet locates element with text "Submit" in the iframe with id my-frame, like <iframe id="my-frame">:

const locator = page.frameLocator('#my-iframe').getByText('Submit');
await locator.click();

Arguments

Returns

frames​Added before v1.9 page.frames

An array of all frames attached to the page.

Usage

Returns

getByAltText​Added in: v1.27 page.getByAltText

Allows locating elements by their alt text.

Usage

For example, this method will find the image by alt text "Playwright logo":

<img alt='Playwright logo'>
await page.getByAltText('Playwright logo').click();

Arguments

Returns

getByLabel​Added in: v1.27 page.getByLabel

Allows locating input elements by the text of the associated <label> or aria-labelledby element, or by the aria-label attribute.

Usage

For example, this method will find inputs by label "Username" and "Password" in the following DOM:

<input aria-label="Username">
<label for="password-input">Password:</label>
<input id="password-input">
await page.getByLabel('Username').fill('john');
await page.getByLabel('Password').fill('secret');

Arguments

Returns

getByPlaceholder​Added in: v1.27 page.getByPlaceholder

Allows locating input elements by the placeholder text.

Usage

For example, consider the following DOM structure.

<input type="email" placeholder="name@example.com" />

You can fill the input after locating it by the placeholder text:

await page
    .getByPlaceholder('name@example.com')
    .fill('playwright@microsoft.com');

Arguments

Returns

getByRole​Added in: v1.27 page.getByRole

Allows locating elements by their ARIA role, ARIA attributes and accessible name.

Usage

Consider the following DOM structure.

<h3>Sign up</h3>
<label>
  <input type="checkbox" /> Subscribe
</label>
<br/>
<button>Submit</button>

You can locate each element by it's implicit role:

await expect(page.getByRole('heading', { name: 'Sign up' })).toBeVisible();

await page.getByRole('checkbox', { name: 'Subscribe' }).check();

await page.getByRole('button', { name: /submit/i }).click();

Arguments

Returns

Details

Role selector does not replace accessibility audits and conformance tests, but rather gives early feedback about the ARIA guidelines.

Many html elements have an implicitly defined role that is recognized by the role selector. You can find all the supported roles here. ARIA guidelines do not recommend duplicating implicit roles and attributes by setting role and/or aria-* attributes to default values.

getByTestId​Added in: v1.27 page.getByTestId

Locate element by the test id.

Usage

Consider the following DOM structure.

<button data-testid="directions">Itinéraire</button>

You can locate the element by it's test id:

await page.getByTestId('directions').click();

Arguments

Returns

Details

By default, the data-testid attribute is used as a test id. Use selectors.setTestIdAttribute() to configure a different test id attribute if necessary.


import { defineConfig } from '@playwright/test';

export default defineConfig({
  use: {
    testIdAttribute: 'data-pw'
  },
});
getByText​Added in: v1.27 page.getByText

Allows locating elements that contain given text.

See also locator.filter() that allows to match by another criteria, like an accessible role, and then filter by the text content.

Usage

Consider the following DOM structure:

<div>Hello <span>world</span></div>
<div>Hello</div>

You can locate by text substring, exact string, or a regular expression:


page.getByText('world');


page.getByText('Hello world');


page.getByText('Hello', { exact: true });


page.getByText(/Hello/);


page.getByText(/^hello$/i);

Arguments

Returns

Details

Matching by text always normalizes whitespace, even with exact match. For example, it turns multiple spaces into one, turns line breaks into spaces and ignores leading and trailing whitespace.

Input elements of the type button and submit are matched by their value instead of the text content. For example, locating by text "Log in" matches <input type=button value="Log in">.

getByTitle​Added in: v1.27 page.getByTitle

Allows locating elements by their title attribute.

Usage

Consider the following DOM structure.

<span title='Issues count'>25 issues</span>

You can check the issues count after locating it by the title text:

await expect(page.getByTitle('Issues count')).toHaveText('25 issues');

Arguments

Returns

goBack​Added before v1.9 page.goBack

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If cannot go back, returns null.

Navigate to the previous page in history.

Usage

await page.goBack();
await page.goBack(options);

Arguments

Returns

goForward​Added before v1.9 page.goForward

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If cannot go forward, returns null.

Navigate to the next page in history.

Usage

await page.goForward();
await page.goForward(options);

Arguments

Returns

goto​Added before v1.9 page.goto

Returns the main resource response. In case of multiple redirects, the navigation will resolve with the first non-redirect response.

The method will throw an error if:

The method 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

The method 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.

Usage

await page.goto(url);
await page.goto(url, options);

Arguments

Returns

isClosed​Added before v1.9 page.isClosed

Indicates that the page has been closed.

Usage

Returns

locator​Added in: v1.14 page.locator

The method returns an element locator that can be used to perform actions on this page / frame. Locator is resolved to the element immediately before performing an action, so a series of actions on the same locator can in fact be performed on different DOM elements. That would happen if the DOM structure between those actions has changed.

Learn more about locators.

Usage

page.locator(selector);
page.locator(selector, options);

Arguments

Returns

mainFrame​Added before v1.9 page.mainFrame

The page's main frame. Page is guaranteed to have a main frame which persists during navigations.

Usage

Returns

opener​Added before v1.9 page.opener

Returns the opener for popup pages and null for others. If the opener has been closed already the returns null.

Usage

Returns

pause​Added in: v1.9 page.pause

Pauses script execution. Playwright will stop executing the script and wait for the user to either press 'Resume' button in the page overlay or to call playwright.resume() in the DevTools console.

User can inspect selectors or perform manual steps while paused. Resume will continue running the original script from the place it was paused.

note

This method requires Playwright to be started in a headed mode, with a falsy headless option.

Usage

Returns

pdf​Added before v1.9 page.pdf

Returns the PDF buffer.

page.pdf() generates a pdf of the page with print css media. To generate a pdf with screen media, call page.emulateMedia() 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.

Usage


await page.emulateMedia({ media: 'screen' });
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:

All possible units are:

The format options are:

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.

Arguments

Returns

reload​Added before v1.9 page.reload

This method reloads the current page, in the same way as if the user had triggered a browser refresh. Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.

Usage

await page.reload();
await page.reload(options);

Arguments

Returns

removeAllListeners​Added in: v1.47 page.removeAllListeners

Removes all the listeners of the given type (or all registered listeners if no type given). Allows to wait for async listeners to complete or to ignore subsequent errors from these listeners.

Usage

page.on('request', async request => {
  const response = await request.response();
  const body = await response.body();
  console.log(body.byteLength);
});
await page.goto('https://playwright.dev', { waitUntil: 'domcontentloaded' });

await page.removeAllListeners('request', { behavior: 'wait' });

Arguments

Returns

removeLocatorHandler​Added in: v1.44 page.removeLocatorHandler

Removes all locator handlers added by page.addLocatorHandler() for a specific locator.

Usage

await page.removeLocatorHandler(locator);

Arguments

Returns

requestGC​Added in: v1.48 page.requestGC

Request the page to perform garbage collection. Note that there is no guarantee that all unreachable objects will be collected.

This is useful to help detect memory leaks. For example, if your page has a large object 'suspect' that might be leaked, you can check that it does not leak by using a WeakRef.


await page.evaluate(() => globalThis.suspectWeakRef = new WeakRef(suspect));

await page.requestGC();

expect(await page.evaluate(() => !globalThis.suspectWeakRef.deref())).toBe(true);

Usage

Returns

route​Added before v1.9 page.route

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.

note

The handler will only be called for the first url if the response is a redirect.

note

page.route() will not intercept requests intercepted by Service Worker. See this issue. We recommend disabling Service Workers when using request interception by setting serviceWorkers to 'block'.

Usage

An example of a naive handler that aborts all image requests:

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

or the same snippet using a regex pattern instead:

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

It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:

await page.route('/api/**', async route => {
  if (route.request().postData().includes('my-string'))
    await route.fulfill({ body: 'mocked-data' });
  else
    await route.continue();
});

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

To remove a route with its handler you can use page.unroute().

note

Enabling routing disables http cache.

Arguments

Returns

routeFromHAR​Added in: v1.23 page.routeFromHAR

If specified the network requests that are made in the page will be served from the HAR file. Read more about Replaying from HAR.

Playwright will not serve requests intercepted by Service Worker from the HAR file. See this issue. We recommend disabling Service Workers when using request interception by setting serviceWorkers to 'block'.

Usage

await page.routeFromHAR(har);
await page.routeFromHAR(har, options);

Arguments

Returns

routeWebSocket​Added in: v1.48 page.routeWebSocket

This method allows to modify websocket connections that are made by the page.

Note that only WebSockets created after this method was called will be routed. It is recommended to call this method before navigating the page.

Usage

Below is an example of a simple mock that responds to a single message. See WebSocketRoute for more details and examples.

await page.routeWebSocket('/ws', ws => {
  ws.onMessage(message => {
    if (message === 'request')
      ws.send('response');
  });
});

Arguments

Returns

screenshot​Added before v1.9 page.screenshot

Returns the buffer with the captured screenshot.

Usage

await page.screenshot();
await page.screenshot(options);

Arguments

Returns

setContent​Added before v1.9 page.setContent

This method internally calls document.write(), inheriting all its specific characteristics and behaviors.

Usage

await page.setContent(html);
await page.setContent(html, options);

Arguments

Returns

setDefaultNavigationTimeout​Added before v1.9 page.setDefaultNavigationTimeout

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

Usage

page.setDefaultNavigationTimeout(timeout);

Arguments

setDefaultTimeout​Added before v1.9 page.setDefaultTimeout

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

Usage

page.setDefaultTimeout(timeout);

Arguments

Added before v1.9 page.setExtraHTTPHeaders

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

Usage

await page.setExtraHTTPHeaders(headers);

Arguments

Returns

setViewportSize​Added before v1.9 page.setViewportSize

In the case of multiple pages in a single browser, each page can have its own viewport size. However, browser.newContext() 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. page.setViewportSize() will also reset screen size, use browser.newContext() with screen and viewport parameters if you need better control of these properties.

Usage

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

Arguments

Returns

title​Added before v1.9 page.title

Returns the page's title.

Usage

Returns

unroute​Added before v1.9 page.unroute

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

Usage

await page.unroute(url);
await page.unroute(url, handler);

Arguments

Returns

unrouteAll​Added in: v1.41 page.unrouteAll

Removes all routes created with page.route() and page.routeFromHAR().

Usage

await page.unrouteAll();
await page.unrouteAll(options);

Arguments

Returns

url​Added before v1.9 page.url

Usage

Returns

video​Added before v1.9 page.video

Video object associated with this page.

Usage

Returns

viewportSize​Added before v1.9 page.viewportSize

Usage

Returns

waitForEvent​Added before v1.9 page.waitForEvent

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

Usage


const downloadPromise = page.waitForEvent('download');
await page.getByText('Download file').click();
const download = await downloadPromise;

Arguments

Returns

waitForFunction​Added before v1.9 page.waitForFunction

Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.

Usage

The page.waitForFunction() can be used to observe viewport size change:

const { webkit } = require('playwright');  

(async () => {
  const browser = await webkit.launch();
  const page = await browser.newPage();
  const watchDog = page.waitForFunction(() => window.innerWidth < 100);
  await page.setViewportSize({ width: 50, height: 50 });
  await watchDog;
  await browser.close();
})();

To pass an argument to the predicate of page.waitForFunction() function:

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

Arguments

Returns

waitForLoadState​Added before v1.9 page.waitForLoadState

Returns when the required load state has been reached.

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.

Usage

await page.getByRole('button').click(); 
await page.waitForLoadState(); 
const popupPromise = page.waitForEvent('popup');
await page.getByRole('button').click(); 
const popup = await popupPromise;
await popup.waitForLoadState('domcontentloaded'); 
console.log(await popup.title());

Arguments

Returns

waitForRequest​Added before v1.9 page.waitForRequest

Waits for the matching request and returns it. See waiting for event for more details about events.

Usage


const requestPromise = page.waitForRequest('https://example.com/resource');
await page.getByText('trigger request').click();
const request = await requestPromise;


const requestPromise = page.waitForRequest(request =>
  request.url() === 'https://example.com' && request.method() === 'GET',
);
await page.getByText('trigger request').click();
const request = await requestPromise;

Arguments

Returns

waitForResponse​Added before v1.9 page.waitForResponse

Returns the matched response. See waiting for event for more details about events.

Usage


const responsePromise = page.waitForResponse('https://example.com/resource');
await page.getByText('trigger response').click();
const response = await responsePromise;


const responsePromise = page.waitForResponse(response =>
  response.url() === 'https://example.com' && response.status() === 200
      && response.request().method() === 'GET'
);
await page.getByText('trigger response').click();
const response = await responsePromise;

Arguments

Returns

waitForURL​Added in: v1.11 page.waitForURL

Waits for the main frame to navigate to the given URL.

Usage

await page.click('a.delayed-navigation'); 
await page.waitForURL('**/target.html');

Arguments

Returns

workers​Added before v1.9 page.workers

This method returns all of the dedicated WebWorkers associated with the page.

note

This does not contain ServiceWorkers

Usage

Returns

Properties​ clock​Added in: v1.45 page.clock

Playwright has ability to mock clock and passage of time.

Usage

Type

coverage​Added before v1.9 page.coverage

note

Only available for Chromium atm.

Browser-specific Coverage implementation. See Coverage for more details.

Usage

Type

keyboard​Added before v1.9 page.keyboard

Usage

Type

mouse​Added before v1.9 page.mouse

Usage

Type

request​Added in: v1.16 page.request

API testing helper associated with this page. This method returns the same instance as browserContext.request on the page's context. See browserContext.request for more details.

Usage

Type

touchscreen​Added before v1.9 page.touchscreen

Usage

Type

Events​ on('close')​Added before v1.9 page.on('close')

Emitted when the page closes.

Usage

page.on('close', data => {});

Event data

on('console')​Added before v1.9 page.on('console')

Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.

The arguments passed into console.log are available on the ConsoleMessage event handler argument.

Usage

page.on('console', async msg => {
  const values = [];
  for (const arg of msg.args())
    values.push(await arg.jsonValue());
  console.log(...values);
});
await page.evaluate(() => console.log('hello', 5, { foo: 'bar' }));

Event data

on('crash')​Added before v1.9 page.on('crash')

Emitted when the page crashes. Browser pages might crash if they try to allocate too much memory. When the page crashes, ongoing and subsequent operations will throw.

The most common way to deal with crashes is to catch an exception:

try {
  
  await page.click('button');
  
  await page.waitForEvent('popup');
} catch (e) {
  
}

Usage

page.on('crash', data => {});

Event data

on('dialog')​Added before v1.9 page.on('dialog')

Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either dialog.accept() or dialog.dismiss() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

Usage

page.on('dialog', dialog => dialog.accept());

Event data

on('domcontentloaded')​Added in: v1.9 page.on('domcontentloaded')

Emitted when the JavaScript DOMContentLoaded event is dispatched.

Usage

page.on('domcontentloaded', data => {});

Event data

on('download')​Added before v1.9 page.on('download')

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

Usage

page.on('download', data => {});

Event data

on('filechooser')​Added in: v1.9 page.on('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.

page.on('filechooser', async fileChooser => {
  await fileChooser.setFiles(path.join(__dirname, '/tmp/myfile.pdf'));
});

Usage

page.on('filechooser', data => {});

Event data

on('frameattached')​Added in: v1.9 page.on('frameattached')

Emitted when a frame is attached.

Usage

page.on('frameattached', data => {});

Event data

on('framedetached')​Added in: v1.9 page.on('framedetached')

Emitted when a frame is detached.

Usage

page.on('framedetached', data => {});

Event data

on('framenavigated')​Added in: v1.9 page.on('framenavigated')

Emitted when a frame is navigated to a new url.

Usage

page.on('framenavigated', data => {});

Event data

on('load')​Added before v1.9 page.on('load')

Emitted when the JavaScript load event is dispatched.

Usage

page.on('load', data => {});

Event data

on('pageerror')​Added in: v1.9 page.on('pageerror')

Emitted when an uncaught exception happens within the page.


page.on('pageerror', exception => {
  console.log(`Uncaught exception: "${exception}"`);
});


await page.goto('data:text/html,<script>throw new Error("Test")</script>');

Usage

page.on('pageerror', data => {});

Event data

Added before v1.9 page.on('popup')

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. If you would like to route/listen to this network request, use browserContext.route() and browserContext.on('request') respectively instead of similar methods on the Page.


const popupPromise = page.waitForEvent('popup');
await page.getByText('open the popup').click();
const popup = await popupPromise;
console.log(await popup.evaluate('location.href'));

note

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

Usage

page.on('popup', data => {});

Event data

on('request')​Added before v1.9 page.on('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().

Usage

page.on('request', data => {});

Event data

on('requestfailed')​Added in: v1.9 page.on('requestfailed')

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

page.on('requestfailed', request => {
  console.log(request.url() + ' ' + request.failure().errorText);
});

note

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with page.on('requestfinished') event and not with page.on('requestfailed'). A request will only be considered failed when the client cannot get an HTTP response from the server, e.g. due to network error net::ERR_FAILED.

Usage

page.on('requestfailed', data => {});

Event data

on('requestfinished')​Added in: v1.9 page.on('requestfinished')

Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished.

Usage

page.on('requestfinished', data => {});

Event data

on('response')​Added before v1.9 page.on('response')

Emitted when response status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished.

Usage

page.on('response', data => {});

Event data

on('websocket')​Added in: v1.9 page.on('websocket')

Emitted when WebSocket request is sent.

Usage

page.on('websocket', data => {});

Event data

on('worker')​Added before v1.9 page.on('worker')

Emitted when a dedicated WebWorker is spawned by the page.

Usage

page.on('worker', data => {});

Event data

Deprecated​ $​Added in: v1.9 page.$

The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null. To wait for an element on the page, use locator.waitFor().

Usage

await page.$(selector);
await page.$(selector, options);

Arguments

Returns

$$​Added in: v1.9 page.$$

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

Usage

Arguments

Returns

$eval​Added in: v1.9 page.$eval

Discouraged

This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(), other Locator helper methods or web-first assertions instead.

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. Returns the value of pageFunction.

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

Usage

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

const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);

Arguments

Returns

$$eval​Added in: v1.9 page.$$eval

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. Returns the result of pageFunction invocation.

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

Usage

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

Arguments

Returns

accessibility​Added before v1.9 page.accessibility

Deprecated

This property is discouraged. Please use other libraries such as Axe if you need to test page accessibility. See our Node.js guide for integration with Axe.

Usage

Type

check​Added before v1.9 page.check

This method checks an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already checked, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Ensure that the element is now checked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.check(selector);
await page.check(selector, options);

Arguments

Returns

click​Added before v1.9 page.click

This method clicks an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  3. Scroll the element into view if needed.
  4. Use page.mouse to click in the center of the element, or the specified position.
  5. Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.click(selector);
await page.click(selector, options);

Arguments

Returns

dblclick​Added before v1.9 page.dblclick

This method double clicks an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  3. Scroll the element into view if needed.
  4. Use page.mouse to double click in the center of the element, or the specified position.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

note

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

Usage

await page.dblclick(selector);
await page.dblclick(selector, options);

Arguments

Returns

dispatchEvent​Added before v1.9 page.dispatchEvent

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

Usage

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:


const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await page.dispatchEvent('#source', 'dragstart', { dataTransfer });

Arguments

Returns

fill​Added before v1.9 page.fill

This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling. Note that you can pass an empty string to clear the input field.

If the target element is not an <input>, <textarea> or [contenteditable] element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be filled instead.

To send fine-grained keyboard events, use locator.pressSequentially().

Usage

await page.fill(selector, value);
await page.fill(selector, value, options);

Arguments

Returns

focus​Added before v1.9 page.focus

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.

Usage

await page.focus(selector);
await page.focus(selector, options);

Arguments

Returns

getAttribute​Added before v1.9 page.getAttribute

Returns element attribute value.

Usage

await page.getAttribute(selector, name);
await page.getAttribute(selector, name, options);

Arguments

Returns

hover​Added before v1.9 page.hover

This method hovers over an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  3. Scroll the element into view if needed.
  4. Use page.mouse to hover over the center of the element, or the specified position.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.hover(selector);
await page.hover(selector, options);

Arguments

Returns

innerHTML​Added before v1.9 page.innerHTML

Returns element.innerHTML.

Usage

await page.innerHTML(selector);
await page.innerHTML(selector, options);

Arguments

Returns

innerText​Added before v1.9 page.innerText

Returns element.innerText.

Usage

await page.innerText(selector);
await page.innerText(selector, options);

Arguments

Returns

inputValue​Added in: v1.13 page.inputValue

Returns input.value for the selected <input> or <textarea> or <select> element.

Throws for non-input elements. However, if the element is inside the <label> element that has an associated control, returns the value of the control.

Usage

await page.inputValue(selector);
await page.inputValue(selector, options);

Arguments

Returns

isChecked​Added before v1.9 page.isChecked

Returns whether the element is checked. Throws if the element is not a checkbox or radio input.

Usage

await page.isChecked(selector);
await page.isChecked(selector, options);

Arguments

Returns

isDisabled​Added before v1.9 page.isDisabled

Returns whether the element is disabled, the opposite of enabled.

Usage

await page.isDisabled(selector);
await page.isDisabled(selector, options);

Arguments

Returns

isEditable​Added before v1.9 page.isEditable

Returns whether the element is editable.

Usage

await page.isEditable(selector);
await page.isEditable(selector, options);

Arguments

Returns

isEnabled​Added before v1.9 page.isEnabled

Returns whether the element is enabled.

Usage

await page.isEnabled(selector);
await page.isEnabled(selector, options);

Arguments

Returns

isHidden​Added before v1.9 page.isHidden

Returns whether the element is hidden, the opposite of visible. selector that does not match any elements is considered hidden.

Usage

await page.isHidden(selector);
await page.isHidden(selector, options);

Arguments

Returns

isVisible​Added before v1.9 page.isVisible

Returns whether the element is visible. selector that does not match any elements is considered not visible.

Usage

await page.isVisible(selector);
await page.isVisible(selector, options);

Arguments

Returns

press​Added before v1.9 page.press

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, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft, ControlOrMeta. ControlOrMeta resolves to Control on Windows and Linux and to Meta on macOS.

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", key: "Control++ or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Usage

const page = await browser.newPage();
await page.goto('https://keycode.info');
await page.press('body', 'A');
await page.screenshot({ path: 'A.png' });
await page.press('body', 'ArrowLeft');
await page.screenshot({ path: 'ArrowLeft.png' });
await page.press('body', 'Shift+O');
await page.screenshot({ path: 'O.png' });
await browser.close();

Arguments

Returns

selectOption​Added before v1.9 page.selectOption

This method waits for an element matching selector, waits for actionability checks, waits until all specified options are present in the <select> element and selects these options.

If the target element is not a <select> element, this method throws an error. However, if the element is inside the <label> element that has an associated control, the control will be used instead.

Returns the array of option values that have been successfully selected.

Triggers a change and input event once all the provided options have been selected.

Usage


page.selectOption('select#colors', 'blue');


page.selectOption('select#colors', { label: 'Blue' });


page.selectOption('select#colors', ['red', 'green', 'blue']);

Arguments

Returns

setChecked​Added in: v1.15 page.setChecked

This method checks or unchecks an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws.
  3. If the element already has the right checked state, this method returns immediately.
  4. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  5. Scroll the element into view if needed.
  6. Use page.mouse to click in the center of the element.
  7. Ensure that the element is now checked or unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.setChecked(selector, checked);
await page.setChecked(selector, checked, options);

Arguments

Returns

setInputFiles​Added before v1.9 page.setInputFiles

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. For inputs with a [webkitdirectory] attribute, only a single directory path is supported.

This method expects selector to point to an input element. However, if the element is inside the <label> element that has an associated control, targets the control instead.

Usage

await page.setInputFiles(selector, files);
await page.setInputFiles(selector, files, options);

Arguments

Returns

tap​Added before v1.9 page.tap

This method taps an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  3. Scroll the element into view if needed.
  4. Use page.touchscreen to tap the center of the element, or the specified position.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.tap(selector);
await page.tap(selector, options);

Arguments

Returns

textContent​Added before v1.9 page.textContent

Returns element.textContent.

Usage

await page.textContent(selector);
await page.textContent(selector, options);

Arguments

Returns

type​Added before v1.9 page.type

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().

Usage

Arguments

Returns

uncheck​Added before v1.9 page.uncheck

This method unchecks an element matching selector by performing the following steps:

  1. Find an element matching selector. If there is none, wait until a matching element is attached to the DOM.
  2. Ensure that matched element is a checkbox or a radio input. If not, this method throws. If the element is already unchecked, this method returns immediately.
  3. Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
  4. Scroll the element into view if needed.
  5. Use page.mouse to click in the center of the element.
  6. Ensure that the element is now unchecked. If not, this method throws.

When all steps combined have not finished during the specified timeout, this method throws a TimeoutError. Passing zero timeout disables this.

Usage

await page.uncheck(selector);
await page.uncheck(selector, options);

Arguments

Returns

waitForNavigation​Added before v1.9 page.waitForNavigation

Waits for the main frame navigation and returns 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.

Usage

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. e.g. The click target has an onclick handler that triggers navigation from a setTimeout. Consider this example:


const navigationPromise = page.waitForNavigation();
await page.getByText('Navigate after timeout').click();
await navigationPromise;

note

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

Arguments

Returns

waitForSelector​Added before v1.9 page.waitForSelector

Discouraged

Use web assertions that assert visibility or a locator-based locator.waitFor() instead. Read more about locators.

Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.

note

Playwright automatically waits for element to be ready before performing an action. Using Locator objects and web-first assertions makes the code wait-for-selector-free.

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.

Usage

This method works across navigations:

const { chromium } = require('playwright');  

(async () => {
  const browser = await chromium.launch();
  const page = await browser.newPage();
  for (const currentURL of ['https://google.com', 'https://bbc.com']) {
    await page.goto(currentURL);
    const element = await page.waitForSelector('img');
    console.log('Loaded image: ' + await element.getAttribute('src'));
  }
  await browser.close();
})();

Arguments

Returns

waitForTimeout​Added before v1.9 page.waitForTimeout

Discouraged

Never wait for timeout in production. Tests that wait for time are inherently flaky. Use Locator actions and web assertions that wait automatically.

Waits for the given timeout in milliseconds.

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.

Usage


await page.waitForTimeout(1000);

Arguments

Returns

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4