Version: 1.6.0

Browser

A Browser is created when Playwright connects to a browser instance, either through browserType.launch or browserType.connect.

An example of using a Browser to create a Page:

const { firefox } = require('playwright'); // Or 'chromium' or 'webkit'.
(async () => {
const browser = await firefox.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
await browser.close();
})();

See ChromiumBrowser, FirefoxBrowser and WebKitBrowser for browser-specific features. Note that browserType.connect(options) and browserType.launch([options]) always return a specific browser instance, based on the browser being connected to or launched.

event: 'disconnected'#

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.

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 obtained using browserType.connect, clears all created contexts belonging to this browser and disconnects from the browser server.

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

browser.contexts()#

Returns an array of all open browser contexts. In a newly created browser, this will return zero browser contexts.

const browser = await pw.webkit.launch();
console.log(browser.contexts().length); // prints `0`
const context = await browser.newContext();
console.log(browser.contexts().length); // prints `1`

browser.isConnected()#

Indicates that the browser is connected.

browser.newContext([options])#

  • options <Object>
    • acceptDownloads <boolean> Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.
    • ignoreHTTPSErrors <boolean> Whether to ignore HTTPS errors during navigation. Defaults to false.
    • bypassCSP <boolean> Toggles bypassing page's Content-Security-Policy.
    • viewport <null|Object> Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.
      • width <number> page width in pixels.
      • height <number> page height in pixels.
    • userAgent <string> Specific user agent to use in this context.
    • deviceScaleFactor <number> Specify device scale factor (can be thought of as dpr). Defaults to 1.
    • isMobile <boolean> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
    • hasTouch <boolean> Specifies if viewport supports touch events. Defaults to false.
    • javaScriptEnabled <boolean> Whether or not to enable JavaScript in the context. Defaults to true.
    • timezoneId <string> Changes the timezone of the context. See ICU’s metaZones.txt for a list of supported timezone IDs.
    • geolocation <Object>
      • latitude <number> Latitude between -90 and 90.
      • longitude <number> Longitude between -180 and 180.
      • accuracy <number> Non-negative accuracy value. Defaults to 0.
    • locale <string> 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.
    • permissions <Array<string>> A list of permissions to grant to all pages in this context. See browserContext.grantPermissions for more details.
    • extraHTTPHeaders <Object<string, string>> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
    • offline <boolean> Whether to emulate network being offline. Defaults to false.
    • httpCredentials <Object> Credentials for HTTP authentication.
    • colorScheme <"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia(options) for more details. Defaults to 'light'.
    • logger <Logger> Logger sink for Playwright logging.
    • proxy <Object> Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).
      • 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 coma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
      • username <string> Optional username to use if HTTP proxy requires authentication.
      • password <string> Optional password to use if HTTP proxy requires authentication.
    • videosPath <string> NOTE Use recordVideo instead, it takes precedence over videosPath. Enables video recording for all pages to videosPath directory. If not specified, videos are not recorded. Make sure to await browserContext.close for videos to be saved.
    • videoSize <Object> NOTE Use recordVideo instead, it takes precedence over videoSize. Specifies dimensions of the automatically recorded video. Can only be used if videosPath is set. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
      • width <number> Video frame width.
      • height <number> Video frame height.
    • recordHar <Object> Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await browserContext.close for the HAR to be saved.
      • omitContent <boolean> Optional setting to control whether to omit request content from the HAR. Defaults to false.
      • path <string> Path on the filesystem to write the HAR file to.
    • recordVideo <Object> Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await browserContext.close for videos to be saved.
      • dir <string> Path to the directory to put videos into.
      • size <Object> Optional dimensions of the recorded videos. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary to fit the specified size.
        • width <number> Video frame width.
        • height <number> Video frame height.
  • returns: <Promise<BrowserContext>>

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

(async () => {
const browser = await playwright.firefox.launch(); // Or 'chromium' or 'webkit'.
// Create a new incognito browser context.
const context = await browser.newContext();
// Create a new page in a pristine context.
const page = await context.newPage();
await page.goto('https://example.com');
})();

browser.newPage([options])#

  • options <Object>
    • acceptDownloads <boolean> Whether to automatically download all the attachments. Defaults to false where all the downloads are canceled.
    • ignoreHTTPSErrors <boolean> Whether to ignore HTTPS errors during navigation. Defaults to false.
    • bypassCSP <boolean> Toggles bypassing page's Content-Security-Policy.
    • viewport <null|Object> Sets a consistent viewport for each page. Defaults to an 1280x720 viewport. null disables the default viewport.
      • width <number> page width in pixels.
      • height <number> page height in pixels.
    • userAgent <string> Specific user agent to use in this context.
    • deviceScaleFactor <number> Specify device scale factor (can be thought of as dpr). Defaults to 1.
    • isMobile <boolean> Whether the meta viewport tag is taken into account and touch events are enabled. Defaults to false. Not supported in Firefox.
    • hasTouch <boolean> Specifies if viewport supports touch events. Defaults to false.
    • javaScriptEnabled <boolean> Whether or not to enable JavaScript in the context. Defaults to true.
    • timezoneId <string> Changes the timezone of the context. See ICU’s metaZones.txt for a list of supported timezone IDs.
    • geolocation <Object>
      • latitude <number> Latitude between -90 and 90.
      • longitude <number> Longitude between -180 and 180.
      • accuracy <number> Non-negative accuracy value. Defaults to 0.
    • locale <string> 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.
    • permissions <Array<string>> A list of permissions to grant to all pages in this context. See browserContext.grantPermissions for more details.
    • extraHTTPHeaders <Object<string, string>> An object containing additional HTTP headers to be sent with every request. All header values must be strings.
    • offline <boolean> Whether to emulate network being offline. Defaults to false.
    • httpCredentials <Object> Credentials for HTTP authentication.
    • colorScheme <"light"|"dark"|"no-preference"> Emulates 'prefers-colors-scheme' media feature, supported values are 'light', 'dark', 'no-preference'. See page.emulateMedia(options) for more details. Defaults to 'light'.
    • logger <Logger> Logger sink for Playwright logging.
    • proxy <Object> Network proxy settings to use with this context. Note that browser needs to be launched with the global proxy for this option to work. If all contexts override the proxy, global proxy will be never used and can be any string, for example launch({ proxy: { server: 'per-context' } }).
      • 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 coma-separated domains to bypass proxy, for example ".com, chromium.org, .domain.com".
      • username <string> Optional username to use if HTTP proxy requires authentication.
      • password <string> Optional password to use if HTTP proxy requires authentication.
    • videosPath <string> NOTE Use recordVideo instead, it takes precedence over videosPath. Enables video recording for all pages to videosPath directory. If not specified, videos are not recorded. Make sure to await page.close for videos to be saved.
    • videoSize <Object> NOTE Use recordVideo instead, it takes precedence over videoSize. Specifies dimensions of the automatically recorded video. Can only be used if videosPath is set. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of the page will be scaled down if necessary to fit specified size.
      • width <number> Video frame width.
      • height <number> Video frame height.
    • recordHar <Object> Enables HAR recording for all pages into recordHar.path file. If not specified, the HAR is not recorded. Make sure to await page.close for the HAR to be saved.
      • omitContent <boolean> Optional setting to control whether to omit request content from the HAR. Defaults to false.
      • path <string> Path on the filesystem to write the HAR file to.
    • recordVideo <Object> Enables video recording for all pages into recordVideo.dir directory. If not specified videos are not recorded. Make sure to await page.close for videos to be saved.
      • dir <string> Path to the directory to put videos into.
      • size <Object> Optional dimensions of the recorded videos. If not specified the size will be equal to viewport. If viewport is not configured explicitly the video size defaults to 1280x720. Actual picture of each page will be scaled down if necessary to fit the specified size.
        • width <number> Video frame width.
        • height <number> Video frame height.
  • returns: <Promise<Page>>

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.

browser.version()#

Returns the browser version.