NOTE Only available for Chromium atm.
Browser-specific Coverage implementation. See [Coverage] for more details.
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.
NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
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([options]).
A selector to query for.
Optionaloptions: { NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
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([options]).
A selector to query for.
Optionaloptions: { NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds all elements matching the specified selector within the page. If no elements match the selector,
the return value resolves to [].
A selector to query for.
NOTE Use locator-based page.locator(selector[, options]) instead. Read more about locators.
The method finds all elements matching the specified selector within the page. If no elements match the selector,
the return value resolves to [].
A selector to query for.
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.
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(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.
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(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.
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(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
NOTE In most cases, locator.evaluateAll(pageFunction[, arg]), other [Locator] helper methods and web-first assertions do a better job.
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(selector, pageFunction[, arg])
would wait for the promise to resolve and return its value.
Usage
const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), 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(selector, pageFunction[, arg, options])
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');
// In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), 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(selector, pageFunction[, arg, options])
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');
// In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), 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(selector, pageFunction[, arg, options])
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');
// In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);
NOTE This method does not wait for the element to pass actionability checks and therefore can lead to the flaky tests. Use locator.evaluate(pageFunction[, arg, options]), 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(selector, pageFunction[, arg, options])
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');
// In TypeScript, this example requires an explicit type annotation (HTMLLinkElement) on el:
const preloadHrefTS = await page.$eval('link[rel=preload]', (el: HTMLLinkElement) => el.href);
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:
// preload.js
Math.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory
await page.addInitScript({ path: './preload.js' });
NOTE The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.
Emitted when the page closes.
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:
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'}));
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 {
// Crash might happen during a click.
await page.click('button');
// Or while waiting for an event.
await page.waitForEvent('popup');
} catch (e) {
// When the page crashes, exception message contains 'crash'.
}
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
page.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when the JavaScript
DOMContentLoaded event is dispatched.
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.
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(files[, options])
that can be uploaded after that.
page.on('filechooser', async (fileChooser) => {
await fileChooser.setFiles('/tmp/myfile.pdf');
});
Emitted when a frame is attached.
Emitted when a frame is detached.
Emitted when a frame is navigated to a new url.
Emitted when the JavaScript load event is dispatched.
Emitted when an uncaught exception happens within the page.
// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
console.log(`Uncaught exception: "${exception}"`);
});
// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');
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.
// Start waiting for popup before clicking. Note no await.
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([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).
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.
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished.
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished.
Emitted when [WebSocket] request is sent.
Emitted when a dedicated WebWorker is spawned by the page.
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.
Optionaloptions: { Optionalcontent?: stringRaw JavaScript content to be injected into frame.
Optionalpath?: stringPath to the JavaScript file to be injected into frame. If path is a relative path, then it is resolved relative
to the current working directory.
Optionaltype?: stringScript type. Use 'module' in order to load a Javascript ES6 module. See script for more details.
Optionalurl?: stringURL of a script to be added.
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.
Optionaloptions: { Optionalcontent?: stringRaw CSS content to be injected into frame.
Optionalpath?: stringPath to the CSS file to be injected into frame. If path is a relative path, then it is resolved relative to the
current working directory.
Optionalurl?: stringURL of the <link> tag.
NOTE Use locator-based locator.check([options]) instead. Read more about locators.
This method checks an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.click([options]) instead. Read more about locators.
This method clicks an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.position.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalbutton?: "middle" | "left" | "right"Defaults to left.
Optionalclickdefaults to 1. See [UIEvent.detail].
Optionaldelay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
Optionalmodifiers?: (Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
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.
NOTE if runBeforeUnload is passed as true, a beforeunload dialog might be summoned and should be handled
manually via page.on('dialog') event.
Optionaloptions: { OptionalrunDefaults to false. Whether to run the
before unload page handlers.
NOTE Use locator-based locator.dblclick([options]) instead. Read more about locators.
This method double clicks an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.position.noWaitAfter option is set. Note that if
the first click of the dblclick() triggers a navigation event, this method will throw.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalbutton?: "middle" | "left" | "right"Defaults to left.
Optionaldelay?: numberTime to wait between mousedown and mouseup in milliseconds. Defaults to 0.
Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
Optionalmodifiers?: (Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.dispatchEvent(type[, eventInit, options]) instead. Read more about locators.
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:
// Note you can only create DataTransfer in Chromium and Firefox
const dataTransfer = await page.evaluateHandle(() => new DataTransfer());
await page.dispatchEvent('#source', 'dragstart', { dataTransfer });
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
DOM event type: "click", "dragstart", etc.
OptionaleventInit: EvaluationArgumentOptional event-specific initialization properties.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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');
// or specify exact positions relative to the top-left corners of the elements:
await page.dragAndDrop('#source', '#target', {
sourcePosition: { x: 34, y: 7 },
targetPosition: { x: 10, y: 20 },
});
A selector to search for an element to drag. If there are multiple elements satisfying the selector, the first will be used.
A selector to search for an element to drop onto. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
OptionalsourceClicks on the source element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
OptionaltargetDrops on the target element at this point relative to the top-left corner of the element's padding box. If not specified, some visible point of the element is used.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
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);
// → true
await page.evaluate(() => matchMedia('print').matches);
// → false
await page.emulateMedia({ media: 'print' });
await page.evaluate(() => matchMedia('screen').matches);
// → false
await page.evaluate(() => matchMedia('print').matches);
// → true
await page.emulateMedia({});
await page.evaluate(() => matchMedia('screen').matches);
// → true
await page.evaluate(() => matchMedia('print').matches);
// → false
await page.emulateMedia({ colorScheme: 'dark' });
await page.evaluate(() => matchMedia('(prefers-color-scheme: dark)').matches);
// → true
await page.evaluate(() => matchMedia('(prefers-color-scheme: light)').matches);
// → false
await page.evaluate(() => matchMedia('(prefers-color-scheme: no-preference)').matches);
// → false
Optionaloptions: { OptionalcolorEmulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'.
Passing null disables color scheme emulation.
OptionalforcedEmulates 'forced-colors' media feature, supported values are 'active' and 'none'. Passing null disables
forced colors emulation.
Optionalmedia?: null | "print" | "screen"Changes the CSS media type of the page. The only allowed values are 'screen', 'print' and null. Passing
null disables CSS media emulation.
OptionalreducedEmulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. Passing
null disables reduced motion emulation.
Returns the value of the pageFunction invocation.
If the function passed to the page.evaluate(pageFunction[, arg]) returns a [Promise], then page.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.
If the function passed to the
page.evaluate(pageFunction[, arg]) returns a
non-[Serializable] value, then
page.evaluate(pageFunction[, arg]) 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); // prints "56"
A string can also be passed in instead of a function:
console.log(await page.evaluate('1 + 2')); // prints "3"
const x = 10;
console.log(await page.evaluate(`1 + ${x}`)); // prints "11"
[ElementHandle] instances can be passed as an argument to the page.evaluate(pageFunction[, arg]):
const bodyHandle = await page.evaluate('document.body');
const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
await bodyHandle.dispose();
Returns the value of the pageFunction invocation.
If the function passed to the page.evaluate(pageFunction[, arg]) returns a [Promise], then page.evaluate(pageFunction[, arg]) would wait for the promise to resolve and return its value.
If the function passed to the
page.evaluate(pageFunction[, arg]) returns a
non-[Serializable] value, then
page.evaluate(pageFunction[, arg]) 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); // prints "56"
A string can also be passed in instead of a function:
console.log(await page.evaluate('1 + 2')); // prints "3"
const x = 10;
console.log(await page.evaluate(`1 + ${x}`)); // prints "11"
[ElementHandle] instances can be passed as an argument to the page.evaluate(pageFunction[, arg]):
const bodyHandle = await page.evaluate('document.body');
const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
await bodyHandle.dispose();
Function to be evaluated in the page context.
Optionalarg: anyOptional argument to pass to pageFunction.
Returns the value of the pageFunction invocation as a [JSHandle].
The only difference between page.evaluate(pageFunction[, arg]) and page.evaluateHandle(pageFunction[, arg]) is that page.evaluateHandle(pageFunction[, arg]) returns [JSHandle].
If the function passed to the page.evaluateHandle(pageFunction[, arg]) returns a [Promise], then page.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.
Usage
const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
aWindowHandle; // Handle for the window object.
A string can also be passed in instead of a function:
const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'
[JSHandle] instances can be passed as an argument to the page.evaluateHandle(pageFunction[, arg]):
const aHandle = await page.evaluateHandle(() => document.body);
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();
Returns the value of the pageFunction invocation as a [JSHandle].
The only difference between page.evaluate(pageFunction[, arg]) and page.evaluateHandle(pageFunction[, arg]) is that page.evaluateHandle(pageFunction[, arg]) returns [JSHandle].
If the function passed to the page.evaluateHandle(pageFunction[, arg]) returns a [Promise], then page.evaluateHandle(pageFunction[, arg]) would wait for the promise to resolve and return its value.
Usage
const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
aWindowHandle; // Handle for the window object.
A string can also be passed in instead of a function:
const aHandle = await page.evaluateHandle('document'); // Handle for the 'document'
[JSHandle] instances can be passed as an argument to the page.evaluateHandle(pageFunction[, arg]):
const aHandle = await page.evaluateHandle(() => document.body);
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();
Function to be evaluated in the page context.
Optionalarg: anyOptional argument to pass to pageFunction.
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(name, callback[, options]) for the context-wide version.
NOTE Functions installed via page.exposeBinding(name, callback[, options]) survive navigations.
Usage
An example of exposing page URL to all frames in a page:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(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');
})();
An example of passing an element handle:
await page.exposeBinding('clicked', async (source, element) => {
console.log(await element.textContent());
}, { handle: true });
await page.setContent(`
<script>
document.addEventListener('click', event => window.clicked(event.target));
</script>
<div>Click me</div>
<div>Or click me</div>
`);
Name of the function on the window object.
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(name, callback[, options]) for the context-wide version.
NOTE Functions installed via page.exposeBinding(name, callback[, options]) survive navigations.
Usage
An example of exposing page URL to all frames in a page:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(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');
})();
An example of passing an element handle:
await page.exposeBinding('clicked', async (source, element) => {
console.log(await element.textContent());
}, { handle: true });
await page.setContent(`
<script>
document.addEventListener('click', event => window.clicked(event.target));
</script>
<div>Click me</div>
<div>Or click me</div>
`);
Name of the function on the window object.
Rest...args: any[]Optionaloptions: { Optionalhandle?: booleanThe 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(name, callback) for context-wide exposed function.
NOTE Functions installed via page.exposeFunction(name, callback) survive navigations.
Usage
An example of adding a sha256 function to the page:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
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');
})();
Name of the function on the window object
Callback function which will be called in Playwright's context.
NOTE Use locator-based locator.fill(value[, options]) instead. Read more about locators.
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 page.type(selector, text[, options]).
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Value to fill for the <input>, <textarea> or [contenteditable] element.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.focus([options]) instead. Read more about locators.
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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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.*/ });
Frame name or other frame lookup options.
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();
A selector to use when resolving DOM element.
NOTE Use locator-based locator.getAttribute(name[, options]) instead. Read more about locators.
Returns element attribute value.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Attribute name to get the value for.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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();
Text to locate the element for.
Optionaloptions: { Optionalexact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
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');
Text to locate the element for.
Optionaloptions: { Optionalexact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
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");
Text to locate the element for.
Optionaloptions: { Optionalexact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
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();
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.
Required aria role.
Optionaloptions: { Optionalchecked?: booleanAn attribute that is usually set by aria-checked or native <input type=checkbox> controls.
Learn more about aria-checked.
Optionaldisabled?: booleanAn attribute that is usually set by aria-disabled or disabled.
NOTE Unlike most other attributes, disabled is inherited through the DOM hierarchy. Learn more about
aria-disabled.
Optionalexact?: booleanWhether name is matched exactly: case-sensitive and whole-string. Defaults to false. Ignored when name is a
regular expression. Note that exact match still trims whitespace.
Optionalexpanded?: booleanAn attribute that is usually set by aria-expanded.
Learn more about aria-expanded.
OptionalincludeOption that controls whether hidden elements are matched. By default, only non-hidden elements, as defined by ARIA, are matched by role selector.
Learn more about aria-hidden.
Optionallevel?: numberA number attribute that is usually present for roles heading, listitem, row, treeitem, with default values
for <h1>-<h6> elements.
Learn more about aria-level.
Optionalname?: string | RegExpOption to match the accessible name. By default, matching is
case-insensitive and searches for a substring, use exact to control this behavior.
Learn more about accessible name.
Optionalpressed?: booleanAn attribute that is usually set by aria-pressed.
Learn more about aria-pressed.
Optionalselected?: booleanAn attribute that is usually set by aria-selected.
Learn more about aria-selected.
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();
Details
By default, the data-testid attribute is used as a test id. Use
selectors.setTestIdAttribute(attributeName)
to configure a different test id attribute if necessary.
// Set custom test id attribute from @playwright/test config:
use: {
testIdAttribute: 'data-pw'
}
Id to locate the element by.
Allows locating elements that contain given text.
See also locator.filter([options]) 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:
// Matches <span>
page.getByText('world')
// Matches first <div>
page.getByText('Hello world')
// Matches second <div>
page.getByText('Hello', { exact: true })
// Matches both <div>s
page.getByText(/Hello/)
// Matches second <div>
page.getByText(/^hello$/i)
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">.
Text to locate the element for.
Optionaloptions: { Optionalexact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
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');
Text to locate the element for.
Optionaloptions: { Optionalexact?: booleanWhether to find an exact match: case-sensitive and whole-string. Default to false. Ignored when locating by a regular expression. Note that exact match still trims whitespace.
Returns 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, returns null.
Navigate to the previous page in history.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.Returns 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, returns null.
Navigate to the next page in history.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.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:
timeout is exceeded during navigation.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.
URL to navigate page to. The url should include scheme, e.g. https://. When a baseURL via the context options
was provided and the passed URL is a path, it gets merged via the
new URL() constructor.
Optionaloptions: { Optionalreferer?: stringReferer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders(headers).
Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.NOTE Use locator-based locator.hover([options]) instead. Read more about locators.
This method hovers over an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.position.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
Optionalmodifiers?: (Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.innerHTML([options]) instead. Read more about locators.
Returns element.innerHTML.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.innerText([options]) instead. Read more about locators.
Returns element.innerText.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.inputValue([options]) instead. Read more about locators.
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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isChecked([options]) instead. Read more about locators.
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isDisabled([options]) instead. Read more about locators.
Returns whether the element is disabled, the opposite of enabled.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isEditable([options]) instead. Read more about locators.
Returns whether the element is editable.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isEnabled([options]) instead. Read more about locators.
Returns whether the element is enabled.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.isHidden([options]) instead. Read more about locators.
Returns whether the element is hidden, the opposite of visible. selector that
does not match any elements is considered hidden.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberThis option is ignored. page.isHidden(selector[, options]) does not wait for the element to become hidden and returns immediately.
NOTE Use locator-based locator.isVisible([options]) instead. Read more about locators.
Returns whether the element is visible. selector that does not match any elements
is considered not visible.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberThis option is ignored. page.isVisible(selector[, options]) does not wait for the element to become visible and returns immediately.
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.
A selector to use when resolving DOM element.
Optionaloptions: { Optionalhas?: LocatorMatches elements containing an element that matches an inner locator. Inner locator is queried against the outer
one. For example, article that has text=Playwright matches <article><div>Playwright</div></article>.
Note that outer and inner locators must belong to the same frame. Inner locator must not contain [FrameLocator]s.
OptionalhasMatches elements containing specified text somewhere inside, possibly in a child or a descendant element. When
passed a [string], matching is case-insensitive and searches for a substring. For example, "Playwright" matches
<article><div>Playwright</div></article>.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Emitted when the page closes.
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:
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'}));
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 {
// Crash might happen during a click.
await page.click('button');
// Or while waiting for an event.
await page.waitForEvent('popup');
} catch (e) {
// When the page crashes, exception message contains 'crash'.
}
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
page.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when the JavaScript
DOMContentLoaded event is dispatched.
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.
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(files[, options])
that can be uploaded after that.
page.on('filechooser', async (fileChooser) => {
await fileChooser.setFiles('/tmp/myfile.pdf');
});
Emitted when a frame is attached.
Emitted when a frame is detached.
Emitted when a frame is navigated to a new url.
Emitted when the JavaScript load event is dispatched.
Emitted when an uncaught exception happens within the page.
// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
console.log(`Uncaught exception: "${exception}"`);
});
// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');
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.
// Start waiting for popup before clicking. Note no await.
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([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).
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.
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished.
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished.
Emitted when [WebSocket] request is sent.
Emitted when a dedicated WebWorker is spawned by the page.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.
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 value in the
browserType.launch([options]).
Returns the 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([options]) 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
// Generates a PDF with 'screen' media type.
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:
page.pdf({width: 100}) - prints with width set to 100 pixelspage.pdf({width: '100px'}) - prints with width set to 100 pixelspage.pdf({width: '10cm'}) - prints with width set to 10 centimeters.All possible units are:
px - pixelin - inchcm - centimetermm - millimeterThe format options are:
Letter: 8.5in x 11inLegal: 8.5in x 14inTabloid: 11in x 17inLedger: 17in x 11inA0: 33.1in x 46.8inA1: 23.4in x 33.1inA2: 16.54in x 23.4inA3: 11.7in x 16.54inA4: 8.27in x 11.7inA5: 5.83in x 8.27inA6: 4.13in x 5.83inNOTE headerTemplate and footerTemplate markup have the following limitations: > 1. Script tags inside
templates are not evaluated. > 2. Page styles are not visible inside templates.
Optionaloptions: { OptionaldisplayDisplay header and footer. Defaults to false.
OptionalfooterHTML template for the print footer. Should use the same format as the headerTemplate.
Optionalformat?: stringPaper format. If set, takes priority over width or height options. Defaults to 'Letter'.
OptionalheaderHTML 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 documentOptionalheight?: string | numberPaper height, accepts values labeled with units.
Optionallandscape?: booleanPaper orientation. Defaults to false.
Optionalmargin?: { Paper margins, defaults to none.
Optionalbottom?: string | numberBottom margin, accepts values labeled with units. Defaults to 0.
Optionalleft?: string | numberLeft margin, accepts values labeled with units. Defaults to 0.
Optionalright?: string | numberRight margin, accepts values labeled with units. Defaults to 0.
Optionaltop?: string | numberTop margin, accepts values labeled with units. Defaults to 0.
OptionalpagePaper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
Optionalpath?: stringThe file path to save the PDF to. If path is a relative path, then it is resolved relative to the current working
directory. If no path is provided, the PDF won't be saved to the disk.
OptionalpreferCSSPageGive 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.
OptionalprintPrint background graphics. Defaults to false.
Optionalscale?: numberScale of the webpage rendering. Defaults to 1. Scale amount must be between 0.1 and 2.
Optionalwidth?: string | numberPaper width, accepts values labeled with units.
Emitted when the page closes.
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:
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'}));
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 {
// Crash might happen during a click.
await page.click('button');
// Or while waiting for an event.
await page.waitForEvent('popup');
} catch (e) {
// When the page crashes, exception message contains 'crash'.
}
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
page.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.
Emitted when the JavaScript
DOMContentLoaded event is dispatched.
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.
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(files[, options])
that can be uploaded after that.
page.on('filechooser', async (fileChooser) => {
await fileChooser.setFiles('/tmp/myfile.pdf');
});
Emitted when a frame is attached.
Emitted when a frame is detached.
Emitted when a frame is navigated to a new url.
Emitted when the JavaScript load event is dispatched.
Emitted when an uncaught exception happens within the page.
// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
console.log(`Uncaught exception: "${exception}"`);
});
// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');
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.
// Start waiting for popup before clicking. Note no await.
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([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).
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.
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished.
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished.
Emitted when [WebSocket] request is sent.
Emitted when a dedicated WebWorker is spawned by the page.
NOTE Use locator-based locator.press(key[, options]) instead. Read more about locators.
Focuses the element, and then uses keyboard.down(key) and keyboard.up(key).
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.
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 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();
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Name of the key to press or a character to generate, such as ArrowLeft or a.
Optionaloptions: { Optionaldelay?: numberTime to wait between keydown and keyup in milliseconds. Defaults to 0.
OptionalnoActions 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.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
Removes an event listener added by on or addListener.
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(url, handler[, options]) will not
intercept requests intercepted by Service Worker. See this
issue. We recommend disabling Service Workers when using request interception by setting
Browser.newContext.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/**', route => {
if (route.request().postData().includes('my-string'))
route.fulfill({ body: 'mocked-data' });
else
route.continue();
});
Page routes take precedence over browser context routes (set up with browserContext.route(url, handler[, options])) when request matches both handlers.
To remove a route with its handler you can use page.unroute(url[, handler]).
NOTE Enabling routing disables http cache.
A glob pattern, regex pattern or predicate receiving [URL] to match while routing. When a baseURL via the context
options was provided and the passed URL is a path, it gets merged via the
new URL() constructor.
handler function to route the request.
Optionaloptions: { Optionaltimes?: numberHow often a route should be used. By default it will be used every time.
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 Browser.newContext.serviceWorkers to 'block'.
Path to a HAR file with prerecorded network data. If path is a
relative path, then it is resolved relative to the current working directory.
Optionaloptions: { OptionalnotDefaults to abort.
Optionalupdate?: booleanIf specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when browserContext.close() is called.
OptionalupdateOptional setting to control resource content management. If attach is specified, resources are persisted as
separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file.
OptionalupdateWhen set to minimal, only record information necessary for routing from HAR. This omits sizes, timing, page,
cookies, security and other types of HAR information that are not used when replaying from HAR. Defaults to full.
Optionalurl?: string | RegExpA glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.
NOTE Use locator-based locator.selectOption(values[, options]) instead. Read more about locators.
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
// single selection matching the value
page.selectOption('select#colors', 'blue');
// single selection matching the label
page.selectOption('select#colors', { label: 'Blue' });
// multiple selection
page.selectOption('select#colors', ['red', 'green', 'blue']);
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
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 matching both values and
labels. Option is considered matching if all specified properties match.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.setChecked(checked[, options]) instead. Read more about locators.
This method checks or unchecks an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Whether to check or uncheck the checkbox.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
HTML markup to assign to the page.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.This setting will change the default maximum navigation time for the following methods and related shortcuts:
NOTE page.setDefaultNavigationTimeout(timeout) takes priority over page.setDefaultTimeout(timeout), browserContext.setDefaultTimeout(timeout) and browserContext.setDefaultNavigationTimeout(timeout).
Maximum navigation time in milliseconds
This setting will change the default maximum time for all the methods accepting timeout option.
NOTE page.setDefaultNavigationTimeout(timeout) takes priority over page.setDefaultTimeout(timeout).
Maximum time in milliseconds
The extra HTTP headers will be sent with every request the page initiates.
NOTE page.setExtraHTTPHeaders(headers) does not guarantee the order of headers in the outgoing requests.
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
NOTE Use locator-based locator.setInputFiles(files[, options]) instead. Read more about locators.
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.
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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { OptionalnoActions 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.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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(viewportSize) 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(viewportSize) will also
reset screen size, use
browser.newContext([options]) 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');
page height in pixels.
page width in pixels.
NOTE Use locator-based locator.tap([options]) instead. Read more about locators.
This method taps an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.position.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.
NOTE page.tap(selector[, options]) the method will throw
if hasTouch option of the browser context is false.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
Optionalmodifiers?: (Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
NOTE Use locator-based locator.textContent([options]) instead. Read more about locators.
Returns element.textContent.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.type(text[, options]) instead. Read more about locators.
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(selector, value[, options]).
To press a special key, like Control or ArrowDown, use
keyboard.press(key[, options]).
Usage
await page.type('#mytextarea', 'Hello'); // Types instantly
await page.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
A text to type into a focused element.
Optionaloptions: { Optionaldelay?: numberTime to wait between key presses in milliseconds. Defaults to 0.
OptionalnoActions 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.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
NOTE Use locator-based locator.uncheck([options]) instead. Read more about locators.
This method unchecks an element matching selector by performing the following steps:
selector. If there is none, wait until a matching element is attached to the DOM.force option is set. If
the element is detached during the checks, the whole action is retried.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.
A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used.
Optionaloptions: { Optionalforce?: booleanWhether to bypass the actionability checks. Defaults to false.
OptionalnoActions 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.
Optionalposition?: { A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.
Optionalstrict?: booleanWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
Optionaltimeout?: numberMaximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout
option in the config, or by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionaltrial?: booleanWhen set, this method only performs the actionability checks and skips the action. Defaults
to false. Useful to wait until the element is ready for the action without performing it.
Removes a route created with
page.route(url, handler[, options]). When handler is not
specified, removes all routes for the url.
A glob pattern, regex pattern or predicate receiving [URL] to match while routing.
Optionalhandler: ((route: Route, request: Request) => any)Optional handler function to route the request.
Emitted when the page closes.
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:
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'}));
OptionaloptionsOrPredicate: { 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 {
// Crash might happen during a click.
await page.click('button');
// Or while waiting for an event.
await page.waitForEvent('popup');
} catch (e) {
// When the page crashes, exception message contains 'crash'.
}
Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must
either dialog.accept([promptText]) or
dialog.dismiss() the dialog - otherwise the page
will freeze waiting for the
dialog, and actions like click will never finish.
page.on('dialog', dialog => {
dialog.accept();
});
NOTE When no page.on('dialog') listeners are present, all dialogs are automatically dismissed.
OptionaloptionsOrPredicate: { Emitted when the JavaScript
DOMContentLoaded event is dispatched.
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.
OptionaloptionsOrPredicate: { 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(files[, options])
that can be uploaded after that.
page.on('filechooser', async (fileChooser) => {
await fileChooser.setFiles('/tmp/myfile.pdf');
});
OptionaloptionsOrPredicate: { Emitted when a frame is attached.
OptionaloptionsOrPredicate: { Emitted when a frame is detached.
OptionaloptionsOrPredicate: { Emitted when a frame is navigated to a new url.
OptionaloptionsOrPredicate: { Emitted when the JavaScript load event is dispatched.
Emitted when an uncaught exception happens within the page.
// Log all uncaught errors to the terminal
page.on('pageerror', exception => {
console.log(`Uncaught exception: "${exception}"`);
});
// Navigate to a page with an exception.
await page.goto('data:text/html,<script>throw new Error("Test")</script>');
OptionaloptionsOrPredicate: { 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.
// Start waiting for popup before clicking. Note no await.
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([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).
Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see page.route(url, handler[, options]) or browserContext.route(url, handler[, options]).
OptionaloptionsOrPredicate: { 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.
OptionaloptionsOrPredicate: { Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request, response and requestfinished.
OptionaloptionsOrPredicate: { Emitted when [response] status and headers are received for a request. For a successful response, the sequence of
events is request, response and requestfinished.
Emitted when [WebSocket] request is sent.
OptionaloptionsOrPredicate: { Emitted when a dedicated WebWorker is spawned by the page.
OptionaloptionsOrPredicate: { Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.
Usage
The page.waitForFunction(pageFunction[, arg, options]) can be used to observe viewport size change:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(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(pageFunction[, arg, options]) function:
const selector = '.foo';
await page.waitForFunction(selector => !!document.querySelector(selector), selector);
Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.
Usage
The page.waitForFunction(pageFunction[, arg, options]) can be used to observe viewport size change:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(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(pageFunction[, arg, options]) function:
const selector = '.foo';
await page.waitForFunction(selector => !!document.querySelector(selector), selector);
Function to be evaluated in the page context.
Optionalarg: anyOptional argument to pass to pageFunction.
Optionaloptions: PageWaitForFunctionOptionsReturns 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(); // Click triggers navigation.
await page.waitForLoadState(); // The promise resolves after 'load' event.
const popupPromise = page.waitForEvent('popup');
await page.getByRole('button').click(); // Click triggers a popup.
const popup = await popupPromise;
await popup.waitForLoadState('domcontentloaded'); // Wait for the 'DOMContentLoaded' event.
console.log(await popup.title()); // Popup is ready to use.
Optionalstate: "load" | "domcontentloaded" | "networkidle"Optional load state to wait for, defaults to load. If the state has been already reached while loading current
document, the method resolves immediately. Can be one of:
'load' - wait for the load event to be fired.'domcontentloaded' - wait for the DOMContentLoaded event to be fired.'networkidle' - wait until there are no network connections for at least 500 ms.Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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:
// Start waiting for navigation before clicking. Note no await.
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.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
Optionalurl?: string | RegExp | ((url: URL) => boolean)A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.This method is inherently racy, please use page.waitForURL(url[, options]) instead.
Waits for the matching request and returns it. See waiting for event for more details about events.
Usage
// Start waiting for request before clicking. Note no await.
const requestPromise = page.waitForRequest('https://example.com/resource');
await page.getByText('trigger request').click();
const request = await requestPromise;
// Alternative way with a predicate. Note no await.
const requestPromise = page.waitForRequest(request => request.url() === 'https://example.com' && request.method() === 'GET');
await page.getByText('trigger request').click();
const request = await requestPromise;
Request URL string, regex or predicate receiving [Request] object.
Optionaloptions: { Optionaltimeout?: numberMaximum wait time in milliseconds, defaults to 30 seconds, pass 0 to disable the timeout. The default value can
be changed by using the
page.setDefaultTimeout(timeout) method.
Returns the matched response. See waiting for event for more details about events.
Usage
// Start waiting for response before clicking. Note no await.
const responsePromise = page.waitForResponse('https://example.com/resource');
await page.getByText('trigger response').click();
const response = await responsePromise;
// Alternative way with a predicate. Note no await.
const responsePromise = page.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);
await page.getByText('trigger response').click();
const response = await responsePromise;
Request URL string, regex or predicate receiving [Response] object. When a baseURL via the context options was
provided and the passed URL is a path, it gets merged via the
new URL() constructor.
Optionaloptions: { Optionaltimeout?: numberMaximum wait time in milliseconds, defaults to 30 seconds, pass 0 to disable the timeout. The default value can
be changed by using the
browserContext.setDefaultTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
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'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
for (let 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();
})();
A selector to query for.
Optionaloptions: PageWaitForSelectorOptionsNotHiddenReturns 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'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
for (let 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();
})();
A selector to query for.
Optionaloptions: PageWaitForSelectorOptionsNotHiddenReturns 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'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
for (let 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();
})();
A selector to query for.
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'); // Or 'firefox' or 'webkit'.
(async () => {
const browser = await chromium.launch();
const page = await browser.newPage();
for (let 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();
})();
A selector to query for.
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
// wait for 1 second
await page.waitForTimeout(1000);
A timeout to wait for
Waits for the main frame to navigate to the given URL.
Usage
await page.click('a.delayed-navigation'); // Clicking the link will indirectly cause a navigation
await page.waitForURL('**/target.html');
A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.
Optionaloptions: { Optionaltimeout?: numberMaximum operation time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via
navigationTimeout option in the config, or by using the
browserContext.setDefaultNavigationTimeout(timeout),
browserContext.setDefaultTimeout(timeout),
page.setDefaultNavigationTimeout(timeout)
or page.setDefaultTimeout(timeout) methods.
OptionalwaitWhen to consider operation succeeded, defaults to load. Events can be either:
'domcontentloaded' - consider operation to be finished when the DOMContentLoaded event is fired.'load' - consider operation to be finished when the load event is fired.'networkidle' - consider operation to be finished when there are no network connections for at least 500
ms.'commit' - consider operation to be finished when network response is received and the document started
loading.This method returns all of the dedicated WebWorkers associated with the page.
NOTE This does not contain ServiceWorkers
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:
The Page class emits various events (described below) which can be handled using any of Node's native
EventEmittermethods, such ason,onceorremoveListener.This example logs a message for a single page
loadevent:To unsubscribe from events use the
removeListenermethod: