Browser
Added in: v1.8A Browser is created via browserType.launch(). An example of using a Browser to create a Page:
import com.microsoft.playwright.*;
public class Example {
public static void main(String[] args) {
try (Playwright playwright = Playwright.create()) {
BrowserType firefox = playwright.firefox();
Browser browser = firefox.launch();
Page page = browser.newPage();
page.navigate("https://example.com");
browser.close();
}
}
}Methods
browser.bind()
Added in: v1.59Binds the browser to a named pipe or web socket, making it available for other clients to connect to.
Arguments
Title of the browser server, used for identification.
Host to bind the web socket server to. When specified, a web socket server is created instead of a named pipe.
Port to bind the web socket server to. When specified, a web socket server is created instead of a named pipe. Use
0to let the OS pick an available port.workspaceDirstring(optional)Working directory associated with this browser server.
Returns
Object
browser.browserType()
Added in: v1.23Get the browser type (chromium, firefox or webkit) that the browser belongs to.
Returns
BrowserType
browser.close()
Added in: v1.8In case this browser is obtained using browserType.launch(), closes the browser and all of its pages (if any were opened).
In case this browser is connected to, clears all created contexts belonging to this browser and disconnects from the browser server.
INFO
This is similar to force-quitting the browser. To close pages gracefully and ensure you receive page close events, call browserContext.close() on any BrowserContext instances you explicitly created earlier using browser.newContext() before calling browser.close().
The Browser object itself is considered to be disposed and cannot be used anymore.
Arguments
browser.contexts()
Added in: v1.8Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.
Usage
Browser browser = pw.webkit().launch();
System.out.println(browser.contexts().size()); // prints "0"
BrowserContext context = browser.newContext();
System.out.println(browser.contexts().size()); // prints "1"Returns
Array<BrowserContext>
browser.isConnected()
Added in: v1.8Indicates that the browser is connected.
Returns
boolean
browser.newBrowserCDPSession()
Added in: v1.11INFO
CDP Sessions are only supported on Chromium-based browsers.
Returns the newly created browser session.
Returns
CDPSession
browser.newContext()
Added in: v1.8Creates a new browser context. It won't share cookies/cache with other browser contexts.
INFO
If directly using this method to create BrowserContexts, it is best practice to explicitly close the returned context via browserContext.close() when your code is done with the BrowserContext, and before calling browser.close(). This will ensure the context is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved.
Usage
Browser browser = playwright.firefox().launch(); // Or 'chromium' or 'webkit'.
// Create a new incognito browser context.
BrowserContext context = browser.newContext();
// Create a new page in a pristine context.
Page page = context.newPage();
page.navigate("https://example.com");
// Graceful close up everything
context.close();
browser.close();Arguments
acceptDownloadsboolean(optional)Whether to automatically download all the attachments. Defaults to
truewhere all the downloads are accepted.When using
page.navigate(),page.route(),page.waitForURL(),page.waitForRequest(), orpage.waitForResponse()it takes the base URL in consideration by using theURL()constructor for building the corresponding URL. Unset by default. Examples:- baseURL:
http://localhost:3000and navigating to/bar.htmlresults inhttp://localhost:3000/bar.html - baseURL:
http://localhost:3000/foo/and navigating to./bar.htmlresults inhttp://localhost:3000/foo/bar.html - baseURL:
http://localhost:3000/foo(without trailing slash) and navigating to./bar.htmlresults inhttp://localhost:3000/bar.html
- baseURL:
Toggles bypassing page's Content-Security-Policy. Defaults to
false.clientCertificatesArray<Object>(optional) Added in: v1.46TLS Client Authentication allows the server to request a client certificate and verify it.
Details
An array of client certificates to be used. Each certificate object must have either both
certPathandkeyPath, a singlepfxPath, or their corresponding direct value equivalents (certandkey, orpfx). Optionally,passphraseproperty should be provided if the certificate is encrypted. Theoriginproperty should be provided with an exact match to the request origin that the certificate is valid for.Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an
originthat does not match any of the domains you plan to visit.INFO
When using WebKit on macOS, accessing
localhostwill not pick up client certificates. You can make it work by replacinglocalhostwithlocal.playwright.originstringAdded in: v1.46Exact origin that the certificate is valid for. Origin includes
httpsprotocol, a hostname and optionally a port.certPathpath(optional) Added in: v1.46Path to the file with the certificate in PEM format.
certBuffer(optional) Added in: v1.46Direct value of the certificate in PEM format.
keyPathpath(optional) Added in: v1.46Path to the file with the private key in PEM format.
keyBuffer(optional) Added in: v1.46Direct value of the private key in PEM format.
pfxPathpath(optional) Added in: v1.46Path to the PFX or PKCS12 encoded private key and certificate chain.
pfxBuffer(optional) Added in: v1.46Direct value of the PFX or PKCS12 encoded private key and certificate chain.
passphrasestring(optional) Added in: v1.46Passphrase for the private key (PEM or PFX).
colorSchemenull | "light" | "dark" | "no-preference"(optional)Emulates prefers-colors-scheme media feature, supported values are
'light'and'dark'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'light'.contrastnull | "no-preference" | "more"(optional)Emulates
'prefers-contrast'media feature, supported values are'no-preference','more'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.deviceScaleFactorfloat(optional)Specify device scale factor (can be thought of as dpr). Defaults to
1. Learn more about emulating devices with device scale factor.extraHTTPHeadersObject<string, string>(optional)An object containing additional HTTP headers to be sent with every request. Defaults to none.
forcedColorsnull | "active" | "none"(optional)Emulates
'forced-colors'media feature, supported values are'active','none'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'none'.latitudefloatLatitude between -90 and 90.
longitudefloatLongitude between -180 and 180.
accuracyfloat(optional)Non-negative accuracy value. Defaults to
0.
Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
httpCredentialsObject | Array<Object>(optional)Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.
usernamestringpasswordstringoriginstring(optional)Restrain sending http credentials on specific origin (scheme://host:port).
send"unauthorized" | "always"(optional)This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser.
'always'-Authorizationheader with basic authentication credentials will be sent with the each API request.'unauthorized- the credentials are only sent when 401 (Unauthorized) response withWWW-Authenticateheader is received. Defaults to'unauthorized'.
ignoreHTTPSErrorsboolean(optional)Whether to ignore HTTPS errors when sending network requests. Defaults to
false.Whether the
meta viewporttag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults tofalse. Learn more about mobile emulation.javaScriptEnabledboolean(optional)Whether or not to enable JavaScript in the context. Defaults to
true. Learn more about disabling JavaScript.Specify user locale, for example
en-GB,de-DE, etc. Locale will affectnavigator.languagevalue,Accept-Languagerequest header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.Whether to emulate network being offline. Defaults to
false. Learn more about network emulation.permissionsArray<string>(optional)A list of permissions to grant to all pages in this context. See
browserContext.grantPermissions()for more details. Defaults to none.Network proxy settings to use with this context. Defaults to none.
serverstringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.bypassstring(optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com".usernamestring(optional)Optional username to use if HTTP proxy requires authentication.
passwordstring(optional)Optional password to use if HTTP proxy requires authentication.
recordHarContent"omit" | "embed" | "attach"(optional)Optional setting to control resource content management. If
omitis specified, content is not persisted. Ifattachis specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults toembed, which stores content inline the HAR file as per HAR specification.recordHarMode"full" | "minimal"(optional)When 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 tofull.recordHarOmitContentboolean(optional)Optional setting to control whether to omit request content from the HAR. Defaults to
false.Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call
browserContext.close()for the HAR to be saved.recordVideoDirpath(optional)Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call
browserContext.close()for videos to be saved.recordVideoFpsint(optional) Added in: v1.64Frame rate of the recorded videos in frames per second. Defaults to
25. Firefox and WebKit currently capture up to 25 frames per second.recordVideoSizeObject(optional)Dimensions of the recorded videos. If not specified the size will be equal to
viewportscaled down to fit into 800x800. Ifviewportis not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.widthintVideo frame width.
heightintVideo frame height.
reducedMotionnull | "reduce" | "no-preference"(optional)Emulates
'prefers-reduced-motion'media feature, supported values are'reduce','no-preference'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.Emulates consistent window screen size available inside web page via
window.screen. Is only used when theviewportSizeis set.widthintpage width in pixels.
heightintpage height in pixels.
serviceWorkers"allow" | "block"(optional)Whether to allow sites to register Service workers. Defaults to
'allow'.'allow': Service Workers can be registered.'block': Playwright will block all registration of Service Workers.
storageStatestring(optional)Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via
browserContext.storageState().storageStatePathpath(optional) Added in: v1.9Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via
browserContext.storageState(). Path to the file with saved storage state.strictSelectorsboolean(optional)If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to
false. See Locator to learn more about the strict mode.Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
Specific user agent to use in this context.
viewportSizenull | Object(optional)Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use
nullto disable the consistent viewport emulation. Learn more about viewport emulation.INFO
The
nullvalue opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.widthintpage width in pixels.
heightintpage height in pixels.
Returns
BrowserContext
browser.newPage()
Added in: v1.8Creates a new page in a new browser context. Closing this page will close the context as well.
This is a convenience API that should only be used for the single-page scenarios and short snippets. Production code and testing frameworks should explicitly create browser.newContext() followed by the browserContext.newPage() to control their exact life times.
Arguments
acceptDownloadsboolean(optional)Whether to automatically download all the attachments. Defaults to
truewhere all the downloads are accepted.When using
page.navigate(),page.route(),page.waitForURL(),page.waitForRequest(), orpage.waitForResponse()it takes the base URL in consideration by using theURL()constructor for building the corresponding URL. Unset by default. Examples:- baseURL:
http://localhost:3000and navigating to/bar.htmlresults inhttp://localhost:3000/bar.html - baseURL:
http://localhost:3000/foo/and navigating to./bar.htmlresults inhttp://localhost:3000/foo/bar.html - baseURL:
http://localhost:3000/foo(without trailing slash) and navigating to./bar.htmlresults inhttp://localhost:3000/bar.html
- baseURL:
Toggles bypassing page's Content-Security-Policy. Defaults to
false.clientCertificatesArray<Object>(optional) Added in: v1.46TLS Client Authentication allows the server to request a client certificate and verify it.
Details
An array of client certificates to be used. Each certificate object must have either both
certPathandkeyPath, a singlepfxPath, or their corresponding direct value equivalents (certandkey, orpfx). Optionally,passphraseproperty should be provided if the certificate is encrypted. Theoriginproperty should be provided with an exact match to the request origin that the certificate is valid for.Client certificate authentication is only active when at least one client certificate is provided. If you want to reject all client certificates sent by the server, you need to provide a client certificate with an
originthat does not match any of the domains you plan to visit.INFO
When using WebKit on macOS, accessing
localhostwill not pick up client certificates. You can make it work by replacinglocalhostwithlocal.playwright.originstringAdded in: v1.46Exact origin that the certificate is valid for. Origin includes
httpsprotocol, a hostname and optionally a port.certPathpath(optional) Added in: v1.46Path to the file with the certificate in PEM format.
certBuffer(optional) Added in: v1.46Direct value of the certificate in PEM format.
keyPathpath(optional) Added in: v1.46Path to the file with the private key in PEM format.
keyBuffer(optional) Added in: v1.46Direct value of the private key in PEM format.
pfxPathpath(optional) Added in: v1.46Path to the PFX or PKCS12 encoded private key and certificate chain.
pfxBuffer(optional) Added in: v1.46Direct value of the PFX or PKCS12 encoded private key and certificate chain.
passphrasestring(optional) Added in: v1.46Passphrase for the private key (PEM or PFX).
colorSchemenull | "light" | "dark" | "no-preference"(optional)Emulates prefers-colors-scheme media feature, supported values are
'light'and'dark'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'light'.contrastnull | "no-preference" | "more"(optional)Emulates
'prefers-contrast'media feature, supported values are'no-preference','more'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.deviceScaleFactorfloat(optional)Specify device scale factor (can be thought of as dpr). Defaults to
1. Learn more about emulating devices with device scale factor.extraHTTPHeadersObject<string, string>(optional)An object containing additional HTTP headers to be sent with every request. Defaults to none.
forcedColorsnull | "active" | "none"(optional)Emulates
'forced-colors'media feature, supported values are'active','none'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'none'.latitudefloatLatitude between -90 and 90.
longitudefloatLongitude between -180 and 180.
accuracyfloat(optional)Non-negative accuracy value. Defaults to
0.
Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
httpCredentialsObject | Array<Object>(optional)Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
Pass an array to use different credentials for different origins. The first entry that matches the request origin is used, and entries with no origin match any request.
usernamestringpasswordstringoriginstring(optional)Restrain sending http credentials on specific origin (scheme://host:port).
send"unauthorized" | "always"(optional)This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser.
'always'-Authorizationheader with basic authentication credentials will be sent with the each API request.'unauthorized- the credentials are only sent when 401 (Unauthorized) response withWWW-Authenticateheader is received. Defaults to'unauthorized'.
ignoreHTTPSErrorsboolean(optional)Whether to ignore HTTPS errors when sending network requests. Defaults to
false.Whether the
meta viewporttag is taken into account and touch events are enabled. isMobile is a part of device, so you don't actually need to set it manually. Defaults tofalse. Learn more about mobile emulation.javaScriptEnabledboolean(optional)Whether or not to enable JavaScript in the context. Defaults to
true. Learn more about disabling JavaScript.Specify user locale, for example
en-GB,de-DE, etc. Locale will affectnavigator.languagevalue,Accept-Languagerequest header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.Whether to emulate network being offline. Defaults to
false. Learn more about network emulation.permissionsArray<string>(optional)A list of permissions to grant to all pages in this context. See
browserContext.grantPermissions()for more details. Defaults to none.Network proxy settings to use with this context. Defaults to none.
serverstringProxy to be used for all requests. HTTP and SOCKS proxies are supported, for example
http://myproxy.com:3128orsocks5://myproxy.com:3128. Short formmyproxy.com:3128is considered an HTTP proxy.bypassstring(optional)Optional comma-separated domains to bypass proxy, for example
".com, chromium.org, .domain.com".usernamestring(optional)Optional username to use if HTTP proxy requires authentication.
passwordstring(optional)Optional password to use if HTTP proxy requires authentication.
recordHarContent"omit" | "embed" | "attach"(optional)Optional setting to control resource content management. If
omitis specified, content is not persisted. Ifattachis specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults toembed, which stores content inline the HAR file as per HAR specification.recordHarMode"full" | "minimal"(optional)When 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 tofull.recordHarOmitContentboolean(optional)Optional setting to control whether to omit request content from the HAR. Defaults to
false.Enables HAR recording for all pages into the specified HAR file on the filesystem. If not specified, the HAR is not recorded. Make sure to call
browserContext.close()for the HAR to be saved.recordVideoDirpath(optional)Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call
browserContext.close()for videos to be saved.recordVideoFpsint(optional) Added in: v1.64Frame rate of the recorded videos in frames per second. Defaults to
25. Firefox and WebKit currently capture up to 25 frames per second.recordVideoSizeObject(optional)Dimensions of the recorded videos. If not specified the size will be equal to
viewportscaled down to fit into 800x800. Ifviewportis not configured explicitly the video size defaults to 800x450. Actual picture of each page will be scaled down if necessary to fit the specified size.widthintVideo frame width.
heightintVideo frame height.
reducedMotionnull | "reduce" | "no-preference"(optional)Emulates
'prefers-reduced-motion'media feature, supported values are'reduce','no-preference'. Seepage.emulateMedia()for more details. Passingnullresets emulation to system defaults. Defaults to'no-preference'.Emulates consistent window screen size available inside web page via
window.screen. Is only used when theviewportSizeis set.widthintpage width in pixels.
heightintpage height in pixels.
serviceWorkers"allow" | "block"(optional)Whether to allow sites to register Service workers. Defaults to
'allow'.'allow': Service Workers can be registered.'block': Playwright will block all registration of Service Workers.
storageStatestring(optional)Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via
browserContext.storageState().storageStatePathpath(optional) Added in: v1.9Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via
browserContext.storageState(). Path to the file with saved storage state.strictSelectorsboolean(optional)If set to true, enables strict selectors mode for this context. In the strict selectors mode all operations on selectors that imply single target DOM element will throw when more than one element matches the selector. This option does not affect any Locator APIs (Locators are always strict). Defaults to
false. See Locator to learn more about the strict mode.Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
Specific user agent to use in this context.
viewportSizenull | Object(optional)Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use
nullto disable the consistent viewport emulation. Learn more about viewport emulation.INFO
The
nullvalue opts out from the default presets, makes viewport depend on the host window size defined by the operating system. It makes the execution of the tests non-deterministic.widthintpage width in pixels.
heightintpage height in pixels.
Returns
Page
browser.startTracing()
Added in: v1.11INFO
This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.
You can use browser.startTracing() and browser.stopTracing() to create a trace file that can be opened in Chrome DevTools performance panel.
Usage
browser.startTracing(page, new Browser.StartTracingOptions()
.setPath(Paths.get("trace.json")));
page.navigate("https://www.google.com");
browser.stopTracing();Arguments
Optional, if specified, tracing includes screenshots of the given page.
browser.stopTracing()
Added in: v1.11INFO
This API controls Chromium Tracing which is a low-level chromium-specific debugging tool. API to control Playwright Tracing could be found here.
Returns the buffer with trace data.
Returns
Buffer
browser.unbind()
Added in: v1.59Unbinds the browser server previously bound with browser.bind().
browser.version()
Added in: v1.8Returns the browser version.
Returns
string
Events
browser.onContext()
Added in: v1.60Emitted when a new browser context is created.
Event data
BrowserContext
browser.onDisconnected()
Added in: v1.8Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:
- Browser application is closed or crashed.
- The
browser.close()method was called.
Event data
Browser