Skip to main content
Version: 1.15

BrowserContext

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 creation of "incognito" browser contexts with browser.newContext() method. "Incognito" browser contexts don't write any browsing data to disk.

// Create a new incognito browser contextconst context = await browser.newContext();// Create a new page inside context.const page = await context.newPage();await page.goto('https://example.com');// Dispose context once it's no longer needed.await context.close();

browserContext.on('backgroundpage')#

note

Only works with Chromium browser's persistent context.

Emitted when new background page is created in the context.

const backgroundPage = await context.waitForEvent('backgroundpage');

browserContext.on('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.close() method was called.

browserContext.on('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.on('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.

const [newPage] = await Promise.all([  context.waitForEvent('page'),  page.click('a[target=_blank]'),]);console.log(await newPage.evaluate('location.href'));
note

Use page.waitForLoadState([state, options]) to wait until the page gets to a particular state (you should not need it in most cases).

browserContext.on('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.on('request').

In order to intercept and mutate requests, see browserContext.route(url, handler[, options]) or page.route(url, handler[, options]).

browserContext.on('requestfailed')#

Emitted when a request fails, for example by timing out. To only listen for failed requests from a particular page, use page.on('requestfailed').

note

HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with browserContext.on('requestfinished') event and not with browserContext.on('requestfailed').

browserContext.on('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.on('requestfinished').

browserContext.on('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.on('response').

browserContext.on('serviceworker')#

note

Service workers are only supported on Chromium-based browsers.

Emitted when new service worker is created in the context.

browserContext.addCookies(cookies)#

  • cookies <Array<Object>>#
    • name <string>
    • value <string>
    • url <string> either url or domain / path are required. Optional.
    • domain <string> either url or domain / path are required Optional.
    • path <string> either url or domain / path are required Optional.
    • expires <number> Unix time in seconds. Optional.
    • httpOnly <boolean> Optional.
    • secure <boolean> Optional.
    • sameSite <"Strict"|"Lax"|"None"> Optional.
  • returns: <Promise<void>>#

Adds cookies into this browser context. All pages within this context will have these cookies installed. Cookies can be obtained via browserContext.cookies([urls]).

await browserContext.addCookies([cookieObject1, cookieObject2]);

browserContext.addInitScript(script[, arg])#

  • script <function|string|Object> Script to be evaluated in all pages in the browser context.#
    • path <string> Path to the JavaScript file. If path is a relative path, then it is resolved relative to the current working directory. Optional.
    • content <string> Raw script content. Optional.
  • arg <Serializable> Optional argument to pass to script (only supported when passing a function).#
  • returns: <Promise<void>>#

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.

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

// preload.jsMath.random = () => 42;
// In your playwright script, assuming the preload.js file is in same directory.await browserContext.addInitScript({  path: 'preload.js'});
note

The order of evaluation of multiple scripts installed via browserContext.addInitScript(script[, arg]) and page.addInitScript(script[, arg]) is not defined.

browserContext.backgroundPages()#

note

Background pages are only supported on Chromium-based browsers.

All existing background pages in the context.

browserContext.browser()#

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

browserContext.clearCookies()#

Clears context cookies.

browserContext.clearPermissions()#

Clears all permission overrides for the browser context.

const context = await browser.newContext();await context.grantPermissions(['clipboard-read']);// do stuff ..context.clearPermissions();

browserContext.close()#

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

note

The default browser context cannot be closed.

browserContext.cookies([urls])#

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

browserContext.exposeBinding(name, callback[, options])#

  • name <string> Name of the function on the window object.#
  • callback <function> Callback function that will be called in the Playwright's context.#
  • options <Object>
    • handle <boolean> 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: <Promise<void>>#

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.exposeBinding(name, callback[, options]) for page-only version.

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

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.
(async () => {  const browser = await webkit.launch({ headless: false });  const context = await browser.newContext();  await context.exposeBinding('pageURL', ({ page }) => page.url());  const page = await context.newPage();  await page.setContent(`    <script>      async function onClick() {        document.querySelector('div').textContent = await window.pageURL();      }    </script>    <button onclick="onClick()">Click me</button>    <div></div>  `);  await page.click('button');})();

An example of passing an element handle:

await context.exposeBinding('clicked', async (source, element) => {  console.log(await element.textContent());}, { handle: true });await page.setContent(`  <script>    document.addEventListener('click', event => window.clicked(event.target));  </script>  <div>Click me</div>  <div>Or click me</div>`);

browserContext.exposeFunction(name, callback)#

  • name <string> Name of the function on the window object.#
  • callback <function> Callback function that will be called in the Playwright's context.#
  • returns: <Promise<void>>#

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.exposeFunction(name, callback) for page-only version.

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

const { webkit } = require('playwright');  // Or 'chromium' or 'firefox'.const crypto = require('crypto');
(async () => {  const browser = await webkit.launch({ headless: false });  const context = await browser.newContext();  await context.exposeFunction('sha256', text => crypto.createHash('sha256').update(text).digest('hex'));  const page = await context.newPage();  await page.setContent(`    <script>      async function onClick() {        document.querySelector('div').textContent = await window.sha256('PLAYWRIGHT');      }    </script>    <button onclick="onClick()">Click me</button>    <div></div>  `);  await page.click('button');})();

browserContext.grantPermissions(permissions[, options])#

  • permissions <Array<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'
    • 'push'
    • 'camera'
    • 'microphone'
    • 'background-sync'
    • 'ambient-light-sensor'
    • 'accelerometer'
    • 'gyroscope'
    • 'magnetometer'
    • 'accessibility-events'
    • 'clipboard-read'
    • 'clipboard-write'
    • 'payment-handler'
  • options <Object>
  • returns: <Promise<void>>#

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

browserContext.newCDPSession(page)#

  • 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: <Promise<CDPSession>>#
note

CDP sessions are only supported on Chromium-based browsers.

Returns the newly created session.

browserContext.newPage()#

Creates a new page in the browser context.

browserContext.pages()#

Returns all open pages in the context.

browserContext.route(url, handler[, options])#

  • url <string|RegExp|function(URL):boolean> 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 <function(Route, Request)> handler function to route the request.#
  • options <Object>
    • times <number> How often a route should be used. By default it will be used every time.#
  • returns: <Promise<void>>#

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

page.route(url, handler[, options]) will not intercept requests intercepted by Service Worker. See this issue. We recommend disabling Service Workers when using request interception. Via await context.addInitScript(() => delete window.navigator.serviceWorker);

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

const context = await browser.newContext();await context.route('**/*.{png,jpg,jpeg}', route => route.abort());const page = await context.newPage();await page.goto('https://example.com');await browser.close();

or the same snippet using a regex pattern instead:

const context = await browser.newContext();await context.route(/(\.png$)|(\.jpg$)/, route => route.abort());const page = await context.newPage();await page.goto('https://example.com');await browser.close();

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 context.route('/api/**', route => {  if (route.request().postData().includes('my-string'))    route.fulfill({ body: 'mocked-data' });  else    route.continue();});

Page routes (set up with page.route(url, handler[, options])) take precedence over browser context routes when request matches both handlers.

To remove a route with its handler you can use browserContext.unroute(url[, handler]).

note

Enabling routing disables http cache.

browserContext.serviceWorkers()#

note

Service workers are only supported on Chromium-based browsers.

All existing service workers in the context.

browserContext.setDefaultNavigationTimeout(timeout)#

  • timeout <number> Maximum navigation time in milliseconds#
  • returns: <void>#

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

note

page.setDefaultNavigationTimeout(timeout) and page.setDefaultTimeout(timeout) take priority over browserContext.setDefaultNavigationTimeout(timeout).

browserContext.setDefaultTimeout(timeout)#

  • timeout <number> Maximum time in milliseconds#
  • returns: <void>#

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

note

page.setDefaultNavigationTimeout(timeout), page.setDefaultTimeout(timeout) and browserContext.setDefaultNavigationTimeout(timeout) take priority over browserContext.setDefaultTimeout(timeout).

browserContext.setExtraHTTPHeaders(headers)#

  • headers <Object<string, string>> An object containing additional HTTP headers to be sent with every request. All header values must be strings.#
  • returns: <Promise<void>>#

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.setExtraHTTPHeaders(headers). If page overrides a particular header, page-specific header value will be used instead of the browser context header value.

note

browserContext.setExtraHTTPHeaders(headers) does not guarantee the order of headers in the outgoing requests.

browserContext.setGeolocation(geolocation)#

  • geolocation <null|Object>#
    • latitude <number> Latitude between -90 and 90.
    • longitude <number> Longitude between -180 and 180.
    • accuracy <number> Non-negative accuracy value. Defaults to 0.
  • returns: <Promise<void>>#

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

await browserContext.setGeolocation({latitude: 59.95, longitude: 30.31667});
note

Consider using browserContext.grantPermissions(permissions[, options]) to grant permissions for the browser context pages to read its geolocation.

browserContext.setHTTPCredentials(httpCredentials)#

DEPRECATED Browsers may cache credentials after successful authentication. Create a new browser context instead.

browserContext.setOffline(offline)#

  • offline <boolean> Whether to emulate network being offline for the browser context.#
  • returns: <Promise<void>>#

browserContext.storageState([options])#

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

browserContext.unroute(url[, handler])#

Removes a route created with browserContext.route(url, handler[, options]). When handler is not specified, removes all routes for the url.

browserContext.waitForEvent(event[, optionsOrPredicate, options])#

  • event <string> Event name, same one would pass into browserContext.on(event).#
  • optionsOrPredicate <function|Object> Either a predicate that receives an event or an options object. Optional.#
    • predicate <function> receives the event data and resolves to truthy value when the waiting should resolve.
    • timeout <number> 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(timeout).
  • options <Object>
    • predicate <function> Receives the event data and resolves to truthy value when the waiting should resolve.#
  • returns: <Promise<Object>>#

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the context closes before the event is fired. Returns the event data value.

const [page, _] = await Promise.all([  context.waitForEvent('page'),  page.click('button')]);

browserContext._request#

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

browserContext.tracing#