W3cubDocs

/Web APIs

ServiceWorkerGlobalScope: backgroundfetchclick event

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

The backgroundfetchclick event of the ServiceWorkerGlobalScope interface is fired when the user clicks on the UI that the browser provides to show the user the progress of the background fetch operation.

This event is not cancelable and does not bubble.

Syntax

Use the event name in methods like addEventListener(), or set an event handler property.

js

addEventListener("backgroundfetchclick", (event) => {});

onbackgroundfetchclick = (event) => {};

Event type

Event properties

Inherits properties from its parent, ExtendableEvent.

BackgroundFetchEvent.registration

Returns the BackgroundFetchRegistration whose progress dialog the user clicked on.

Description

When a background fetch operation starts, the browser shows a UI element to the user to indicate the progress of the operation. If the user clicks this element, the browser starts the service worker, if necessary, and fires the backgroundfetchclick event in the service worker's global scope.

A common task for the handler in this situation is to open a window giving the user more details about the fetch operation.

Examples

Opening a window with more details

This event handler uses the global clients property to open a window giving the user more details about the fetch. It opens a different window depending on whether the fetch has completed or not.

js

addEventListener("backgroundfetchclick", (event) => {
  const registration = event.registration;

  if (registration.result === "success") {
    clients.openWindow("/play-movie");
  } else {
    clients.openWindow("/movie-download-progress");
  }
});

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
backgroundfetchclick_event 74 79 No No 62 No No 74 No 53 No 11.0

See also

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/backgroundfetchclick_event