Skip to content

BrowserType ​

Added in: v1.8

BrowserType provides methods to launch a specific browser instance or connect to an existing one. The following is a typical example of using Playwright to drive automation:

java
import com.microsoft.playwright.*;

public class Example {
  public static void main(String[] args) {
    try (Playwright playwright = Playwright.create()) {
      BrowserType chromium = playwright.chromium();
      Browser browser = chromium.launch();
      Page page = browser.newPage();
      page.navigate("https://example.com");
      // other actions...
      browser.close();
    }
  }
}

Methods ​

browserType.connect() ​

Added in: v1.8

This method attaches Playwright to an existing browser instance created via BrowserType.launchServer in Node.js.

INFO

The major and minor version of the Playwright instance that connects needs to match the version of Playwright that launches the browser (1.2.3 → is compatible with 1.2.x).

Arguments

  • endpoint string Added in: v1.10

    A Playwright browser websocket endpoint to connect to. You obtain this endpoint via BrowserServer.wsEndpoint.

  • options Object (optional)

    • exposeNetwork string (optional) Added in: v1.37

      This option exposes network available on the connecting client to the browser being connected to. Consists of a list of rules separated by comma.

      Available rules:

      1. Hostname pattern, for example: example.com, *.org:99, x.*.y.com, *foo.org.
      2. IP literal, for example: 127.0.0.1, 0.0.0.0:99, [::1], [0:0::1]:99.
      3. <loopback> that matches local loopback interfaces: localhost, *.localhost, 127.0.0.1, [::1].

      Some common examples:

      1. "*" to expose all network.
      2. "<loopback>" to expose localhost network.
      3. "*.test.internal-domain,*.staging.internal-domain,<loopback>" to expose test/staging deployments and localhost.
    • headers Object<string, string> (optional) Added in: v1.11

      Additional HTTP headers to be sent with web socket connect request. Optional.

    • slowMo float (optional) Added in: v1.10

      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

    • timeout float (optional) Added in: v1.10

      Maximum time in milliseconds to wait for the connection to be established. Defaults to 0 (no timeout).

Returns

  • Browser

browserType.connectOverCDP() ​

Added in: v1.9

This method attaches Playwright to an existing browser instance using the Chrome DevTools Protocol.

The default browser context is accessible via browser.contexts().

INFO

Connecting over the Chrome DevTools Protocol is only supported for Chromium-based browsers.

INFO

This connection is significantly lower fidelity than the Playwright protocol connection via browserType.connect(). If you are experiencing issues or attempting to use advanced functionality, you probably want to use browserType.connect().

WARNING

Playwright maintains a curated list of arguments for launching the browser. If you launch the browser without Playwright and do not pass the exact same arguments, some of Playwright functionality may be broken upon connecting to the browser.

Usage

java
Browser browser = playwright.chromium().connectOverCDP("http://localhost:9222");
BrowserContext defaultContext = browser.contexts().get(0);
Page page = defaultContext.pages().get(0);

Arguments

  • endpointURL string Added in: v1.11

    A CDP websocket endpoint or http url to connect to. For example http://localhost:9222/ or ws://127.0.0.1:9222/devtools/browser/387adf4c-243f-4051-a181-46798f4a46f4.

    Alternatively, a URL that tells which running browser to connect to:

    • remote-debugging://<channel> - a browser with remote debugging enabled, for example remote-debugging://msedge. The optional userDataDir parameter is the user data directory of the browser, when it is not the default one: remote-debugging://chrome?userDataDir=/path/to/data. A bare channel name such as chrome is the same as remote-debugging://chrome.
    • extension://<channel>/<profile directory> - the tabs of a browser profile, through the Playwright Extension, for example extension://chrome/Profile 1. Playwright opens the connect page of the extension in that profile, and the user selects the tabs to share. Without the profile directory, Playwright uses the Default profile. The optional parameters are userDataDir, the user data directory of the browser when it is not the default one, and executablePath, the path to the browser executable when it is not at the standard location: extension://chromium?executablePath=/path/to/chrome&userDataDir=/path/to/data. Pass the other options of this connection in headers.

    The values of userDataDir and executablePath must be URL-encoded, for example with encodeURIComponent or URLSearchParams. The channel is a browser channel name such as chrome, chrome-beta or msedge. The default user data directory of the channel is where the browser keeps its data. On Linux, Playwright uses CHROME_USER_DATA_DIR when set. Otherwise, it uses CHROME_CONFIG_HOME, then XDG_CONFIG_HOME, then ~/.config to locate that directory.

  • options Object (optional)

    • artifactsDir path (optional) Added in: v1.61

      If specified, browser artifacts (such as traces and downloads) are saved into this directory.

    • headers Object<string, string> (optional) Added in: v1.11

      Additional HTTP headers to be sent with connect request. Optional.

      When endpointURL is an extension URL such as extension://chrome, the headers are not sent. They are the options of the connection:

      • x-playwright-extension-token - the token of the extension. With the token, the user does not have to approve the connection. Without the token, the user must approve the connection before timeout expires, so set it to a value that gives the user enough time.
      • x-playwright-extension-client-name - the name of the client that the extension shows to the user.
      • x-playwright-extension-tab-group - pass false to keep the tabs out of a tab group.
      • x-playwright-extension-tab-group-title - the title of the tab group.
      • x-playwright-extension-tab-group-color - the color of the tab group: green, blue, purple, orange, pink, cyan, yellow or red.
      • x-playwright-extension-background - pass true to keep the tabs from becoming active.
    • isLocal boolean (optional) Added in: v1.58

      Tells Playwright that it runs on the same host as the CDP server. It will enable certain optimizations that rely upon the file system being the same between Playwright and the Browser.

    • noDefaults boolean (optional) Added in: v1.60

      When true, Playwright will not apply its default overrides to the existing default browser context. Specifically, acceptDownloads and font families are left at the browser's settings, focus emulation is not enabled, and media emulation options (such as colorScheme, reducedMotion, forcedColors, and contrast) are not applied. Useful when attaching to a user's daily-driver browser where these overrides would interfere with existing browser state. New contexts created via browser.newContext() are not affected. Defaults to false.

    • slowMo float (optional) Added in: v1.11

      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on. Defaults to 0.

    • timeout float (optional) Added in: v1.11

      Maximum time in milliseconds to wait for the connection to be established. Defaults to 30000 (30 seconds). Pass 0 to disable timeout.

Returns

  • Browser

browserType.executablePath() ​

Added in: v1.8

A path where Playwright expects to find a bundled browser executable.

Returns

  • string

browserType.launch() ​

Added in: v1.8

Returns the browser instance.

Usage

You can use ignoreDefaultArgs to filter out --mute-audio from default arguments:

java
// Or "firefox" or "webkit".
Browser browser = chromium.launch(new BrowserType.LaunchOptions()
  .setIgnoreDefaultArgs(Arrays.asList("--mute-audio")));

Chromium-only Playwright can also be used to control the Google Chrome or Microsoft Edge browsers, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use executablePath option with extreme caution.

If Google Chrome (rather than Chromium) is preferred, a Chrome Canary or Dev Channel build is suggested.

Stock browsers like Google Chrome and Microsoft Edge are suitable for tests that require proprietary media codecs for video playback. See this article for other differences between Chromium and Chrome. This article describes some differences for Linux users.

Arguments

  • options Object (optional)

    • args Array<string> (optional)

      WARNING

      Use custom browser args at your own risk, as some of them may break Playwright functionality.

      Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

    • artifactsDir path (optional)

      If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.

    • channel string (optional)

      Browser distribution channel.

      Use "chromium" to opt in to new headless mode.

      Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.

    • chromiumSandbox boolean (optional)

      Enable Chromium sandboxing. Defaults to false.

    • downloadsPath path (optional)

      If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.

    • env Object<string, string> (optional)

      Specify environment variables that will be visible to the browser. Defaults to process.env.

    • executablePath path (optional)

      Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.

    • firefoxUserPrefs Object<string, any> (optional)

      Firefox user preferences. Learn more about the Firefox user preferences at about:config.

      You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.

    • handleSIGHUP boolean (optional)

      Close the browser process on SIGHUP. Defaults to true.

    • handleSIGINT boolean (optional)

      Close the browser process on Ctrl-C. Defaults to true.

    • handleSIGTERM boolean (optional)

      Close the browser process on SIGTERM. Defaults to true.

    • headless boolean (optional)

      Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.

    • ignoreAllDefaultArgs boolean (optional) Added in: v1.9

      If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care. Defaults to false.

    • ignoreDefaultArgs Array<string> (optional)

      If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care.

    • proxy Object (optional)

      Network proxy settings.

      • server 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.

      • bypass string (optional)

        Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

      • username string (optional)

        Optional username to use if HTTP proxy requires authentication.

      • password string (optional)

        Optional password to use if HTTP proxy requires authentication.

    • slowMo float (optional)

      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.

    • timeout float (optional)

      Maximum time in milliseconds to wait for the browser instance to start. Defaults to 180000 (3 minutes). Pass 0 to disable timeout.

    • tracesDir path (optional)

      If specified, traces are saved into this directory.

Returns

  • Browser

browserType.launchPersistentContext() ​

Added in: v1.8

Returns the persistent browser context instance.

Launches browser that uses persistent storage located at userDataDir and returns the only context. Closing this context will automatically close the browser.

Arguments

  • userDataDir path

    Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty string to create a temporary directory.

    More details for Chromium and Firefox. Chromium's user data directory is the parent directory of the "Profile Path" seen at chrome://version.

    Note that browsers do not allow launching multiple instances with the same User Data Directory.

    WARNING

    Chromium/Chrome: Due to recent Chrome policy changes, automating the default Chrome user profile is not supported. Pointing userDataDir to Chrome's main "User Data" directory (the profile used for your regular browsing) may result in pages not loading or the browser exiting. Create and use a separate directory (for example, an empty folder) as your automation profile instead. See https://developer.chrome.com/blog/remote-debugging-port for details.

  • options Object (optional)

    • acceptDownloads boolean (optional)

      Whether to automatically download all the attachments. Defaults to true where all the downloads are accepted.

    • args Array<string> (optional)

      WARNING

      Use custom browser args at your own risk, as some of them may break Playwright functionality.

      Additional arguments to pass to the browser instance. The list of Chromium flags can be found here.

    • artifactsDir path (optional)

      If specified, artifacts (traces, videos, downloads, HAR files, etc.) are saved into this directory. The directory is not cleaned up when the browser closes. If not specified, a temporary directory is used and cleaned up when the browser closes.

    • baseURL 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
    • bypassCSP boolean (optional)

      Toggles bypassing page's Content-Security-Policy. Defaults to false.

    • channel string (optional)

      Browser distribution channel.

      Use "chromium" to opt in to new headless mode.

      Use "chrome", "chrome-beta", "chrome-dev", "chrome-canary", "msedge", "msedge-beta", "msedge-dev", or "msedge-canary" to use branded Google Chrome and Microsoft Edge.

    • chromiumSandbox boolean (optional)

      Enable Chromium sandboxing. Defaults to false.

    • clientCertificates Array<Object> (optional) Added in: v1.46

      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.

      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 origin that does not match any of the domains you plan to visit.

      INFO

      When using WebKit on macOS, accessing localhost will not pick up client certificates. You can make it work by replacing localhost with local.playwright.

      • origin string Added in: v1.46

        Exact origin that the certificate is valid for. Origin includes https protocol, a hostname and optionally a port.

      • certPath path (optional) Added in: v1.46

        Path to the file with the certificate in PEM format.

      • cert Buffer (optional) Added in: v1.46

        Direct value of the certificate in PEM format.

      • keyPath path (optional) Added in: v1.46

        Path to the file with the private key in PEM format.

      • key Buffer (optional) Added in: v1.46

        Direct value of the private key in PEM format.

      • pfxPath path (optional) Added in: v1.46

        Path to the PFX or PKCS12 encoded private key and certificate chain.

      • pfx Buffer (optional) Added in: v1.46

        Direct value of the PFX or PKCS12 encoded private key and certificate chain.

      • passphrase string (optional) Added in: v1.46

        Passphrase for the private key (PEM or PFX).

    • colorScheme null | "light" | "dark" | "no-preference" (optional)

      Emulates prefers-colors-scheme media feature, supported values are 'light' and 'dark'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'light'.

    • contrast null | "no-preference" | "more" (optional)

      Emulates 'prefers-contrast' media feature, supported values are 'no-preference', 'more'. See page.emulateMedia() for more details. Passing null resets emulation to system defaults. Defaults to 'no-preference'.

    • deviceScaleFactor float (optional)

      Specify device scale factor (can be thought of as dpr). Defaults to 1. Learn more about emulating devices with device scale factor.

    • downloadsPath path (optional)

      If specified, accepted downloads are downloaded into this directory. Otherwise, temporary directory is created and is deleted when browser is closed. In either case, the downloads are deleted when the browser context they were created in is closed.

    • env Object<string, string> (optional)

      Specify environment variables that will be visible to the browser. Defaults to process.env.

    • executablePath path (optional)

      Path to a browser executable to run instead of the bundled one. If executablePath is a relative path, then it is resolved relative to the current working directory. Note that Playwright only works with the bundled Chromium, Firefox or WebKit, use at your own risk.

    • extraHTTPHeaders Object<string, string> (optional)

      An object containing additional HTTP headers to be sent with every request. Defaults to none.

    • firefoxUserPrefs Object<string, any> (optional) Added in: v1.40

      Firefox user preferences. Learn more about the Firefox user preferences at about:config.

      You can also provide a path to a custom policies.json file via PLAYWRIGHT_FIREFOX_POLICIES_JSON environment variable.

    • forcedColors null | "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'.

    • geolocation Object (optional)

      • latitude float

        Latitude between -90 and 90.

      • longitude float

        Longitude between -180 and 180.

      • accuracy float (optional)

        Non-negative accuracy value. Defaults to 0.

    • handleSIGHUP boolean (optional)

      Close the browser process on SIGHUP. Defaults to true.

    • handleSIGINT boolean (optional)

      Close the browser process on Ctrl-C. Defaults to true.

    • handleSIGTERM boolean (optional)

      Close the browser process on SIGTERM. Defaults to true.

    • hasTouch boolean (optional)

      Specifies if viewport supports touch events. Defaults to false. Learn more about mobile emulation.

    • headless boolean (optional)

      Whether to run browser in headless mode. More details for Chromium and Firefox. Defaults to true.

    • httpCredentials Object | 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.

      • username string

      • password string

      • origin string (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' - 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'.

    • ignoreAllDefaultArgs boolean (optional) Added in: v1.9

      If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care. Defaults to false.

    • ignoreDefaultArgs Array<string> (optional)

      If true, Playwright does not pass its own configurations args and only uses the ones from args. Dangerous option; use with care.

    • ignoreHTTPSErrors boolean (optional)

      Whether to ignore HTTPS errors when sending network requests. Defaults to false.

    • isMobile 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. Learn more about mobile emulation.

    • javaScriptEnabled boolean (optional)

      Whether or not to enable JavaScript in the context. Defaults to true. Learn more about disabling JavaScript.

    • locale 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.

    • offline boolean (optional)

      Whether to emulate network being offline. Defaults to false. Learn more about network emulation.

    • permissions Array<string> (optional)

      A list of permissions to grant to all pages in this context. See browserContext.grantPermissions() for more details. Defaults to none.

    • proxy Object (optional)

      Network proxy settings.

      • server 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.

      • bypass string (optional)

        Optional comma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".

      • username string (optional)

        Optional username to use if HTTP proxy requires authentication.

      • password string (optional)

        Optional password to use if HTTP proxy requires authentication.

    • recordHarContent "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.

    • 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 to full.

    • recordHarOmitContent boolean (optional)

      Optional setting to control whether to omit request content from the HAR. Defaults to false.

    • recordHarPath 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.

    • recordHarUrlFilter string | RegExp (optional)

    • recordVideoDir 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.

    • recordVideoFps int (optional) Added in: v1.64

      Frame rate of the recorded videos in frames per second. Defaults to 25. Firefox and WebKit currently capture up to 25 frames per second.

    • recordVideoSize Object (optional)

      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.

      • width int

        Video frame width.

      • height int

        Video frame height.

    • reducedMotion null | "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'.

    • screenSize Object (optional)

      Emulates consistent window screen size available inside web page via window.screen. Is only used when the viewportSize is set.

      • width int

        page width in pixels.

      • height int

        page 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.
    • slowMo float (optional)

      Slows down Playwright operations by the specified amount of milliseconds. Useful so that you can see what is going on.

    • strictSelectors 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.

    • timeout float (optional)

      Maximum time in milliseconds to wait for the browser instance to start. Defaults to 180000 (3 minutes). Pass 0 to disable timeout.

    • timezoneId 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.

    • tracesDir path (optional)

      If specified, traces are saved into this directory.

    • userAgent string (optional)

      Specific user agent to use in this context.

    • viewportSize null | Object (optional)

      Emulates consistent viewport for each page. Defaults to an 1280x720 viewport. Use null to disable the consistent viewport emulation. Learn more about viewport emulation.

      INFO

      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.

      • width int

        page width in pixels.

      • height int

        page height in pixels.

Returns

  • BrowserContext

browserType.name() ​

Added in: v1.8

Returns browser name. For example: 'chromium', 'webkit' or 'firefox'.

Returns

  • string

Released under the Apache 2.0 License.