WindowClient

The WindowClient interface of the ServiceWorker API represents the scope of a service worker client that is a document in a browsing context, controlled by an active worker. The service worker client independently selects and uses a service worker for its own loading and sub-resources.

Methods

WindowClient inherits methods from its parent interface, Client.

WindowClient.focus()
Gives user input focus to the current client.
WindowClient.navigate()
Loads a specified URL into a controlled client page.

Properties

WindowClient inherits properties from its parent interface, Client.

WindowClient.focused Read only
A boolean that indicates whether the current client has focus.
WindowClient.visibilityState Read only
Indicates the visibility of the current client. This value can be one of "hidden", "visible", or "prerender".

Example

self.addEventListener('notificationclick', function(event) {
  console.log('On notification click: ', event.notification.tag);
  event.notification.close();

  // This looks to see if the current is already open and
  // focuses if it is
  event.waitUntil(clients.matchAll({
    type: "window"
  }).then(function(clientList) {
    for (var i = 0; i < clientList.length; i++) {
      var client = clientList[i];
      if (client.url == '/' && 'focus' in client) {
        client.focus();
        break;
      }
    }
    if (clients.openWindow)
      return clients.openWindow('/');
  }));
});

Specifications

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

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
WindowClient
Experimental
Chrome Full support 42Edge Full support ≤18Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44Opera Android ? Safari iOS No support NoSamsung Internet Android Full support 4.0
ancestorOriginsChrome ? Edge ? Firefox ? IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android ? Firefox Android ? Opera Android ? Safari iOS No support NoSamsung Internet Android ?
focus
Experimental
Chrome Full support 42Edge Full support ≤18Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44Opera Android ? Safari iOS No support NoSamsung Internet Android Full support 4.0
focused
Experimental
Chrome Full support 42Edge Full support ≤18Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44Opera Android ? Safari iOS No support NoSamsung Internet Android Full support 4.0
navigate
Experimental
Chrome Full support 49Edge Full support ≤18Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 49Firefox Android Full support 44Opera Android ? Safari iOS No support NoSamsung Internet Android Full support 4.0
visibilityState
Experimental
Chrome Full support 42Edge Full support ≤18Firefox Full support 44
Notes
Full support 44
Notes
Notes Extended Support Releases (ESR) before Firefox 78 ESR do not support service workers and the Push API.
IE No support NoOpera ? Safari No support NoWebView Android No support NoChrome Android Full support 42Firefox Android Full support 44Opera Android ? Safari iOS No support NoSamsung Internet Android Full support 4.0

Legend

Full support
Full support
No support
No support
Compatibility unknown
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
See implementation notes.
See implementation notes.

See also