Skip to main content

Browser

A Browser is created via BrowserType.LaunchAsync(). An example of using a Browser to create a Page:

using Microsoft.Playwright;

using var playwright = await Playwright.CreateAsync();
var firefox = playwright.Firefox;
var browser = await firefox.LaunchAsync(new() { Headless = false });
var page = await browser.NewPageAsync();
await page.GotoAsync("https://www.bing.com");
await browser.CloseAsync();

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

CloseAsync​

Added before v1.9 browser.CloseAsync

In case this browser is obtained using BrowserType.LaunchAsync(), 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.CloseAsync() on any BrowserContext's you explicitly created earlier with Browser.NewContextAsync() before calling Browser.CloseAsync().

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

Usage

await Browser.CloseAsync(options);

Arguments

  • options BrowserCloseOptions? (optional)

    • Reason string? (optional) Added in: v1.40#

      The reason to be reported to the operations interrupted by the browser closure.

Returns

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

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync();
System.Console.WriteLine(browser.Contexts.Count); // prints "0"
var context = await browser.NewContextAsync();
System.Console.WriteLine(browser.Contexts.Count); // prints "1"

Returns

IsConnected​

Added before v1.9 browser.IsConnected

Indicates that the browser is connected.

Usage

Browser.IsConnected

Returns

NewBrowserCDPSessionAsync​

Added in: v1.11 browser.NewBrowserCDPSessionAsync
note

CDP Sessions are only supported on Chromium-based browsers.

Returns the newly created browser session.

Usage

await Browser.NewBrowserCDPSessionAsync();

Returns

NewContextAsync​

Added before v1.9 browser.NewContextAsync

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.CloseAsync() when your code is done with the BrowserContext, and before calling Browser.CloseAsync(). This will ensure the context is closed gracefully and any artifacts—like HARs and videos—are fully flushed and saved.

Usage

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync();
// Create a new incognito browser context.
var context = await browser.NewContextAsync();
// Create a new page in a pristine context.
var page = await context.NewPageAsync(); ;
await page.GotoAsync("https://www.bing.com");

// Gracefully close up everything
await context.CloseAsync();
await browser.CloseAsync();

Arguments

  • options BrowserNewContextOptions? (optional)

    • AcceptDownloads bool? (optional)#

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

    • BaseURL string? (optional)#

      When using Page.GotoAsync(), Page.RouteAsync(), Page.WaitForURLAsync(), Page.RunAndWaitForRequestAsync(), or Page.RunAndWaitForResponseAsync() 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 bool? (optional)#

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

    • ClientCertificates IEnumerable?<ClientCertificates> (optional) Added in: 1.46#

      • Origin string

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

      • CertPath string? (optional)

        Path to the file with the certificate in PEM format.

      • Cert byte[]? (optional)

        Direct value of the certificate in PEM format.

      • KeyPath string? (optional)

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

      • Key byte[]? (optional)

        Direct value of the private key in PEM format.

      • PfxPath string? (optional)

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

      • Pfx byte[]? (optional)

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

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

    • ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }? (optional)#

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

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

    • ExtraHTTPHeaders IDictionary?<string, string> (optional)#

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

    • ForcedColors enum ForcedColors { Active, None, Null }? (optional)#

      Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'none'.

    • Geolocation Geolocation? (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.

    • HasTouch bool? (optional)#

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

    • HttpCredentials HttpCredentials? (optional)#

      • Username string

      • Password string

      • Origin string? (optional)

        Restrain sending http credentials on specific origin (scheme://host:port).

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

    • IgnoreHTTPSErrors bool? (optional)#

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

    • IsMobile bool? (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.

    • JavaScriptEnabled bool? (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 bool? (optional)#

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

    • Permissions IEnumerable?<string> (optional)#

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

    • Proxy Proxy? (optional)#

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

      Network proxy settings to use with this context. Defaults to none.

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

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

    • RecordHarOmitContent bool? (optional)#

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

    • RecordHarPath string? (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.CloseAsync() for the HAR to be saved.

    • RecordHarUrlFilter|RecordHarUrlFilterRegex string? | Regex? (optional)#

    • RecordVideoDir string? (optional)#

      Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call BrowserContext.CloseAsync() for videos to be saved.

    • RecordVideoSize RecordVideoSize? (optional)#

      • Width int

        Video frame width.

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

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (optional)#

      Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'no-preference'.

    • ScreenSize ScreenSize? (optional)#

      • Width int

        page width in pixels.

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

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

    • StorageState string? (optional)#

      Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.StorageStateAsync().

    • StorageStatePath string? (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.StorageStateAsync(). Path to the file with saved storage state.

    • StrictSelectors bool? (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.

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

    • UserAgent string? (optional)#

      Specific user agent to use in this context.

    • ViewportSize ViewportSize? (optional)#

      • Width int

        page width in pixels.

      • Height int

        page height in pixels.

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

      note

      The ViewportSize.NoViewport 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

NewPageAsync​

Added before v1.9 browser.NewPageAsync

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.NewContextAsync() followed by the BrowserContext.NewPageAsync() to control their exact life times.

Usage

await Browser.NewPageAsync(options);

Arguments

  • options BrowserNewPageOptions? (optional)

    • AcceptDownloads bool? (optional)#

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

    • BaseURL string? (optional)#

      When using Page.GotoAsync(), Page.RouteAsync(), Page.WaitForURLAsync(), Page.RunAndWaitForRequestAsync(), or Page.RunAndWaitForResponseAsync() 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 bool? (optional)#

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

    • ClientCertificates IEnumerable?<ClientCertificates> (optional) Added in: 1.46#

      • Origin string

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

      • CertPath string? (optional)

        Path to the file with the certificate in PEM format.

      • Cert byte[]? (optional)

        Direct value of the certificate in PEM format.

      • KeyPath string? (optional)

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

      • Key byte[]? (optional)

        Direct value of the private key in PEM format.

      • PfxPath string? (optional)

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

      • Pfx byte[]? (optional)

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

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

    • ColorScheme enum ColorScheme { Light, Dark, NoPreference, Null }? (optional)#

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

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

    • ExtraHTTPHeaders IDictionary?<string, string> (optional)#

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

    • ForcedColors enum ForcedColors { Active, None, Null }? (optional)#

      Emulates 'forced-colors' media feature, supported values are 'active', 'none'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'none'.

    • Geolocation Geolocation? (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.

    • HasTouch bool? (optional)#

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

    • HttpCredentials HttpCredentials? (optional)#

      • Username string

      • Password string

      • Origin string? (optional)

        Restrain sending http credentials on specific origin (scheme://host:port).

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

    • IgnoreHTTPSErrors bool? (optional)#

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

    • IsMobile bool? (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.

    • JavaScriptEnabled bool? (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 bool? (optional)#

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

    • Permissions IEnumerable?<string> (optional)#

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

    • Proxy Proxy? (optional)#

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

      Network proxy settings to use with this context. Defaults to none.

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

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

    • RecordHarOmitContent bool? (optional)#

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

    • RecordHarPath string? (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.CloseAsync() for the HAR to be saved.

    • RecordHarUrlFilter|RecordHarUrlFilterRegex string? | Regex? (optional)#

    • RecordVideoDir string? (optional)#

      Enables video recording for all pages into the specified directory. If not specified videos are not recorded. Make sure to call BrowserContext.CloseAsync() for videos to be saved.

    • RecordVideoSize RecordVideoSize? (optional)#

      • Width int

        Video frame width.

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

    • ReducedMotion enum ReducedMotion { Reduce, NoPreference, Null }? (optional)#

      Emulates 'prefers-reduced-motion' media feature, supported values are 'reduce', 'no-preference'. See Page.EmulateMediaAsync() for more details. Passing 'null' resets emulation to system defaults. Defaults to 'no-preference'.

    • ScreenSize ScreenSize? (optional)#

      • Width int

        page width in pixels.

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

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

    • StorageState string? (optional)#

      Populates context with given storage state. This option can be used to initialize context with logged-in information obtained via BrowserContext.StorageStateAsync().

    • StorageStatePath string? (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.StorageStateAsync(). Path to the file with saved storage state.

    • StrictSelectors bool? (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.

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

    • UserAgent string? (optional)#

      Specific user agent to use in this context.

    • ViewportSize ViewportSize? (optional)#

      • Width int

        page width in pixels.

      • Height int

        page height in pixels.

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

      note

      The ViewportSize.NoViewport 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

Version​

Added before v1.9 browser.Version

Returns the browser version.

Usage

Browser.Version

Returns

Events​

event Disconnected​

Added before v1.9 browser.event Disconnected

Emitted when Browser gets disconnected from the browser application. This might happen because of one of the following:

Usage

Browser.Disconnected += async (_, browser) => {};

Event data