Skip to main content

BrowserContext

  • extends: [EventEmitter]

BrowserContexts provide a way to operate multiple independent browser sessions.

If a page opens another page, e.g. with a window.open call, the popup will belong to the parent page's browser context.

Playwright allows creating "incognito" browser contexts with Browser.NewContextAsync() method. "Incognito" browser contexts don't write any browsing data to disk.

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Firefox.LaunchAsync(new() { Headless = false });
// Create a new incognito browser context
var context = await browser.NewContextAsync();
// Create a new page inside context.
var page = await context.NewPageAsync();
await page.GotoAsync("https://bing.com");
// Dispose context once it is no longer needed.
await context.CloseAsync();

Methods

AddCookiesAsync

Added in: v1.8 browserContext.AddCookiesAsync

Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via BrowserContext.CookiesAsync().

Usage

await context.AddCookiesAsync(new[] { cookie1, cookie2 });

Arguments

  • cookies IEnumerable<Cookie>#

    • Name string

    • Value string

    • Url string? (optional)

      either url or domain / path are required. Optional.

    • Domain string? (optional)

      either url or domain / path are required Optional.

    • Path string? (optional)

      either url or domain / path are required Optional.

    • Expires [float]? (optional)

      Unix time in seconds. Optional.

    • HttpOnly bool? (optional)

      Optional.

    • Secure bool? (optional)

      Optional.

    • SameSite enum SameSiteAttribute { Strict, Lax, None }? (optional)

      Optional.

    Adds cookies to the browser context.

    For the cookie to apply to all subdomains as well, prefix domain with a dot, like this: ".example.com".

Returns


AddInitScriptAsync

Added in: v1.8 browserContext.AddInitScriptAsync

Adds a script which would be evaluated in one of the following scenarios:

  • Whenever a page is created in the browser context or is navigated.
  • Whenever a child frame is attached or navigated in any page in the browser context. In this case, the script is evaluated in the context of the newly attached frame.

The script is evaluated after the document was created but before any of its scripts were run. This is useful to amend the JavaScript environment, e.g. to seed Math.random.

Usage

An example of overriding Math.random before the page loads:

// preload.js
Math.random = () => 42;
await context.AddInitScriptAsync(scriptPath: "preload.js");
note

The order of evaluation of multiple scripts installed via BrowserContext.AddInitScriptAsync() and Page.AddInitScriptAsync() is not defined.

Arguments

  • script string|string#

    Script to be evaluated in all pages in the browser context.

Returns


Browser

Added in: v1.8 browserContext.Browser

Returns the browser instance of the context. If it was launched as a persistent context null gets returned.

Usage

BrowserContext.Browser

Returns


ClearCookiesAsync

Added in: v1.8 browserContext.ClearCookiesAsync

Clears context cookies.

Usage

await BrowserContext.ClearCookiesAsync();

Returns


ClearPermissionsAsync

Added in: v1.8 browserContext.ClearPermissionsAsync

Clears all permission overrides for the browser context.

Usage

var context = await browser.NewContextAsync();
await context.GrantPermissionsAsync(new[] { "clipboard-read" });
// Alternatively, you can use the helper class ContextPermissions
// to specify the permissions...
// do stuff ...
await context.ClearPermissionsAsync();

Returns


CloseAsync

Added in: v1.8 browserContext.CloseAsync

Closes the browser context. All the pages that belong to the browser context will be closed.

note

The default browser context cannot be closed.

Usage

await BrowserContext.CloseAsync(options);

Arguments

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

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

Returns


CookiesAsync

Added in: v1.8 browserContext.CookiesAsync

If no URLs are specified, this method returns all cookies. If URLs are specified, only cookies that affect those URLs are returned.

Usage

await BrowserContext.CookiesAsync(urls);

Arguments

Returns


ExposeBindingAsync

Added in: v1.8 browserContext.ExposeBindingAsync

The method adds a function called name on the window object of every frame in every page in the context. When called, the function executes callback and returns a Promise which resolves to the return value of callback. If the callback returns a Promise, it will be awaited.

The first argument of the callback function contains information about the caller: { browserContext: BrowserContext, page: Page, frame: Frame }.

See Page.ExposeBindingAsync() for page-only version.

Usage

An example of exposing page URL to all frames in all pages in the context:

using Microsoft.Playwright;

using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
var context = await browser.NewContextAsync();

await context.ExposeBindingAsync("pageURL", source => source.Page.Url);
var page = await context.NewPageAsync();
await page.SetContentAsync("<script>\n" +
" async function onClick() {\n" +
" document.querySelector('div').textContent = await window.pageURL();\n" +
" }\n" +
"</script>\n" +
"<button onclick=\"onClick()\">Click me</button>\n" +
"<div></div>");
await page.GetByRole(AriaRole.Button).ClickAsync();

An example of passing an element handle:

var result = new TaskCompletionSource<string>();
var page = await Context.NewPageAsync();
await Context.ExposeBindingAsync("clicked", async (BindingSource _, IJSHandle t) =>
{
return result.TrySetResult(await t.AsElement().TextContentAsync());
});

await page.SetContentAsync("<script>\n" +
" document.addEventListener('click', event => window.clicked(event.target));\n" +
"</script>\n" +
"<div>Click me</div>\n" +
"<div>Or click me</div>\n");

await page.ClickAsync("div");
// Note: it makes sense to await the result here, because otherwise, the context
// gets closed and the binding function will throw an exception.
Assert.AreEqual("Click me", await result.Task);

Arguments

  • name string#

    Name of the function on the window object.

  • callback Action<BindingSource, T, [TResult]>#

    Callback function that will be called in the Playwright's context.

  • options BrowserContextExposeBindingOptions? (optional)

    • Handle bool? (optional)#

      Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.

Returns


ExposeFunctionAsync

Added in: v1.8 browserContext.ExposeFunctionAsync

The method adds a function called name on the window object of every frame in every page in the context. When called, the function executes callback and returns a Promise which resolves to the return value of callback.

If the callback returns a Promise, it will be awaited.

See Page.ExposeFunctionAsync() for page-only version.

Usage

An example of adding a sha256 function to all pages in the context:

using Microsoft.Playwright;
using System;
using System.Security.Cryptography;
using System.Threading.Tasks;

class BrowserContextExamples
{
public static async Task Main()
{
using var playwright = await Playwright.CreateAsync();
var browser = await playwright.Webkit.LaunchAsync(new() { Headless = false });
var context = await browser.NewContextAsync();

await context.ExposeFunctionAsync("sha256", (string input) =>
{
return Convert.ToBase64String(
SHA256.Create().ComputeHash(System.Text.Encoding.UTF8.GetBytes(input)));
});

var page = await context.NewPageAsync();
await page.SetContentAsync("<script>\n" +
" async function onClick() {\n" +
" document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');\n" +
" }\n" +
"</script>\n" +
"<button onclick=\"onClick()\">Click me</button>\n" +
"<div></div>");

await page.GetByRole(AriaRole.Button).ClickAsync();
Console.WriteLine(await page.TextContentAsync("div"));
}
}

Arguments

  • name string#

    Name of the function on the window object.

  • callback Action<T, [TResult]>#

    Callback function that will be called in the Playwright's context.

Returns


GrantPermissionsAsync

Added in: v1.8 browserContext.GrantPermissionsAsync

Grants specified permissions to the browser context. Only grants corresponding permissions to the given origin if specified.

Usage

await BrowserContext.GrantPermissionsAsync(permissions, options);

Arguments

  • permissions IEnumerable<string>#

    A permission or an array of permissions to grant. Permissions can be one of the following values:

    • 'geolocation'
    • 'midi'
    • 'midi-sysex' (system-exclusive midi)
    • 'notifications'
    • 'camera'
    • 'microphone'
    • 'background-sync'
    • 'ambient-light-sensor'
    • 'accelerometer'
    • 'gyroscope'
    • 'magnetometer'
    • 'accessibility-events'
    • 'clipboard-read'
    • 'clipboard-write'
    • 'payment-handler'
  • options BrowserContextGrantPermissionsOptions? (optional)

Returns


NewCDPSessionAsync

Added in: v1.11 browserContext.NewCDPSessionAsync
note

CDP sessions are only supported on Chromium-based browsers.

Returns the newly created session.

Usage

await BrowserContext.NewCDPSessionAsync(page);

Arguments

  • page Page|Frame#

    Target to create new session for. For backwards-compatibility, this parameter is named page, but it can be a Page or Frame type.

Returns


NewPageAsync

Added in: v1.8 browserContext.NewPageAsync

Creates a new page in the browser context.

Usage

await BrowserContext.NewPageAsync();

Returns


Pages

Added in: v1.8 browserContext.Pages

Returns all open pages in the context.

Usage

BrowserContext.Pages

Returns


RouteAsync

Added in: v1.8 browserContext.RouteAsync

Routing provides the capability to modify network requests that are made by any page in the browser context. Once route is enabled, every request matching the url pattern will stall unless it's continued, fulfilled or aborted.

note

BrowserContext.RouteAsync() will not intercept requests intercepted by Service Worker. See this issue. We recommend disabling Service Workers when using request interception by setting Browser.newContext.serviceWorkers to 'block'.

Usage

An example of a naive handler that aborts all image requests:

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync("**/*.{png,jpg,jpeg}", r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();

or the same snippet using a regex pattern instead:

var context = await browser.NewContextAsync();
var page = await context.NewPageAsync();
await context.RouteAsync(new Regex("(\\.png$)|(\\.jpg$)"), r => r.AbortAsync());
await page.GotoAsync("https://theverge.com");
await browser.CloseAsync();

It is possible to examine the request to decide the route action. For example, mocking all requests that contain some post data, and leaving all other requests as is:

await page.RouteAsync("/api/**", async r =>
{
if (r.Request.PostData.Contains("my-string"))
await r.FulfillAsync(body: "mocked-data");
else
await r.ContinueAsync();
});

Page routes (set up with Page.RouteAsync()) take precedence over browser context routes when request matches both handlers.

To remove a route with its handler you can use BrowserContext.UnrouteAsync().

note

Enabling routing disables http cache.

Arguments

  • url string|Regex|Func<string, bool>#

    A glob pattern, regex pattern or predicate receiving URL to match while routing. When a baseURL via the context options was provided and the passed URL is a path, it gets merged via the new URL() constructor.

  • handler Action<Route>#

    handler function to route the request.

  • options BrowserContextRouteOptions? (optional)

    • Times int? (optional) Added in: v1.15#

      How often a route should be used. By default it will be used every time.

Returns


RouteFromHARAsync

Added in: v1.23 browserContext.RouteFromHARAsync

If specified the network requests that are made in the context will be served from the HAR file. Read more about Replaying from HAR.

Playwright will not serve requests intercepted by Service Worker from the HAR file. See this issue. We recommend disabling Service Workers when using request interception by setting Browser.newContext.serviceWorkers to 'block'.

Usage

await BrowserContext.RouteFromHARAsync(har, options);

Arguments

  • har string#

    Path to a HAR file with prerecorded network data. If path is a relative path, then it is resolved relative to the current working directory.

  • options BrowserContextRouteFromHAROptions? (optional)

    • NotFound enum HarNotFound { Abort, Fallback }? (optional)#

      • If set to 'abort' any request not found in the HAR file will be aborted.
      • If set to 'fallback' falls through to the next route handler in the handler chain.

      Defaults to abort.

    • Update bool? (optional)#

      If specified, updates the given HAR with the actual network information instead of serving from file. The file is written to disk when BrowserContext.CloseAsync() is called.

    • UpdateContent enum RouteFromHarUpdateContentPolicy { Embed, Attach }? (optional) Added in: v1.32#

      Optional setting to control resource content management. If attach is specified, resources are persisted as separate files or entries in the ZIP archive. If embed is specified, content is stored inline the HAR file.

    • UpdateMode enum HarMode { Full, Minimal }? (optional) Added in: v1.32#

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

    • Url|UrlRegex string?|Regex? (optional)#

      A glob pattern, regular expression or predicate to match the request URL. Only requests with URL matching the pattern will be served from the HAR file. If not specified, all requests are served from the HAR file.

Returns


RunAndWaitForConsoleMessageAsync

Added in: v1.34 browserContext.RunAndWaitForConsoleMessageAsync

Performs action and waits for a ConsoleMessage to be logged by in the pages in the context. If predicate is provided, it passes ConsoleMessage value into the predicate function and waits for predicate(message) to return a truthy value. Will throw an error if the page is closed before the BrowserContext.Console event is fired.

Usage

await BrowserContext.RunAndWaitForConsoleMessageAsync(action, options);

Arguments

  • action Func<Task>#

    Action that triggers the event.

  • options BrowserContextRunAndWaitForConsoleMessageOptions? (optional)

    • Predicate Func<ConsoleMessage?, bool> (optional)#

      Receives the ConsoleMessage object and resolves to truthy value when the waiting should resolve.

    • Timeout [float]? (optional)#

      Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout().

Returns


WaitForConsoleMessageAsync

Added in: v1.34 browserContext.WaitForConsoleMessageAsync

Performs action and waits for a ConsoleMessage to be logged by in the pages in the context. If predicate is provided, it passes ConsoleMessage value into the predicate function and waits for predicate(message) to return a truthy value. Will throw an error if the page is closed before the BrowserContext.Console event is fired.

Usage

await BrowserContext.WaitForConsoleMessageAsync(action, options);

Arguments

  • options BrowserContextRunAndWaitForConsoleMessageOptions? (optional)
    • Predicate Func<ConsoleMessage?, bool> (optional)#

      Receives the ConsoleMessage object and resolves to truthy value when the waiting should resolve.

    • Timeout [float]? (optional)#

      Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout().

Returns


RunAndWaitForPageAsync

Added in: v1.9 browserContext.RunAndWaitForPageAsync

Performs action and waits for a new Page to be created in the context. If predicate is provided, it passes Page value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the context closes before new Page is created.

Usage

await BrowserContext.RunAndWaitForPageAsync(action, options);

Arguments

  • action Func<Task> Added in: v1.12#

    Action that triggers the event.

  • options BrowserContextRunAndWaitForPageOptions? (optional)

    • Predicate Func<Page?, bool> (optional)#

      Receives the Page object and resolves to truthy value when the waiting should resolve.

    • Timeout [float]? (optional)#

      Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout().

Returns


WaitForPageAsync

Added in: v1.9 browserContext.WaitForPageAsync

Performs action and waits for a new Page to be created in the context. If predicate is provided, it passes Page value into the predicate function and waits for predicate(event) to return a truthy value. Will throw an error if the context closes before new Page is created.

Usage

await BrowserContext.WaitForPageAsync(action, options);

Arguments

  • options BrowserContextRunAndWaitForPageOptions? (optional)
    • Predicate Func<Page?, bool> (optional)#

      Receives the Page object and resolves to truthy value when the waiting should resolve.

    • Timeout [float]? (optional)#

      Maximum time to wait for in milliseconds. Defaults to 30000 (30 seconds). Pass 0 to disable timeout. The default value can be changed by using the BrowserContext.SetDefaultTimeout().

Returns


SetDefaultNavigationTimeout

Added in: v1.8 browserContext.SetDefaultNavigationTimeout

This setting will change the default maximum navigation time for the following methods and related shortcuts:

Usage

BrowserContext.SetDefaultNavigationTimeout(timeout);

Arguments

  • timeout [float]#

    Maximum navigation time in milliseconds


SetDefaultTimeout

Added in: v1.8 browserContext.SetDefaultTimeout

This setting will change the default maximum time for all the methods accepting timeout option.

Usage

BrowserContext.SetDefaultTimeout(timeout);

Arguments

  • timeout [float]#

    Maximum time in milliseconds


SetExtraHTTPHeadersAsync

Added in: v1.8 browserContext.SetExtraHTTPHeadersAsync

The extra HTTP headers will be sent with every request initiated by any page in the context. These headers are merged with page-specific extra HTTP headers set with Page.SetExtraHTTPHeadersAsync(). If page overrides a particular header, page-specific header value will be used instead of the browser context header value.

note

BrowserContext.SetExtraHTTPHeadersAsync() does not guarantee the order of headers in the outgoing requests.

Usage

await BrowserContext.SetExtraHTTPHeadersAsync(headers);

Arguments

  • headers IDictionary<string, string>#

    An object containing additional HTTP headers to be sent with every request. All header values must be strings.

Returns


SetGeolocationAsync

Added in: v1.8 browserContext.SetGeolocationAsync

Sets the context's geolocation. Passing null or undefined emulates position unavailable.

Usage

await context.SetGeolocationAsync(new Geolocation()
{
Latitude = 59.95f,
Longitude = 30.31667f
});
note

Consider using BrowserContext.GrantPermissionsAsync() to grant permissions for the browser context pages to read its geolocation.

Arguments

  • geolocation Geolocation?#
    • Latitude [float]

      Latitude between -90 and 90.

    • Longitude [float]

      Longitude between -180 and 180.

    • Accuracy [float]? (optional)

      Non-negative accuracy value. Defaults to 0.

Returns


SetOfflineAsync

Added in: v1.8 browserContext.SetOfflineAsync

Usage

await BrowserContext.SetOfflineAsync(offline);

Arguments

  • offline bool#

    Whether to emulate network being offline for the browser context.

Returns


StorageStateAsync

Added in: v1.8 browserContext.StorageStateAsync

Returns storage state for this browser context, contains current cookies and local storage snapshot.

Usage

await BrowserContext.StorageStateAsync(options);

Arguments

  • options BrowserContextStorageStateOptions? (optional)
    • Path string? (optional)#

      The file path to save the storage state to. If path is a relative path, then it is resolved relative to current working directory. If no path is provided, storage state is still returned, but won't be saved to the disk.

Returns


UnrouteAsync

Added in: v1.8 browserContext.UnrouteAsync

Removes a route created with BrowserContext.RouteAsync(). When handler is not specified, removes all routes for the url.

Usage

await BrowserContext.UnrouteAsync(url, handler);

Arguments

Returns


UnrouteAllAsync

Added in: v1.41 browserContext.UnrouteAllAsync

Removes all routes created with BrowserContext.RouteAsync() and BrowserContext.RouteFromHARAsync().

Usage

await BrowserContext.UnrouteAllAsync(options);

Arguments

  • options BrowserContextUnrouteAllOptions? (optional)
    • Behavior enum UnrouteBehavior { Wait, IgnoreErrors, Default }? (optional)#

      Specifies wether to wait for already running handlers and what to do if they throw errors:

      • 'default' - do not wait for current handler calls (if any) to finish, if unrouted handler throws, it may result in unhandled error
      • 'wait' - wait for current handler calls (if any) to finish
      • 'ignoreErrors' - do not wait for current handler calls (if any) to finish, all errors thrown by the handlers after unrouting are silently caught

Returns


Properties

APIRequest

Added in: v1.16 browserContext.APIRequest

API testing helper associated with this context. Requests made with this API will use context cookies.

Usage

BrowserContext.APIRequest

Type


Tracing

Added in: v1.12 browserContext.Tracing

Usage

BrowserContext.Tracing

Type


Events

event Close

Added in: v1.8 browserContext.event Close

Emitted when Browser context gets closed. This might happen because of one of the following:

  • Browser context is closed.
  • Browser application is closed or crashed.
  • The Browser.CloseAsync() method was called.

Usage

BrowserContext.Close += async (_, browserContext) => {};

Event data


event Console

Added in: v1.34 browserContext.event Console

Emitted when JavaScript within the page calls one of console API methods, e.g. console.log or console.dir.

The arguments passed into console.log and the page are available on the ConsoleMessage event handler argument.

Usage

context.Console += async (_, msg) =>
{
foreach (var arg in msg.Args)
Console.WriteLine(await arg.JsonValueAsync<object>());
};

await page.EvaluateAsync("console.log('hello', 5, { foo: 'bar' })");

Event data


event Dialog

Added in: v1.34 browserContext.event Dialog

Emitted when a JavaScript dialog appears, such as alert, prompt, confirm or beforeunload. Listener must either Dialog.AcceptAsync() or Dialog.DismissAsync() the dialog - otherwise the page will freeze waiting for the dialog, and actions like click will never finish.

Usage

context.Dialog += (_, dialog) => dialog.AcceptAsync();
note

When no Page.Dialog or BrowserContext.Dialog listeners are present, all dialogs are automatically dismissed.

Event data


event Page

Added in: v1.8 browserContext.event Page

The event is emitted when a new Page is created in the BrowserContext. The page may still be loading. The event will also fire for popup pages. See also Page.Popup to receive events about popups relevant to a specific page.

The earliest moment that page is available is when it has navigated to the initial url. For example, when opening a popup with window.open('http://example.com'), this event will fire when the network request to "http://example.com" is done and its response has started loading in the popup.

var popup = await context.RunAndWaitForPageAsync(async =>
{
await page.GetByText("open new page").ClickAsync();
});
Console.WriteLine(await popup.EvaluateAsync<string>("location.href"));
note

Use Page.WaitForLoadStateAsync() to wait until the page gets to a particular state (you should not need it in most cases).

Usage

BrowserContext.Page += async (_, page) => {};

Event data


event Request

Added in: v1.12 browserContext.event Request

Emitted when a request is issued from any pages created through this context. The request object is read-only. To only listen for requests from a particular page, use Page.Request.

In order to intercept and mutate requests, see BrowserContext.RouteAsync() or Page.RouteAsync().

Usage

BrowserContext.Request += async (_, request) => {};

Event data


event RequestFailed

Added in: v1.12 browserContext.event RequestFailed

Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use Page.RequestFailed.

note

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with BrowserContext.RequestFinished event and not with BrowserContext.RequestFailed.

Usage

BrowserContext.RequestFailed += async (_, request) => {};

Event data


event RequestFinished

Added in: v1.12 browserContext.event RequestFinished

Emitted when a request finishes successfully after downloading the response body. For a successful response, the sequence of events is request, response and requestfinished. To listen for successful requests from a particular page, use Page.RequestFinished.

Usage

BrowserContext.RequestFinished += async (_, request) => {};

Event data


event Response

Added in: v1.12 browserContext.event Response

Emitted when response status and headers are received for a request. For a successful response, the sequence of events is request, response and requestfinished. To listen for response events from a particular page, use Page.Response.

Usage

BrowserContext.Response += async (_, response) => {};

Event data


event WebError

Added in: v1.38 browserContext.event WebError

Emitted when exception is unhandled in any of the pages in this context. To listen for errors from a particular page, use Page.PageError instead.

Usage

BrowserContext.WebError += async (_, webError) => {};

Event data