LaunchParams
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
TheLaunchParams interface of theLaunch Handler API is used when implementing custom launch navigation handling in a PWA. Whenwindow.launchQueue.setConsumer() is invoked to set up the launch navigation handling functionality, the callback function insidesetConsumer() is passed aLaunchParams object instance.
Such custom navigation handling is initiated viaWindow.launchQueue when a PWA has been launched with alaunch_handlerclient_mode value offocus-existing,navigate-new, ornavigate-existing.
In this article
Instance properties
LaunchParams.filesRead onlyExperimentalReturns a read-only array of
FileSystemHandleobjects representing any files passed along with the launch navigation via thePOSTmethod.LaunchParams.targetURLRead onlyExperimentalReturns the target URL of the launch.
Examples
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.slice(1); audio.play(); } } });}Specifications
| Specification |
|---|
| Web App Launch Handler API> # launchparams-interface> |