LaunchQueue

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

The LaunchQueue interface of the Launch Handler API is available via the Window.launchQueue property. When a progressive web app (PWA) is launched with a launch_handler client_mode value of focus-existing, navigate-new, or navigate-existing, LaunchQueue provides access to functionality that allows custom launch navigation handling to be implemented in the PWA. This functionality is controlled by the properties of the LaunchParams object passed into the setConsumer() callback function.

Instance Methods

setConsumer()

Contains a callback function that handles custom launch navigation for a PWA.

Examples

js

if ("launchQueue" in window) {
  window.launchQueue.setConsumer((launchParams) => {
    if (launchParams.targetURL) {
      const params = new URL(launchParams.targetURL).searchParams;

      // Assuming a music player app that gets a track passed to it to be played
      const track = params.get("track");
      if (track) {
        audio.src = track;
        title.textContent = new URL(track).pathname.substr(1);
        audio.play();
      }
    }
  });
}

Specifications

Specification
Web App Launch Handler API
# launchqueue-interface

Browser compatibility

BCD tables only load in the browser

See also