Playwright::Page
Page provides methods to interact with a single tab in a Browser, or an extension background page in Chromium. One Browser instance might have multiple Page instances. This example creates a page, navigates it to a URL, and then saves a screenshot:
The Page class emits various events (described below) which can be handled using any of Node's native EventEmitter methods, such as on, once or removeListener.
This example logs a message for a single page load event:
To unsubscribe from events use the removeListener method:
Instance methods
Adds a script which would be evaluated in one of the following scenarios:
Whenever the page is navigated. Whenever the child frame is attached or navigated. In this case, the script is evaluated in the context of the newly attached frame.
The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.
An example of overriding Math.random before the page loads:
NOTE The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.
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.
Shortcut for main frame's frame.addScriptTag(params).
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.
Shortcut for main frame's frame.addStyleTag(params).
This method checks an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already checked, this method returns immediately.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.mouse to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
Ensure that the element is now checked. If not, this method rejects.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.check(selector[, options]).
This method clicks an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.mouse to click in the center of the element, or the specified position.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.click(selector[, options]).
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.
This method double clicks an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.mouse to double click in the center of the element, or the specified position.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set. Note that if the first click of the dblclick() triggers a navigation event, this method will reject.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
NOTE page.dblclick() dispatches two click events and a single dblclick event.
Shortcut for main frame's frame.dblclick(selector[, options]).
The snippet below dispatches the click event on the element. Regardless of the visibility state of the elment, click is dispatched. This is equivalend to calling element.click().
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:
DragEvent FocusEvent KeyboardEvent MouseEvent PointerEvent TouchEvent Event
You can also specify JSHandle as the property value if you want live objects to be passed into the event:
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]) would wait for the promise to resolve and return its value.
Examples:
Shortcut for main frame's frame.$eval(selector, pageFunction[, arg]).
The method finds all elements matching the specified selector within the page and passes an array of matched elements as a first argument to pageFunction. 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.
Examples:
Returns the value of the pageFunction invacation.
If the function passed to the page.evaluate returns a Promise, then page.evaluate would wait for the promise to resolve and return its value.
If the function passed to the page.evaluate returns a non-Serializable value, then page.evaluate resolves to undefined. DevTools Protocol also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity, and bigint literals.
Passing argument to pageFunction:
A string can also be passed in instead of a function:
ElementHandle instances can be passed as an argument to the page.evaluate:
Shortcut for main frame's frame.evaluate(pageFunction[, arg]).
Returns the value of the pageFunction invacation as in-page object (JSHandle).
The only difference between page.evaluate and page.evaluateHandle is that page.evaluateHandle returns in-page object (JSHandle).
If the function passed to the page.evaluateHandle returns a Promise, then page.evaluateHandle would wait for the promise to resolve and return its value.
A string can also be passed in instead of a function:
JSHandle instances can be passed as an argument to the page.evaluateHandle:
The method adds a function called name on the window object of every frame in this page. When called, the function executes playwrightBinding and returns a Promise which resolves to the return value of playwrightBinding. If the playwrightBinding returns a Promise, it will be awaited.
The first argument of the playwrightBinding function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.
See browserContext.exposeBinding(name, playwrightBinding[, options]) for the context-wide version.
NOTE Functions installed via page.exposeBinding survive navigations.
An example of exposing page URL to all frames in a page:
An example of passing an element handle:
The method adds a function called name on the window object of every frame in the page. When called, the function executes playwrightFunction and returns a Promise which resolves to the return value of playwrightFunction.
If the playwrightFunction returns a Promise, it will be awaited.
See browserContext.exposeFunction(name, playwrightFunction) for context-wide exposed function.
NOTE Functions installed via page.exposeFunction survive navigations.
An example of adding an md5 function to the page:
An example of adding a window.readfile function to the page:
This method waits for an element matching selector, waits for actionability checks, focuses the element, fills it and triggers an input event after filling. If the element matching selector is not an <input>, <textarea> or [contenteditable] element, this method throws an error. Note that you can pass an empty string to clear the input field.
To send fine-grained keyboard events, use page.type(selector, text[, options]).
Shortcut for main frame's frame.fill(selector, value[, options])
This method fetches an element with selector and focuses it. If there's no element matching selector, the method waits until a matching element appears in the DOM.
Shortcut for main frame's frame.focus(selector[, options]).
Returns frame matching the specified criteria. Either name or url must be specified.
Returns element attribute value.
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.
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.
This method hovers over an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.mouse to hover over the center of the element, or the specified position.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.hover(selector[, options]).
Returns element.innerHTML.
Returns element.innerText.
The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
Returns the opener for popup pages and null for others. If the opener has been closed already the returns null.
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(params) 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.
The width, height, and margin options accept values labeled with units. Unlabeled values are treated as pixels.
A few examples:
page.pdf({width: 100}) - prints with width set to 100 pixels
page.pdf({width: '100px'}) - prints with width set to 100 pixels
page.pdf({width: '10cm'}) - prints with width set to 10 centimeters.
All possible units are:
px - pixel
in - inch
cm - centimeter
mm - millimeter
The format options are:
Letter: 8.5in x 11in
Legal: 8.5in x 14in
Tabloid: 11in x 17in
Ledger: 17in x 11in
A0: 33.1in x 46.8in
A1: 23.4in x 33.1in
A2: 16.54in x 23.4in
A3: 11.7in x 16.54in
A4: 8.27in x 11.7in
A5: 5.83in x 8.27in
A6: 4.13in x 5.83in
NOTE headerTemplate and footerTemplate markup have the following limitations:
Script tags inside templates are not evaluated. Page styles are not visible inside templates.
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 suported: Shift, Control, Alt, Meta, ShiftLeft.
Holding down Shift will type the text that corresponds to the key in the upper case.
If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.
Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
The method finds an element matching the specified selector within the page. If no elements match the selector, the return value resolves to null.
Shortcut for main frame's frame.$(selector).
The method finds all elements matching the specified selector within the page. If no elements match the selector, the return value resolves to [].
Shortcut for main frame's frame.$$(selector).
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
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.
An example of a naïve handler that aborts all image requests:
or the same snippet using a regex pattern instead:
Page routes take precedence over browser context routes (set up with browserContext.route(url, handler)) when request matches both handlers.
NOTE Enabling routing disables http cache.
Returns the buffer with the captured screenshot.
NOTE Screenshots take at least 1/6 second on Chromium OS X and Chromium Windows. See https://crbug.com/741689 for discussion.
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).
The extra HTTP headers will be sent with every request the page initiates.
NOTE page.setExtraHTTPHeaders does not guarantee the order of headers in the outgoing requests.
This method expects selector to point to an input element.
Sets the value of the file input to these file paths or files. If some of the filePaths are relative paths, then they are resolved relative to the the current working directory. For empty array, clears the selected files.
In the case of multiple pages in a single browser, each page can have its own viewport size. However, browser.newContext([options]) allows to set viewport size (and more) for all pages in the context at once.
page.setViewportSize will resize the page. A lot of websites don't expect phones to change size, so you should set the viewport size before navigating to the page.
This method taps an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.touchscreen to tap the center of the element, or the specified position.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
NOTE page.tap() requires that the hasTouch option of the browser context be set to true.
Shortcut for main frame's frame.tap(selector[, options]).
Returns element.textContent.
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]).
Shortcut for main frame's frame.type(selector, text[, options]).
This method unchecks an element matching selector by performing the following steps:
Find an element match matching selector. If there is none, wait until a matching element is attached to the DOM.
Ensure that matched element is a checkbox or a radio input. If not, this method rejects. If the element is already unchecked, this method returns immediately.
Wait for actionability checks on the matched element, unless force option is set. If the element is detached during the checks, the whole action is retried.
Scroll the element into view if needed.
Use page.mouse to click in the center of the element.
Wait for initiated navigations to either succeed or fail, unless noWaitAfter option is set.
Ensure that the element is now unchecked. If not, this method rejects.
When all steps combined have not finished during the specified timeout, this method rejects with a TimeoutError. Passing zero timeout disables this.
Shortcut for main frame's frame.uncheck(selector[, options]).
Removes a route created with page.route(url, handler). When handler is not specified, removes all routes for the url.
Returns the event data value. Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the page is closed before the event is fired.
Returns when the pageFunction returns a truthy value. It resolves to a JSHandle of the truthy value.
The waitForFunction can be used to observe viewport size change:
To pass an argument to the predicate of page.waitForFunction function:
Shortcut for main frame's frame.waitForFunction(pageFunction[, arg, options]).
Returns when the required load state has been reached.
This resolves when the page reaches a required load state, load by default. The navigation must have been committed when this method is called. If current document has already reached the required state, resolves immediately.
Shortcut for main frame's frame.waitForLoadState([state, options]).
Returns when element specified by selector satisfies state option. Returns null if waiting for hidden or detached.
Wait for the selector to satisfy state option (either appear/disappear from dom, or become visible/hidden). If at the moment of calling the method selector already satisfies the condition, the method will return immediately. If the selector doesn't satisfy the condition for the timeout milliseconds, the function will throw.
This method works across navigations:
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.
Shortcut for main frame's frame.waitForTimeout(timeout).
This method returns all of the dedicated WebWorkers associated with the page.
NOTE This does not contain ServiceWorkers
Nested types
- Playwright::Page::AddScriptTagParams
- Playwright::Page::AddStyleTagParams
- Playwright::Page::Binding
- Playwright::Page::CheckOptions
- Playwright::Page::ClickOptions
- Playwright::Page::CloseOptions
- Playwright::Page::DblclickOptions
- Playwright::Page::DispatchEventOptions
- Playwright::Page::EmulateMediaParams
- Playwright::Page::Error
- Playwright::Page::EventType
- Playwright::Page::ExposeBindingOptions
- Playwright::Page::FillOptions
- Playwright::Page::FocusOptions
- Playwright::Page::Function
- Playwright::Page::GetAttributeOptions
- Playwright::Page::GoBackOptions
- Playwright::Page::GoForwardOptions
- Playwright::Page::HoverOptions
- Playwright::Page::InnerHTMLOptions
- Playwright::Page::InnerTextOptions
- Playwright::Page::LoadState
- Playwright::Page::NavigateOptions
- Playwright::Page::PdfOptions
- Playwright::Page::PressOptions
- Playwright::Page::ReloadOptions
- Playwright::Page::ScreenshotOptions
- Playwright::Page::SelectOptionOptions
- Playwright::Page::SetContentOptions
- Playwright::Page::SetInputFilesOptions
- Playwright::Page::TapOptions
- Playwright::Page::TextContentOptions
- Playwright::Page::TypeOptions
- Playwright::Page::UncheckOptions
- Playwright::Page::ViewPort
- Playwright::Page::WaitForEventOptions
- Playwright::Page::WaitForFunctionOptions
- Playwright::Page::WaitForLoadStateOptions
- Playwright::Page::WaitForNavigationOptions
- Playwright::Page::WaitForRequestOptions
- Playwright::Page::WaitForResponseOptions
- Playwright::Page::WaitForSelectorOptions