Clients.openWindow()

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The openWindow() method of the Clients interface creates a new top level browsing context and loads a given URL. If the calling script doesn't have permission to show popups, openWindow() will throw an InvalidAccessError.

In Firefox, the method is allowed to show popups only when called as the result of a notification click event.

In Chrome for Android, the method may instead open the URL in an existing browsing context provided by a standalone web app previously added to the user's home screen.

Syntax

ServiceWorkerClients.openWindow(url).then(function(WindowClient) {
  // do something with your WindowClient
});

Parameters

url
A USVString representing the URL of the client you want to open in the window. Generally this value must be a URL from the same origin as the calling script.

Return value

Promise that resolves to a WindowClient object if the URL is from the same origin as the service worker or a null value otherwise.

Examples

// When the user clicks a notification focus the window if it exists or open
// a new one otherwise.
onotificationclick = function(event) {
  var found = false;
  clients.matchAll().then(function(clientsArr) {
    for (i = 0; i < clientsArr.length; i++) {
      if (clientsArr[i].url === event.data.url) {
        // We already have a window to use, focus it.
        found = true;
        clientsArr[i].focus();
        break;
      }
    }
    if (!found) {
      // Create a new window.
      clients.openWindow(event.data.url).then(function(windowClient) {
        // do something with the windowClient.
      });
    }
  });
};

Specifications

Specification Status Comment
Service Workers
The definition of 'Clients' in that specification.
Working Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support

40

421

432

513

?454 No38 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support

40

421

432

513

40

421

432

513

?4538 No

4.0

5.03

1. Can only open URLs on the same origin.

2. Can open any URL.

3. URLs may open inside an existing browsing context provided by a standalone web app

4. Service workers (and Push) have been disabled in the Firefox 45 & 52 Extended Support Releases (ESR).

Document Tags and Contributors

Last updated by: whawker,