Browser

A 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

browserType

Added in: v1.23

browser.browserType

Get the browser type (chromium, firefox or webkit) that the browser belongs to.

Usage

Browser.browserType();

Returns

BrowserType #

close

Added before v1.9

browser.close

In 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.

note

This is similar to force quitting the browser. Therefore, you should call BrowserContext.close() on any BrowserContext's you explicitly created earlier with Browser.newContext() before calling Browser.close().

The Browser object itself is considered to be disposed and cannot be used anymore.

Usage

Browser.close();
Browser.close(options);

Arguments

options Browser.CloseOptions (optional)
- setReason String (optional) Added in: v1.40#
  
  The reason to be reported to the operations interrupted by the browser closure.

Returns

void #

contexts

Added before v1.9

browser.contexts

Returns 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

List<BrowserContext>#

isConnected

Added before v1.9

browser.isConnected

Indicates that the browser is connected.

Usage

Browser.isConnected();

Returns

boolean #

newBrowserCDPSession

Added in: v1.11

browser.newBrowserCDPSession

note

CDP Sessions are only supported on Chromium-based browsers.

Returns the newly created browser session.

Usage

Browser.newBrowserCDPSession();

Returns

CDPSession #

newContext

Added before v1.9

browser.newContext

Creates a new browser context. It won't share cookies/cache with other browser contexts.

note

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

options Browser.NewContextOptions (optional)
- setAcceptDownloads boolean (optional)#
  
  Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
- setBaseURL String (optional)#
  
  When using Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), or Page.waitForResponse() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:
  - baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
  - baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
  - baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
- setBypassCSP boolean (optional)#
  
  Toggles bypassing page's Content-Security-Policy. Defaults to false.
- setClientCertificates List<ClientCertificates> (optional) Added in: 1.46#
  - setOrigin String
    
    Exact origin that the certificate is valid for. Origin includes https protocol, a hostname and optionally a port.
  - setCertPath Path (optional)
    
    Path to the file with the certificate in PEM format.
  - setCert byte[] (optional)
    
    Direct value of the certificate in PEM format.
  - setKeyPath Path (optional)
    
    Path to the file with the private key in PEM format.
  - setKey byte[] (optional)
    
    Direct value of the private key in PEM format.
  - setPfxPath Path (optional)
    
    Path to the PFX or PKCS12 encoded private key and certificate chain.
  - setPfx byte[] (optional)
    
    Direct value of the PFX or PKCS12 encoded private key and certificate chain.
  - setPassphrase String (optional)
    
    Passphrase for the private key (PEM or PFX).
  TLS 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 certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.
  
  note
  Using Client Certificates in combination with Proxy Servers is not supported.
  
  note
  When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.
- setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (optional)#
  
  Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.
- setDeviceScaleFactor double (optional)#
  
  Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
- setExtraHTTPHeaders Map<String, String> (optional)#
  
  An object containing additional HTTP headers to be sent with every request. Defaults to none.
- setForcedColors null | enum ForcedColors { ACTIVE, NONE } (optional)#
  
  Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'none'.
- setGeolocation Geolocation (optional)#
  - setLatitude double
    
    Latitude between -90 and 90.
  - setLongitude double
    
    Longitude between -180 and 180.
  - setAccuracy double (optional)
    
    Non-negative accuracy value. Defaults to 0.
- setHasTouch boolean (optional)#
  
  Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
- setHttpCredentials HttpCredentials (optional)#
  - setUsername String
  - setPassword String
  - setOrigin String (optional)
    
    Restrain sending http credentials on specific origin (scheme://host:port).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (optional)
    
    This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.
  Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
- setIgnoreHTTPSErrors boolean (optional)#
  
  Whether to ignore HTTPS errors when sending network requests. Defaults to false.
- setIsMobile boolean (optional)#
  
  Whether the meta viewport tag 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 to false and is not supported in Firefox. Learn more about mobile emulation.
- setJavaScriptEnabled boolean (optional)#
  
  Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.
- setLocale String (optional)#
  
  Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.
- setOffline boolean (optional)#
  
  Whether to emulate network being offline. Defaults to false. Learn more about network emulation.
- setPermissions List<String> (optional)#
  
  A list of permissions to grant to all pages in this context. See BrowserContext.grantPermissions() for more details. Defaults to none.
- setProxy Proxy (optional)#
  - setServer String
    
    Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
  - setBypass String (optional)
    
    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
  - setUsername String (optional)
    
    Optional username to use if HTTP proxy requires authentication.
  - setPassword String (optional)
    
    Optional password to use if HTTP proxy requires authentication.
  Network proxy settings to use with this context. Defaults to none.
- setRecordHarContent enum HarContentPolicy { OMIT, EMBED, ATTACH } (optional)#
  
  Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to embed, which stores content inline the HAR file as per HAR specification.
- setRecordHarMode enum HarMode { 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 to full.
- setRecordHarOmitContent boolean (optional)#
  
  Optional setting to control whether to omit request content from the HAR. Defaults to false.
- setRecordHarPath Path (optional)#
  
  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.
- setRecordHarUrlFilter String | Pattern (optional)#
- setRecordVideoDir Path (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.
- setRecordVideoSize RecordVideoSize (optional)#
  - setWidth int
    
    Video frame width.
  - setHeight int
    
    Video frame height.
  Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is 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.
- setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (optional)#
  
  Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
- setScreenSize ScreenSize (optional)#
  - setWidth int
    
    page width in pixels.
  - setHeight int
    
    page height in pixels.
  Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
- setServiceWorkers enum ServiceWorkerPolicy { 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.
- setStorageState String (optional)#
  
  Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState().
- setStorageStatePath Path (optional) Added in: v1.9#
  
  Populates 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.
- setStrictSelectors boolean (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.
- setTimezoneId String (optional)#
  
  Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
- setUserAgent String (optional)#
  
  Specific user agent to use in this context.
- setViewportSize null | ViewportSize (optional)#
  - setWidth int
    
    page width in pixels.
  - setHeight int
    
    page height in pixels.
  Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.
  
  note
  The null value 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.

Returns

BrowserContext #

newPage

Added before v1.9

browser.newPage

Creates 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.

Usage

Browser.newPage();
Browser.newPage(options);

Arguments

options Browser.NewPageOptions (optional)
- setAcceptDownloads boolean (optional)#
  
  Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.
- setBaseURL String (optional)#
  
  When using Page.navigate(), Page.route(), Page.waitForURL(), Page.waitForRequest(), or Page.waitForResponse() it takes the base URL in consideration by using the URL() constructor for building the corresponding URL. Unset by default. Examples:
  - baseURL: http://localhost:3000 and navigating to /bar.html results in http://localhost:3000/bar.html
  - baseURL: http://localhost:3000/foo/ and navigating to ./bar.html results in http://localhost:3000/foo/bar.html
  - baseURL: http://localhost:3000/foo (without trailing slash) and navigating to ./bar.html results in http://localhost:3000/bar.html
- setBypassCSP boolean (optional)#
  
  Toggles bypassing page's Content-Security-Policy. Defaults to false.
- setClientCertificates List<ClientCertificates> (optional) Added in: 1.46#
  - setOrigin String
    
    Exact origin that the certificate is valid for. Origin includes https protocol, a hostname and optionally a port.
  - setCertPath Path (optional)
    
    Path to the file with the certificate in PEM format.
  - setCert byte[] (optional)
    
    Direct value of the certificate in PEM format.
  - setKeyPath Path (optional)
    
    Path to the file with the private key in PEM format.
  - setKey byte[] (optional)
    
    Direct value of the private key in PEM format.
  - setPfxPath Path (optional)
    
    Path to the PFX or PKCS12 encoded private key and certificate chain.
  - setPfx byte[] (optional)
    
    Direct value of the PFX or PKCS12 encoded private key and certificate chain.
  - setPassphrase String (optional)
    
    Passphrase for the private key (PEM or PFX).
  TLS 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 certPath and keyPath, a single pfxPath, or their corresponding direct value equivalents (cert and key, or pfx). Optionally, passphrase property should be provided if the certificate is encrypted. The origin property should be provided with an exact match to the request origin that the certificate is valid for.
  
  note
  Using Client Certificates in combination with Proxy Servers is not supported.
  
  note
  When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.
- setColorScheme null | enum ColorScheme { LIGHT, DARK, NO_PREFERENCE } (optional)#
  
  Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.
- setDeviceScaleFactor double (optional)#
  
  Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.
- setExtraHTTPHeaders Map<String, String> (optional)#
  
  An object containing additional HTTP headers to be sent with every request. Defaults to none.
- setForcedColors null | enum ForcedColors { ACTIVE, NONE } (optional)#
  
  Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'none'.
- setGeolocation Geolocation (optional)#
  - setLatitude double
    
    Latitude between -90 and 90.
  - setLongitude double
    
    Longitude between -180 and 180.
  - setAccuracy double (optional)
    
    Non-negative accuracy value. Defaults to 0.
- setHasTouch boolean (optional)#
  
  Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.
- setHttpCredentials HttpCredentials (optional)#
  - setUsername String
  - setPassword String
  - setOrigin String (optional)
    
    Restrain sending http credentials on specific origin (scheme://host:port).
  - setSend enum HttpCredentialsSend { UNAUTHORIZED, ALWAYS } (optional)
    
    This option only applies to the requests sent from corresponding APIRequestContext and does not affect requests sent from the browser. 'always' - Authorization header with basic authentication credentials will be sent with the each API request. 'unauthorized - the credentials are only sent when 401 (Unauthorized) response with WWW-Authenticate header is received. Defaults to 'unauthorized'.
  Credentials for HTTP authentication. If no origin is specified, the username and password are sent to any servers upon unauthorized responses.
- setIgnoreHTTPSErrors boolean (optional)#
  
  Whether to ignore HTTPS errors when sending network requests. Defaults to false.
- setIsMobile boolean (optional)#
  
  Whether the meta viewport tag 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 to false and is not supported in Firefox. Learn more about mobile emulation.
- setJavaScriptEnabled boolean (optional)#
  
  Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.
- setLocale String (optional)#
  
  Specify user locale, for example en-GB, de-DE, etc. Locale will affect navigator.language value, Accept-Language request header value as well as number and date formatting rules. Defaults to the system default locale. Learn more about emulation in our emulation guide.
- setOffline boolean (optional)#
  
  Whether to emulate network being offline. Defaults to false. Learn more about network emulation.
- setPermissions List<String> (optional)#
  
  A list of permissions to grant to all pages in this context. See BrowserContext.grantPermissions() for more details. Defaults to none.
- setProxy Proxy (optional)#
  - setServer String
    
    Proxy to be used for all requests. HTTP and SOCKS proxies are supported, for example http://myproxy.com:3128 or socks5://myproxy.com:3128. Short form myproxy.com:3128 is considered an HTTP proxy.
  - setBypass String (optional)
    
    Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
  - setUsername String (optional)
    
    Optional username to use if HTTP proxy requires authentication.
  - setPassword String (optional)
    
    Optional password to use if HTTP proxy requires authentication.
  Network proxy settings to use with this context. Defaults to none.
- setRecordHarContent enum HarContentPolicy { OMIT, EMBED, ATTACH } (optional)#
  
  Optional setting to control resource content management. If omit is specified, content is not persisted. If attach is specified, resources are persisted as separate files and all of these files are archived along with the HAR file. Defaults to embed, which stores content inline the HAR file as per HAR specification.
- setRecordHarMode enum HarMode { 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 to full.
- setRecordHarOmitContent boolean (optional)#
  
  Optional setting to control whether to omit request content from the HAR. Defaults to false.
- setRecordHarPath Path (optional)#
  
  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.
- setRecordHarUrlFilter String | Pattern (optional)#
- setRecordVideoDir Path (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.
- setRecordVideoSize RecordVideoSize (optional)#
  - setWidth int
    
    Video frame width.
  - setHeight int
    
    Video frame height.
  Dimensions of the recorded videos. If not specified the size will be equal to viewport scaled down to fit into 800x800. If viewport is 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.
- setReducedMotion null | enum ReducedMotion { REDUCE, NO_PREFERENCE } (optional)#
  
  Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See Page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.
- setScreenSize ScreenSize (optional)#
  - setWidth int
    
    page width in pixels.
  - setHeight int
    
    page height in pixels.
  Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewport is set.
- setServiceWorkers enum ServiceWorkerPolicy { 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.
- setStorageState String (optional)#
  
  Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.storageState().
- setStorageStatePath Path (optional) Added in: v1.9#
  
  Populates 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.
- setStrictSelectors boolean (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.
- setTimezoneId String (optional)#
  
  Changes the timezone of the context. See ICU's metaZones.txt for a list of supported timezone IDs. Defaults to the system timezone.
- setUserAgent String (optional)#
  
  Specific user agent to use in this context.
- setViewportSize null | ViewportSize (optional)#
  - setWidth int
    
    page width in pixels.
  - setHeight int
    
    page height in pixels.
  Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.
  
  note
  The null value 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.

Returns

Page #

startTracing

Added in: v1.11

browser.startTracing

note

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.goto('https://www.google.com');
browser.stopTracing();

Arguments

page Page (optional)#

Optional, if specified, tracing includes screenshots of the given page.
options Browser.StartTracingOptions (optional)
- setCategories List<String> (optional)#
  
  specify custom categories to use instead of default.
- setPath Path (optional)#
  
  A path to write the trace file to.
- setScreenshots boolean (optional)#
  
  captures screenshots in the trace.

Returns

void #

stopTracing

Added in: v1.11

browser.stopTracing

note

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.

Usage

Browser.stopTracing();

Returns

byte[]#

version

Added before v1.9

browser.version

Returns the browser version.

Usage

Browser.version();

Returns

String #

Events

onDisconnected(handler)

Added before v1.9

browser.onDisconnected(handler)

Emitted 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.

Usage

Browser.onDisconnected(handler)

Event data

Browser

Methods​

browserType​

close​

contexts​

isConnected​

newBrowserCDPSession​

newContext​

newPage​

startTracing​

stopTracing​

version​

Events​

onDisconnected(handler)​

Methods

browserType

close

contexts

isConnected

newBrowserCDPSession

newContext

newPage

startTracing

stopTracing

version

Events

onDisconnected(handler)