Interface BrowserContext

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

Usage

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

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;

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

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');

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.

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 newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
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).

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]).

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').

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').

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').

NOTE Service workers are only supported on Chromium-based browsers.

Emitted when new service worker is created in the context.

NOTE Background pages are only supported on Chromium-based browsers.

All existing background pages in the context.

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

Clears context cookies.

Clears all permission overrides for the browser context.

Usage

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

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

NOTE The default browser context cannot be closed.

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

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.

Usage

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.getByRole('button').click();
})();

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>
`);

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.

Usage

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.getByRole('button').click();
})();

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>
`);

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.

Usage

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.getByRole('button').click();
})();

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

NOTE CDP sessions are only supported on Chromium-based browsers.

Returns the newly created session.

Creates a new page in the browser context.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

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');

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.

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 newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
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).

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]).

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').

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').

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').

NOTE Service workers are only supported on Chromium-based browsers.

Emitted when new service worker is created in the context.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Adds an event listener that will be automatically removed after it is triggered once. See addListener for more information about this event.

Returns all open pages in the context.

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');

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.

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 newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
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).

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]).

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').

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').

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').

NOTE Service workers are only supported on Chromium-based browsers.

Emitted when new service worker is created in the context.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

Removes an event listener added by on or addListener.

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.route(url, handler[, options]) 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:

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.

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

NOTE Service workers are only supported on Chromium-based browsers.

All existing service workers in the context.

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

• page.goBack([options])
• page.goForward([options])
• page.goto(url[, options])
• page.reload([options])
• page.setContent(html[, options])
• page.waitForNavigation([options])

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

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

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.

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

Usage

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.

Deprecated

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

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

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

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');

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.

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 newPagePromise = context.waitForEvent('page');
await page.getByText('open new page').click();
const newPage = await newPagePromise;
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).

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]).

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').

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').

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').

NOTE Service workers are only supported on Chromium-based browsers.

Emitted when new service worker is created in the context.