- extends: [EventEmitter]
Page provides methods to interact with a single tab in a [Browser], or an extension background page in Chromium. One [Browser] instance might have multiple [Page] instances.
This example creates a page, navigates it to a URL, and then saves a screenshot:
const { webkit } = require('playwright'); // Or 'chromium' or 'firefox'.
(async () => {
const browser = await webkit.launch();
const context = await browser.newContext();
const page = await context.newPage();
await page.goto('https://example.com');
await page.screenshot({path: 'screenshot.png'});
await browser.close();
})();
import asyncio
from playwright.async_api import async_playwright
async def run(playwright):
webkit = playwright.webkit
browser = await webkit.launch()
context = await browser.new_context()
page = await context.new_page()
await page.goto("https://example.com")
await page.screenshot(path="screenshot.png")
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
from playwright.sync_api import sync_playwright
def run(playwright):
webkit = playwright.webkit
browser = webkit.launch()
context = browser.new_context()
page = context.new_page()
page.goto("https://example.com")
page.screenshot(path="screenshot.png")
browser.close()
with sync_playwright() as playwright:
run(playwright)
The Page class emits various events (described below) which can be handled using any of Node's native
EventEmitter
methods, such as on
, once
or
removeListener
.
This example logs a message for a single page load
event:
page.once('load', () => console.log('Page loaded!'));
page.once("load", lambda: print("page loaded!"))
To unsubscribe from events use the removeListener
method:
function logRequest(interceptedRequest) {
console.log('A request was made:', interceptedRequest.url());
}
page.on('request', logRequest);
// Sometime later...
page.removeListener('request', logRequest);
def log_request(intercepted_request):
print("a request was made:", intercepted_request.url)
page.on("request", log_request)
# sometime later...
page.remove_listener("request", log_request)
- type: <[Page]>
Emitted when the page closes.
- type: <[ConsoleMessage]>
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', msg => {
for (let i = 0; i < msg.args().length; ++i)
console.log(`${i}: ${await msg.args()[i].jsonValue()}`);
});
page.evaluate(() => console.log('hello', 5, {foo: 'bar'}));
async def print_args(msg):
for arg in msg.args:
print(await arg.json_value())
page.on("console", print_args)
await page.evaluate("console.log('hello', 5, {foo: 'bar'})")
def print_args(msg):
for arg in msg.args:
print(arg.json_value())
page.on("console", print_args)
page.evaluate("console.log('hello', 5, {foo: 'bar'})")
- type: <[Page]>
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'.
}
try:
# crash might happen during a click.
await page.click("button")
# or while waiting for an event.
await page.wait_for_event("popup")
except Error as e:
# when the page crashes, exception message contains "crash".
try:
# crash might happen during a click.
page.click("button")
# or while waiting for an event.
page.wait_for_event("popup")
except Error as e:
# when the page crashes, exception message contains "crash".
- type: <[Dialog]>
Emitted when a JavaScript dialog appears, such as alert
, prompt
, confirm
or beforeunload
. Playwright can respond
to the dialog via [method: Dialog.accept
] or [method: Dialog.dismiss
] methods.
- type: <[Page]>
Emitted when the JavaScript DOMContentLoaded
event is dispatched.
- type: <[Download]>
Emitted when attachment download started. User can access basic file operations on downloaded content via the passed [Download] instance.
:::note
Browser context must be created with the [option: acceptDownloads
] set to true
when user needs access to the
downloaded content. If [option: acceptDownloads
] is not set, download events are emitted, but the actual download is
not performed and user has no access to the downloaded files.
:::
- type: <[FileChooser]>
Emitted when a file chooser is supposed to appear, such as after clicking the <input type=file>
. Playwright can
respond to it via setting the input files using [method: FileChooser.setFiles
] that can be uploaded after that.
page.on('filechooser', async (fileChooser) => {
await fileChooser.setFiles('/tmp/myfile.pdf');
});
page.on("filechooser", lambda file_chooser: file_chooser.set_files("/tmp/myfile.pdf"))
- type: <[Frame]>
Emitted when a frame is attached.
- type: <[Frame]>
Emitted when a frame is detached.
- type: <[Frame]>
Emitted when a frame is navigated to a new url.
- type: <[Page]>
Emitted when the JavaScript load
event is dispatched.
- type: <[Error]>
Emitted when an uncaught exception happens within the page.
- type: <[Page]>
Emitted when the page opens a new tab or window. This event is emitted in addition to the
[event: BrowserContext.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.
const [popup] = await Promise.all([
page.waitForEvent('popup'),
page.evaluate(() => window.open('https://example.com')),
]);
console.log(await popup.evaluate('location.href'));
async with page.expect_event("popup") as page_info:
page.evaluate("window.open('https://example.com')")
popup = await page_info.value
print(await popup.evaluate("location.href"))
with page.expect_event("popup") as page_info:
page.evaluate("window.open('https://example.com')")
popup = page_info.value
print(popup.evaluate("location.href"))
:::note
Use [method: Page.waitForLoadState
] to wait until the page gets to a particular state (you should not need it in most
cases).
:::
- type: <[Request]>
Emitted when a page issues a request. The [request] object is read-only. In order to intercept and mutate requests, see
[method: Page.route
] or [method: BrowserContext.route
].
- type: <[Request]>
Emitted when a request fails, for example by timing out.
:::note
HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete
with [event: Page.requestfinished
] event and not with [event: Page.requestfailed
].
:::
- type: <[Request]>
Emitted when a request finishes successfully after downloading the response body. For a successful response, the
sequence of events is request
, response
and requestfinished
.
- type: <[Response]>
Emitted when [response] status and headers are received for a request. For a successful response, the sequence of events
is request
, response
and requestfinished
.
- type: <[WebSocket]>
Emitted when <[WebSocket]> request is sent.
- type: <[Worker]>
Emitted when a dedicated WebWorker is spawned by the page.
- langs:
- alias-python: query_selector
- returns: <[null]|[ElementHandle]>
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 [method: Frame.$
].
- langs:
- alias-python: query_selector_all
- returns: <[Array]<[ElementHandle]>>
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 [method: Frame.$$
].
- langs:
- alias-python: eval_on_selector
- returns: <[Serializable]>
The method finds an element matching the specified selector within the page and passes it as a first argument to
[param: pageFunction
]. If no elements match the selector, the method throws an error. Returns the value of
[param: pageFunction
].
If [param: pageFunction
] returns a [Promise], then [method: Page.$eval
] would wait for the promise to resolve and
return its value.
Examples:
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');
search_value = await page.eval_on_selector("#search", "el => el.value")
preload_href = await page.eval_on_selector("link[rel=preload]", "el => el.href")
html = await page.eval_on_selector(".main-container", "(e, suffix) => e.outer_html + suffix", "hello")
search_value = page.eval_on_selector("#search", "el => el.value")
preload_href = page.eval_on_selector("link[rel=preload]", "el => el.href")
html = page.eval_on_selector(".main-container", "(e, suffix) => e.outer_html + suffix", "hello")
Shortcut for main frame's [method: Frame.$eval
].
- langs: js
pageFunction
<[function]([Element])>
Function to be evaluated in browser context
arg
<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction
]
- langs:
- alias-python: eval_on_selector_all
- returns: <[Serializable]>
The method finds all elements matching the specified selector within the page and passes an array of matched elements as
a first argument to [param: pageFunction
]. Returns the result of [param: pageFunction
] invocation.
If [param: pageFunction
] returns a [Promise], then [method: Page.$$eval
] would wait for the promise to resolve and
return its value.
Examples:
const divCounts = await page.$$eval('div', (divs, min) => divs.length >= min, 10);
div_counts = await page.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)
div_counts = page.eval_on_selector_all("div", "(divs, min) => divs.length >= min", 10)
- langs: js
pageFunction
<[function]([Array]<[Element]>)>
Function to be evaluated in browser context
arg
<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction
]
- type: <[Accessibility]>
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:
// preload.js
Math.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory
await page.addInitScript({ path: './preload.js' });
# in your playwright script, assuming the preload.js file is in same directory
await page.add_init_script(path="./preload.js")
# in your playwright script, assuming the preload.js file is in same directory
page.add_init_script(path="./preload.js")
:::note
The order of evaluation of multiple scripts installed via [method: BrowserContext.addInitScript
] and
[method: Page.addInitScript
] is not defined.
:::
- langs: js
script
<[function]|[string]|[Object]>path
<[path]> Path to the JavaScript file. Ifpath
is a relative path, then it is resolved relative to the current working directory. Optional.content
<[string]> Raw script content. Optional.
Script to be evaluated in the page.
- langs: js
arg
<[Serializable]>
Optional argument to pass to [param: script
] (only supported when passing a function).
- returns: <[ElementHandle]>
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 [method: Frame.addScriptTag
].
url
<[string]>
URL of a script to be added.
path
<[path]>
Path 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.
content
<[string]>
Raw JavaScript content to be injected into frame.
type
<[string]>
Script type. Use 'module' in order to load a Javascript ES6 module. See script for more details.
- returns: <[ElementHandle]>
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 [method: Frame.addStyleTag
].
url
<[string]>
URL of the <link>
tag.
path
<[path]>
Path 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.
content
<[string]>
Raw CSS content to be injected into frame.
Brings page to front (activates tab).
This method checks an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: 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 [
option: 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 [
property: Page.mouse
] to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless [
option: 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 [option: timeout
], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
Shortcut for main frame's [method: Frame.check
].
This method clicks an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: selector
]. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless [
option: 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 [
property: Page.mouse
] to click in the center of the element, or the specified [option: position
]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter
] option is set.
When all steps combined have not finished during the specified [option: timeout
], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
Shortcut for main frame's [method: Frame.click
].
If [option: runBeforeUnload
] is false
, does not run any unload handlers and waits for the page to be closed. If
[option: 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 [option: runBeforeUnload
] is passed as true, a beforeunload
dialog might be summoned and should be handled
manually via [event: Page.dialog
] event.
:::
runBeforeUnload
<[boolean]>
Defaults to false
. Whether to run the
before unload page handlers.
- returns: <[string]>
Gets the full HTML contents of the page, including the doctype.
- returns: <[BrowserContext]>
Get the browser context that the page belongs to.
- langs: js
- type: <[null]|[ChromiumCoverage]>
Browser-specific Coverage implementation, only available for Chromium atm. See ChromiumCoverage for more details.
This method double clicks an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: selector
]. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless [
option: 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 [
property: Page.mouse
] to double click in the center of the element, or the specified [option: position
]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter
] option is set. Note that if the first click of thedblclick()
triggers a navigation event, this method will reject.
When all steps combined have not finished during the specified [option: 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 [method: Frame.dblclick
].
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().
await page.dispatchEvent('button#submit', 'click');
await page.dispatch_event("button#submit", "click")
page.dispatch_event("button#submit", "click")
Under the hood, it creates an instance of an event based on the given [param: type
], initializes it with
[param: eventInit
] properties and dispatches it on the element. Events are composed
, cancelable
and bubble by
default.
Since [param: 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 });
# note you can only create data_transfer in chromium and firefox
data_transfer = await page.evaluate_handle("new DataTransfer()")
await page.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })
# note you can only create data_transfer in chromium and firefox
data_transfer = page.evaluate_handle("new DataTransfer()")
page.dispatch_event("#source", "dragstart", { "dataTransfer": data_transfer })
type
<[string]>
DOM event type: "click"
, "dragstart"
, etc.
eventInit
<[EvaluationArgument]>
Optional event-specific initialization properties.
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.evaluate("matchMedia('screen').matches")
# → True
await page.evaluate("matchMedia('print').matches")
# → False
await page.emulate_media(media="print")
await page.evaluate("matchMedia('screen').matches")
# → False
await page.evaluate("matchMedia('print').matches")
# → True
await page.emulate_media()
await page.evaluate("matchMedia('screen').matches")
# → True
await page.evaluate("matchMedia('print').matches")
# → False
page.evaluate("matchMedia('screen').matches")
# → True
page.evaluate("matchMedia('print').matches")
# → False
page.emulate_media(media="print")
page.evaluate("matchMedia('screen').matches")
# → False
page.evaluate("matchMedia('print').matches")
# → True
page.emulate_media()
page.evaluate("matchMedia('screen').matches")
# → True
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
await page.emulate_media(color_scheme="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
page.emulate_media(color_scheme="dark")
page.evaluate("matchMedia('(prefers-color-scheme: dark)').matches")
# → True
page.evaluate("matchMedia('(prefers-color-scheme: light)').matches")
# → False
page.evaluate("matchMedia('(prefers-color-scheme: no-preference)').matches")
media
<[null]|"screen"|"print">
Changes the CSS media type of the page. The only allowed values are 'screen'
, 'print'
and null
.
Passing null
disables CSS media emulation.
colorScheme
<[null]|"light"|"dark"|"no-preference">
Emulates 'prefers-colors-scheme'
media feature, supported values are 'light'
, 'dark'
, 'no-preference'
. Passing
null
disables color scheme emulation.
- returns: <[Serializable]>
Returns the value of the [param: pageFunction
] invocation.
If the function passed to the [method: Page.evaluate
] returns a [Promise], then [method: Page.evaluate
] would wait
for the promise to resolve and return its value.
If the function passed to the [method: Page.evaluate
] returns a non-[Serializable] value, then
[method: 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 [param: pageFunction
]:
const result = await page.evaluate(([x, y]) => {
return Promise.resolve(x * y);
}, [7, 8]);
console.log(result); // prints "56"
result = await page.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
print(result) # prints "56"
result = page.evaluate("([x, y]) => Promise.resolve(x * y)", [7, 8])
print(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"
print(await page.evaluate("1 + 2")) # prints "3"
x = 10
print(await page.evaluate(f"1 + {x}")) # prints "11"
print(page.evaluate("1 + 2")) # prints "3"
x = 10
print(page.evaluate(f"1 + {x}")) # prints "11"
[ElementHandle] instances can be passed as an argument to the [method: Page.evaluate
]:
const bodyHandle = await page.$('body');
const html = await page.evaluate(([body, suffix]) => body.innerHTML + suffix, [bodyHandle, 'hello']);
await bodyHandle.dispose();
body_handle = await page.query_selector("body")
html = await page.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
await body_handle.dispose()
body_handle = page.query_selector("body")
html = page.evaluate("([body, suffix]) => body.innerHTML + suffix", [body_handle, "hello"])
body_handle.dispose()
Shortcut for main frame's [method: Frame.evaluate
].
- langs: js
pageFunction
<[function]|[string]>
Function to be evaluated in the page context
arg
<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction
]
- returns: <[JSHandle]>
Returns the value of the [param: pageFunction
] invocation as in-page object (JSHandle).
The only difference between [method: Page.evaluate
] and [method: Page.evaluateHandle
] is that [method: Page.evaluateHandle
] returns in-page
object (JSHandle).
If the function passed to the [method: Page.evaluateHandle
] returns a [Promise], then [method: Page.evaluateHandle
] would wait for the
promise to resolve and return its value.
const aWindowHandle = await page.evaluateHandle(() => Promise.resolve(window));
aWindowHandle; // Handle for the window object.
a_window_handle = await page.evaluate_handle("Promise.resolve(window)")
a_window_handle # handle for the window object.
a_window_handle = page.evaluate_handle("Promise.resolve(window)")
a_window_handle # 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'
a_handle = await page.evaluate_handle("document") # handle for the "document"
a_handle = page.evaluate_handle("document") # handle for the "document"
[JSHandle] instances can be passed as an argument to the [method: Page.evaluateHandle
]:
const aHandle = await page.evaluateHandle(() => document.body);
const resultHandle = await page.evaluateHandle(body => body.innerHTML, aHandle);
console.log(await resultHandle.jsonValue());
await resultHandle.dispose();
a_handle = await page.evaluate_handle("document.body")
result_handle = await page.evaluate_handle("body => body.innerHTML", a_handle)
print(await result_handle.json_value())
await result_handle.dispose()
a_handle = page.evaluate_handle("document.body")
result_handle = page.evaluate_handle("body => body.innerHTML", a_handle)
print(result_handle.json_value())
result_handle.dispose()
- langs: js
pageFunction
<[function]|[string]>
Function to be evaluated in the page context
arg
<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction
]
The method adds a function called [param: name
] on the window
object of every frame in this page. When called, the
function executes [param: callback
] and returns a [Promise] which resolves to the return value of [param: callback
].
If the [param: callback
] returns a [Promise], it will be awaited.
The first argument of the [param: callback
] function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }
.
See [method: BrowserContext.exposeBinding
] for the context-wide version.
:::note
Functions installed via [method: Page.exposeBinding
] survive navigations.
:::
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');
})();
import asyncio
from playwright.async_api import async_playwright
async def run(playwright):
webkit = playwright.webkit
browser = await webkit.launch(headless=false)
context = await browser.new_context()
page = await context.new_page()
await page.expose_binding("pageURL", lambda source: source["page"].url)
await page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
await page.click("button")
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
from playwright.sync_api import sync_playwright
def run(playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=false)
context = browser.new_context()
page = context.new_page()
page.expose_binding("pageURL", lambda source: source["page"].url)
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.pageURL();
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.click("button")
with sync_playwright() as playwright:
run(playwright)
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>
`);
async def print(source, element):
print(await element.text_content())
await page.expose_binding("clicked", print, handle=true)
await page.set_content("""
<script>
document.addEventListener('click', event => window.clicked(event.target));
</script>
<div>Click me</div>
<div>Or click me</div>
""")
def print(source, element):
print(element.text_content())
page.expose_binding("clicked", print, handle=true)
page.set_content("""
<script>
document.addEventListener('click', event => window.clicked(event.target));
</script>
<div>Click me</div>
<div>Or click me</div>
""")
name
<[string]>
Name of the function on the window object.
callback
<[function]>
Callback function that will be called in the Playwright's context.
handle
<[boolean]>
Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
The method adds a function called [param: name
] on the window
object of every frame in the page. When called, the
function executes [param: callback
] and returns a [Promise] which resolves to the return value of [param: callback
].
If the [param: callback
] returns a [Promise], it will be awaited.
See [method: BrowserContext.exposeFunction
] for context-wide exposed function.
:::note
Functions installed via [method: Page.exposeFunction
] survive navigations.
:::
An example of adding an sha1
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('sha1', text => crypto.createHash('sha1').update(text).digest('hex'));
await page.setContent(`
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
`);
await page.click('button');
})();
import asyncio
import hashlib
from playwright.async_api import async_playwright
async def sha1(text):
m = hashlib.sha1()
m.update(bytes(text, "utf8"))
return m.hexdigest()
async def run(playwright):
webkit = playwright.webkit
browser = await webkit.launch(headless=False)
page = await browser.new_page()
await page.expose_function("sha1", sha1)
await page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
await page.click("button")
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
import hashlib
from playwright.sync_api import sync_playwright
def sha1(text):
m = hashlib.sha1()
m.update(bytes(text, "utf8"))
return m.hexdigest()
def run(playwright):
webkit = playwright.webkit
browser = webkit.launch(headless=False)
page = browser.new_page()
page.expose_function("sha1", sha1)
page.set_content("""
<script>
async function onClick() {
document.querySelector('div').textContent = await window.sha1('PLAYWRIGHT');
}
</script>
<button onclick="onClick()">Click me</button>
<div></div>
""")
page.click("button")
with sync_playwright() as playwright:
run(playwright)
name
<[string]>
Name of the function on the window object
callback
<[function]>
Callback function which will be called in Playwright's context.
This method waits for an element matching [param: selector
], waits for actionability checks, focuses the element, fills it and triggers an input
event after filling.
If the element is inside the <label>
element that has associated control, that control will be filled instead.
If the element to be filled 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 [method: Page.type
].
Shortcut for main frame's [method: Frame.fill
]
value
<[string]>
Value to fill for the <input>
, <textarea>
or [contenteditable]
element.
This method fetches an element with [param: selector
] and focuses it. If there's no element matching
[param: selector
], the method waits until a matching element appears in the DOM.
Shortcut for main frame's [method: Frame.focus
].
- returns: <[null]|[Frame]>
Returns frame matching the specified criteria. Either name
or url
must be specified.
const frame = page.frame('frame-name');
frame = page.frame(name="frame-name")
const frame = page.frame({ url: /.*domain.*/ });
frame = page.frame(url=r".*domain.*")
- langs: js
frameSelector
<[string]|[Object]>name
<[string]> Frame name specified in theiframe
'sname
attribute. Optional.url
<[string]|[RegExp]|[function]([URL]):[boolean]> A glob pattern, regex pattern or predicate receiving frame'surl
as a [URL] object. Optional.
Frame name or other frame lookup options.
- returns: <[Array]<[Frame]>>
An array of all frames attached to the page.
- returns: <[null]|[string]>
Returns element attribute value.
name
<[string]>
Attribute name to get the value for.
- returns: <[null]|[Response]>
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: <[null]|[Response]>
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.
- returns: <[null]|[Response]>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect.
page.goto
will throw an error if:
- there's an SSL error (e.g. in case of self-signed certificates).
- target URL is invalid.
- the [
option: timeout
] is exceeded during navigation. - the remote server does not respond or is unreachable.
- the main resource failed to load.
page.goto
will not throw an error when any valid HTTP status code is returned by the remote server, including 404 "Not
Found" and 500 "Internal Server Error". The status code for such responses can be retrieved by calling
[method: Response.status
].
:::note
page.goto
either throws an error or returns a main resource response. The only exceptions are navigation to
about:blank
or navigation to the same URL with a different hash, which would succeed and return null
.
:::
:::note Headless mode doesn't support navigation to a PDF document. See the upstream issue. :::
Shortcut for main frame's [method: Frame.goto
]
url
<[string]>
URL to navigate page to. The url should include scheme, e.g. https://
.
referer
<[string]>
Referer header value. If provided it will take preference over the referer header value set by
[method: Page.setExtraHTTPHeaders
].
This method hovers over an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: selector
]. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless [
option: 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 [
property: Page.mouse
] to hover over the center of the element, or the specified [option: 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 [option: timeout
], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
Shortcut for main frame's [method: Frame.hover
].
- returns: <[string]>
Returns element.innerHTML
.
- returns: <[string]>
Returns element.innerText
.
- returns: <[boolean]>
Returns whether the element is checked. Throws if the element is not a checkbox or radio input.
- returns: <[boolean]>
Indicates that the page has been closed.
- returns: <[boolean]>
Returns whether the element is disabled, the opposite of enabled.
- returns: <[boolean]>
Returns whether the element is editable.
- returns: <[boolean]>
Returns whether the element is enabled.
async method: Page.isHidden
- returns: <[boolean]>
Returns whether the element is hidden, the opposite of visible.
param: Page.isHidden.selector = %%-input-selector-%%
option: Page.isHidden.timeout = %%-input-timeout-%%
- returns: <[boolean]>
Returns whether the element is visible.
- type: <[Keyboard]>
- returns: <[Frame]>
The page's main frame. Page is guaranteed to have a main frame which persists during navigations.
- type: <[Mouse]>
- returns: <[null]|[Page]>
Returns the opener for popup pages and null
for others. If the opener has been closed already the returns null
.
- returns: <[Buffer]>
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
[method: Page.emulateMedia
] before calling page.pdf()
:
:::note
By default, page.pdf()
generates a pdf with modified colors for printing. Use the
-webkit-print-color-adjust
property to
force rendering of exact colors.
:::
// Generates a PDF with 'screen' media type.
await page.emulateMedia({media: 'screen'});
await page.pdf({path: 'page.pdf'});
# generates a pdf with "screen" media type.
await page.emulate_media(media="screen")
await page.pdf(path="page.pdf")
# generates a pdf with "screen" media type.
page.emulate_media(media="screen")
page.pdf(path="page.pdf")
The [option: width
], [option: height
], and [option: 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
- millimeter
The [option: 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.83in
:::note
[option: headerTemplate
] and [option: footerTemplate
] markup have the following limitations: > 1. Script tags inside
templates are not evaluated. > 2. Page styles are not visible inside templates.
:::
path
<[path]>
The file path to save the PDF to. If [option: 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.
scale
<[float]>
Scale of the webpage rendering. Defaults to 1
. Scale amount must be between 0.1 and 2.
displayHeaderFooter
<[boolean]>
Display header and footer. Defaults to false
.
headerTemplate
<[string]>
HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:
'date'
formatted print date'title'
document title'url'
document location'pageNumber'
current page number'totalPages'
total pages in the document
footerTemplate
<[string]>
HTML template for the print footer. Should use the same format as the [option: headerTemplate
].
printBackground
<[boolean]>
Print background graphics. Defaults to false
.
landscape
<[boolean]>
Paper orientation. Defaults to false
.
pageRanges
<[string]>
Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
format
<[string]>
Paper format. If set, takes priority over [option: width
] or [option: height
] options. Defaults to 'Letter'.
width
<[string]|[float]>
Paper width, accepts values labeled with units.
height
<[string]|[float]>
Paper height, accepts values labeled with units.
margin
<[Object]>top
<[string]|[float]> Top margin, accepts values labeled with units. Defaults to0
.right
<[string]|[float]> Right margin, accepts values labeled with units. Defaults to0
.bottom
<[string]|[float]> Bottom margin, accepts values labeled with units. Defaults to0
.left
<[string]|[float]> Left margin, accepts values labeled with units. Defaults to0
.
Paper margins, defaults to none.
preferCSSPageSize
<[boolean]>
Give any CSS @page
size declared in the page priority over what is declared in [option: width
] and
[option: height
] or [option: format
] options. Defaults to false
, which will scale the content to fit the paper
size.
Focuses the element, and then uses [method: Keyboard.down
] and [method: Keyboard.up
].
[param: key
] can specify the intended
keyboardEvent.key value or a single character to
generate the text for. A superset of the [param: 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 [param: key
] in the upper case.
If [param: 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.
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();
page = await browser.new_page()
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="arrow_left.png")
await page.press("body", "Shift+O")
await page.screenshot(path="o.png")
await browser.close()
page = browser.new_page()
page.goto("https://keycode.info")
page.press("body", "A")
page.screenshot(path="a.png")
page.press("body", "ArrowLeft")
page.screenshot(path="arrow_left.png")
page.press("body", "Shift+O")
page.screenshot(path="o.png")
browser.close()
key
<[string]>
Name of the key to press or a character to generate, such as ArrowLeft
or a
.
delay
<[float]>
Time to wait between keydown
and keyup
in milliseconds. Defaults to 0.
- returns: <[null]|[Response]>
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:
const page = await browser.newPage();
await page.route('**/*.{png,jpg,jpeg}', route => route.abort());
await page.goto('https://example.com');
await browser.close();
page = await browser.new_page()
await page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
await page.goto("https://example.com")
await browser.close()
page = browser.new_page()
page.route("**/*.{png,jpg,jpeg}", lambda route: route.abort())
page.goto("https://example.com")
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();
page = await browser.new_page()
await page.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
await page.goto("https://example.com")
await browser.close()
page = browser.new_page()
page.route(re.compile(r"(\.png$)|(\.jpg$)"), lambda route: route.abort())
page.goto("https://example.com")
browser.close()
Page routes take precedence over browser context routes (set up with [method: BrowserContext.route
]) when request
matches both handlers.
:::note Enabling routing disables http cache. :::
url
<[string]|[RegExp]|[function]([URL]):[boolean]>
A glob pattern, regex pattern or predicate receiving [URL] to match while routing.
handler
<[function]([Route], [Request])>
handler function to route the request.
- returns: <[Buffer]>
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. :::
path
<[path]>
The file path to save the image to. The screenshot type will be inferred from file extension. If [option: path
] is a
relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be
saved to the disk.
type
<"png"|"jpeg">
Specify screenshot type, defaults to png
.
quality
<[int]>
The quality of the image, between 0-100. Not applicable to png
images.
fullPage
<[boolean]>
When true, takes a screenshot of the full scrollable page, instead of the currently visible viewport. Defaults to
false
.
clip
<[Object]>x
<[float]> x-coordinate of top-left corner of clip areay
<[float]> y-coordinate of top-left corner of clip areawidth
<[float]> width of clipping areaheight
<[float]> height of clipping area
An object which specifies clipping of the resulting image. Should have the following fields:
omitBackground
<[boolean]>
Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg
images.
Defaults to false
.
- returns: <[Array]<[string]>>
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. If there's no <select>
element
matching [param: selector
], the method throws an error.
Will wait until all specified options are present in the <select>
element.
// 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']);
# single selection matching the value
await page.select_option("select#colors", "blue")
# single selection matching the label
await page.select_option("select#colors", label="blue")
# multiple selection
await page.select_option("select#colors", value=["red", "green", "blue"])
# single selection matching the value
page.select_option("select#colors", "blue")
# single selection matching both the label
page.select_option("select#colors", label="blue")
# multiple selection
page.select_option("select#colors", value=["red", "green", "blue"])
Shortcut for main frame's [method: Frame.selectOption
]
html
<[string]>
HTML markup to assign to the page.
This setting will change the default maximum navigation time for the following methods and related shortcuts:
- [
method: Page.goBack
] - [
method: Page.goForward
] - [
method: Page.goto
] - [
method: Page.reload
] - [
method: Page.setContent
] - [
method: Page.waitForNavigation
]
:::note
[method: Page.setDefaultNavigationTimeout
] takes priority over [method: Page.setDefaultTimeout
],
[method: BrowserContext.setDefaultTimeout
] and [method: BrowserContext.setDefaultNavigationTimeout
].
:::
timeout
<[float]>
Maximum navigation time in milliseconds
This setting will change the default maximum time for all the methods accepting [param: timeout
] option.
:::note
[method: Page.setDefaultNavigationTimeout
] takes priority over [method: Page.setDefaultTimeout
].
:::
timeout
<[float]>
Maximum time in milliseconds
The extra HTTP headers will be sent with every request the page initiates.
:::note
[method: Page.setExtraHTTPHeaders
] does not guarantee the order of headers in the outgoing requests.
:::
headers
<[Object]<[string], [string]>>
An object containing additional HTTP headers to be sent with every request. All header values must be strings.
This method expects [param: 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,
[method: Browser.newContext
] allows to set viewport size (and more) for all pages in the context at once.
page.setViewportSize
will resize the page. A lot of websites don't expect phones to change size, so you should set the
viewport size before navigating to the page.
const page = await browser.newPage();
await page.setViewportSize({
width: 640,
height: 480,
});
await page.goto('https://example.com');
page = await browser.new_page()
await page.set_viewport_size({"width": 640, "height": 480})
await page.goto("https://example.com")
page = browser.new_page()
page.set_viewport_size({"width": 640, "height": 480})
page.goto("https://example.com")
viewportSize
<[Object]>width
<[int]> page width in pixels.height
<[int]> page height in pixels.
This method taps an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: selector
]. If there is none, wait until a matching element is attached to the DOM. - Wait for actionability checks on the matched element, unless [
option: 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 [
property: Page.touchscreen
] to tap the center of the element, or the specified [option: position
]. - Wait for initiated navigations to either succeed or fail, unless [
option: noWaitAfter
] option is set.
When all steps combined have not finished during the specified [option: timeout
], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
:::note
[method: Page.tap
] requires that the [option: hasTouch
] option of the browser context be set to true.
:::
Shortcut for main frame's [method: Frame.tap
].
- returns: <[null]|[string]>
Returns element.textContent
.
- returns: <[string]>
Returns the page's title. Shortcut for main frame's [method: Frame.title
].
- type: <[Touchscreen]>
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 [method: Page.fill
].
To press a special key, like Control
or ArrowDown
, use [method: Keyboard.press
].
await page.type('#mytextarea', 'Hello'); // Types instantly
await page.type('#mytextarea', 'World', {delay: 100}); // Types slower, like a user
await page.type("#mytextarea", "hello") # types instantly
await page.type("#mytextarea", "world", delay=100) # types slower, like a user
page.type("#mytextarea", "hello") # types instantly
page.type("#mytextarea", "world", delay=100) # types slower, like a user
Shortcut for main frame's [method: Frame.type
].
text
<[string]>
A text to type into a focused element.
delay
<[float]>
Time to wait between key presses in milliseconds. Defaults to 0.
This method unchecks an element matching [param: selector
] by performing the following steps:
- Find an element match matching [
param: 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 [
option: 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 [
property: Page.mouse
] to click in the center of the element. - Wait for initiated navigations to either succeed or fail, unless [
option: 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 [option: timeout
], this method rejects with a
[TimeoutError]. Passing zero timeout disables this.
Shortcut for main frame's [method: Frame.uncheck
].
Removes a route created with [method: Page.route
]. When [param: handler
] is not specified, removes all routes for
the [param: url
].
url
<[string]|[RegExp]|[function]([URL]):[boolean]>
A glob pattern, regex pattern or predicate receiving [URL] to match while routing.
handler
<[function]([Route], [Request])>
Optional handler function to route the request.
- returns: <[string]>
Shortcut for main frame's [method: Frame.url
].
- returns: <[null]|[Video]>
Video object associated with this page.
- returns: <[null]|[Object]>
width
<[int]> page width in pixels.height
<[int]> page height in pixels.
- langs:
- alias-python: expect_event
- returns: <[any]>
Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the page is closed before the event is fired. Returns the event data value.
const [frame, _] = await Promise.all([
page.waitForEvent('framenavigated'),
page.click('button')
]);
async with page.expect_event("framenavigated") as event_info:
await page.click("button")
frame = await event_info.value
with page.expect_event("framenavigated") as event_info:
page.click("button")
frame = event_info.value
- langs: js
optionsOrPredicate
<[function]|[Object]>predicate
<[function]> receives the event data and resolves to truthy value when the waiting should resolve.timeout
<[float]> maximum time to wait for in milliseconds. Defaults to30000
(30 seconds). Pass0
to disable timeout. The default value can be changed by using the [method: BrowserContext.setDefaultTimeout
].
Either a predicate that receives an event or an options object. Optional.
- returns: <[JSHandle]>
Returns when the [param: pageFunction
] returns a truthy value. It resolves to a JSHandle of the truthy value.
The [method: Page.waitForFunction
] 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();
})();
import asyncio
from playwright.async_api import async_playwright
async def run(playwright):
webkit = playwright.webkit
browser = await webkit.launch()
page = await browser.new_page()
await page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);", force_expr=True)
await page.wait_for_function("() => window.x > 0")
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
from playwright.sync_api import sync_playwright
def run(playwright):
webkit = playwright.webkit
browser = webkit.launch()
page = browser.new_page()
page.evaluate("window.x = 0; setTimeout(() => { window.x = 100 }, 1000);", force_expr=True)
page.wait_for_function("() => window.x > 0")
browser.close()
with sync_playwright() as playwright:
run(playwright)
To pass an argument to the predicate of [method: Page.waitForFunction
] function:
const selector = '.foo';
await page.waitForFunction(selector => !!document.querySelector(selector), selector);
selector = ".foo"
await page.wait_for_function("selector => !!document.querySelector(selector)", selector)
selector = ".foo"
page.wait_for_function("selector => !!document.querySelector(selector)", selector)
Shortcut for main frame's [method: Frame.waitForFunction
].
- langs: js
pageFunction
<[function]|[string]>
Function to be evaluated in browser context
arg
<[EvaluationArgument]>
Optional argument to pass to [param: pageFunction
]
polling
<[float]|"raf">
If [option: polling
] is 'raf'
, then [param: pageFunction
] is constantly executed in requestAnimationFrame
callback. If [option: polling
] is a number, then it is treated as an interval in milliseconds at which the function
would be executed. Defaults to raf
.
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.
await page.click('button'); // Click triggers navigation.
await page.waitForLoadState(); // The promise resolves after 'load' event.
await page.click("button") # click triggers navigation.
await page.wait_for_load_state() # the promise resolves after "load" event.
page.click("button") # click triggers navigation.
page.wait_for_load_state() # the promise resolves after "load" event.
const [popup] = await Promise.all([
page.waitForEvent('popup'),
page.click('button'), // Click triggers a popup.
])
await popup.waitForLoadState('domcontentloaded'); // The promise resolves after 'domcontentloaded' event.
console.log(await popup.title()); // Popup is ready to use.
async with page.expect_popup() as page_info:
await page.click("button") # click triggers a popup.
popup = await page_info.value
# Following resolves after "domcontentloaded" event.
await popup.wait_for_load_state("domcontentloaded")
print(await popup.title()) # popup is ready to use.
with page.expect_popup() as page_info:
page.click("button") # click triggers a popup.
popup = page_info.value
# Following resolves after "domcontentloaded" event.
popup.wait_for_load_state("domcontentloaded")
print(popup.title()) # popup is ready to use.
Shortcut for main frame's [method: Frame.waitForLoadState
].
- langs:
- alias-python: expect_navigation
- returns: <[null]|[Response]>
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
.
This resolves when the page navigates to a new URL or reloads. It is useful for when you run code which will indirectly
cause the page to navigate. e.g. The click target has an onclick
handler that triggers navigation from a setTimeout
.
Consider this example:
const [response] = await Promise.all([
page.waitForNavigation(), // The promise resolves after navigation has finished
page.click('a.delayed-navigation'), // Clicking the link will indirectly cause a navigation
]);
async with page.expect_navigation():
await page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
# Resolves after navigation has finished
with page.expect_navigation():
page.click("a.delayed-navigation") # clicking the link will indirectly cause a navigation
# Resolves after navigation has finished
:::note Usage of the History API to change the URL is considered a navigation. :::
Shortcut for main frame's [method: Frame.waitForNavigation
].
- langs:
- alias-python: expect_request
- returns: <[Request]>
Waits for the matching request and returns it.
const firstRequest = await page.waitForRequest('http://example.com/resource');
const finalRequest = await page.waitForRequest(request => request.url() === 'http://example.com' && request.method() === 'GET');
return firstRequest.url();
async with page.expect_request("http://example.com/resource") as first:
await page.click('button')
first_request = await first.value
async with page.expect_request(lambda request: request.url == "http://example.com" and request.method == "get") as second:
await page.click('img')
second_request = await second.value
with page.expect_request("http://example.com/resource") as first:
page.click('button')
first_request = first.value
with page.expect_request(lambda request: request.url == "http://example.com" and request.method == "get") as second:
page.click('img')
second_request = second.value
await page.waitForRequest(request => request.url().searchParams.get('foo') === 'bar' && request.url().searchParams.get('foo2') === 'bar2');
urlOrPredicate
<[string]|[RegExp]|[function]([Request]):[boolean]>
Request URL string, regex or predicate receiving [Request] object.
timeout
<[float]>
Maximum wait time in milliseconds, defaults to 30 seconds, pass 0
to disable the timeout. The default value can be
changed by using the [method: Page.setDefaultTimeout
] method.
- langs:
- alias-python: expect_response
- returns: <[Response]>
Returns the matched response.
const firstResponse = await page.waitForResponse('https://example.com/resource');
const finalResponse = await page.waitForResponse(response => response.url() === 'https://example.com' && response.status() === 200);
return finalResponse.ok();
first_response = await page.wait_for_response("https://example.com/resource")
final_response = await page.wait_for_response(lambda response: response.url == "https://example.com" and response.status === 200)
return final_response.ok
first_response = page.wait_for_response("https://example.com/resource")
final_response = page.wait_for_response(lambda response: response.url == "https://example.com" and response.status === 200)
return final_response.ok
urlOrPredicate
<[string]|[RegExp]|[function]([Response]):[boolean]>
Request URL string, regex or predicate receiving [Response] object.
timeout
<[float]>
Maximum wait time in milliseconds, defaults to 30 seconds, pass 0
to disable the timeout. The default value can be
changed by using the [method: BrowserContext.setDefaultTimeout
] or [method: Page.setDefaultTimeout
] methods.
- returns: <[null]|[ElementHandle]>
Returns when element specified by selector satisfies [option: state
] option. Returns null
if waiting for hidden
or
detached
.
Wait for the [param: selector
] to satisfy [option: state
] option (either appear/disappear from dom, or become
visible/hidden). If at the moment of calling the method [param: selector
] already satisfies the condition, the method
will return immediately. If the selector doesn't satisfy the condition for the [option: timeout
] milliseconds, the
function will throw.
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();
})();
import asyncio
from playwright.async_api import async_playwright
async def run(playwright):
chromium = playwright.chromium
browser = await chromium.launch()
page = await browser.new_page()
for current_url in ["https://google.com", "https://bbc.com"]:
await page.goto(current_url, wait_until="domcontentloaded")
element = await page.wait_for_selector("img")
print("Loaded image: " + str(await element.get_attribute("src")))
await browser.close()
async def main():
async with async_playwright() as playwright:
await run(playwright)
asyncio.run(main())
from playwright.sync_api import sync_playwright
def run(playwright):
chromium = playwright.chromium
browser = chromium.launch()
page = browser.new_page()
for current_url in ["https://google.com", "https://bbc.com"]:
page.goto(current_url, wait_until="domcontentloaded")
element = page.wait_for_selector("img")
print("Loaded image: " + str(element.get_attribute("src")))
browser.close()
with sync_playwright() as playwright:
run(playwright)
Waits for the given [param: 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.
// wait for 1 second
await page.waitForTimeout(1000);
# wait for 1 second
await page.wait_for_timeout(1000)
# wait for 1 second
page.wait_for_timeout(1000)
Shortcut for main frame's [method: Frame.waitForTimeout
].
timeout
<[float]>
A timeout to wait for
- returns: <[Array]<[Worker]>>
This method returns all of the dedicated WebWorkers associated with the page.
:::note This does not contain ServiceWorkers :::