PWA からインストールプロンプトを起動する
警告:
ここで説明する手法は beforeinstallprompt イベントに依存していますが、これは標準外であり、現在 Chromium ベースのブラウザーでのみ実装されています。
デフォルトでは、ユーザーがウェブサイトにアクセスし、ブラウザーがサイトを PWA としてインストール可能であると判断した場合、ブラウザーは、サイトインストール用の組み込み UI(例えば、URL バーにアイコン)を表示します。ユーザーがアイコンをクリックすると、ブラウザーは、少なくともアプリの名前とアイコンを含むインストールプロンプトを表示します。ユーザーがアプリのインストールに同意すると、アプリがインストールされます。
ただし、アプリ内に独自の UI を実装して、ユーザーにアプリのインストールを確認するメッセージを表示し、インストールプロンプトを開始することができます。これの利点は次のとおりです。
- アプリに関するより詳しい情報を提供し、PWA としてインストールするメリットをユーザーに説明することができます。
- アプリ内インストール UI は、ブラウザーのデフォルト UI よりもユーザーにとって見つけやすく、理解しやすいでしょう。
アプリ内のインストール UI の追加
まず、ユーザーがインストールできることを示す UI をアプリに追加します。例えば、次のようにします。
<button id="install" hidden>インストール</button>
ユーザーがインストールできないブラウザーでアプリにアクセスした場合、インストール UI が表示されないように、ボタンの hidden 属性を設定します。次に、PWA のローカルインストールに対応しているブラウザーでのみボタンを表示する方法を見てみましょう。
beforeinstallprompt の待ち受け
ブラウザーがアプリをインストール可能と判断すると、グローバルの Window スコープで beforeinstallprompt イベントが発生します。
メインアプリのコードでは、このイベントを待ち受けします。
// main.js
let installPrompt = null;
const installButton = document.querySelector("#install");
window.addEventListener("beforeinstallprompt", (event) => {
event.preventDefault();
installPrompt = event;
installButton.removeAttribute("hidden");
});
このイベントハンドラーは 3 つのことを行います。
- このイベントの
preventDefault()を呼び出します。これで、ブラウザーが自身のインストール UI を表示するのを防ぎます。 - ハンドラーに渡されたイベントオブジェクトを参照します。これは
BeforeInstallPromptEventのインスタンスであり、ユーザーにアプリのインストールを促すために使用されます。 - ボタンから
hidden属性を除去することで、アプリ内のインストール UI を表示します。
次の場合、イベントは発生しません。
- PWA がすでにインストールされている場合。
- アプリが PWA のインストール基準を満たしていない場合。
- 現在の端末に PWA をインストールできない場合(必要な権限がない場合など)。
インストールプロンプトの起動
次に、アプリ内のインストールボタンに click ハンドラーを追加する必要があります。
// main.js
installButton.addEventListener("click", async () => {
if (!installPrompt) {
return;
}
const result = await installPrompt.prompt();
console.log(`Install prompt was: ${result.outcome}`);
disableInAppInstallPrompt();
});
function disableInAppInstallPrompt() {
installPrompt = null;
installButton.setAttribute("hidden", "");
}
変数 installPrompt は、 beforeinstallprompt イベントハンドラー内で BeforeInstallPromptEvent オブジェクトに初期化されています。何らかの理由で installPrompt が初期化されていない場合は、何もしません。
それ以外の場合は、その prompt() メソッドを呼び出します。これにより、インストールプロンプトが表示され、アプリがインストールされたかどうかを示すオブジェクトで解決されるプロミス (Promise) が返されます。具体的には、ユーザーがアプリのインストールを選択した場合は outcome プロパティが "accepted"、プロンプトを閉じた場合は "dismissed" になります。
いずれの場合も、 prompt() を呼び出した後は、その状態をリセットする必要があります。これは、 BeforeInstallPromptEvent インスタンスごとに 1 回しか呼び出せないためです。そこで、 installPrompt 変数をリセットし、インストールボタンを再び非表示にします。
アプリのインストールへの応答
ブラウザーやプラットフォームによっては、ブラウザーがアプリをインストールするために自分自身の UI を表示する場合があります。すなわち、アプリがアプリ内のインストール UI を経由せずにインストールされる可能性があります。この場合、アプリ内のインストール UI を無効にするか、すでにインストールされているアプリに UI を表示させる必要があります。
これを行うには、アプリがインストールされたときにグローバル Window スコープで発生する appinstalled イベントを待ち受けします。
// main.js
window.addEventListener("appinstalled", () => {
disableInAppInstallPrompt();
});
function disableInAppInstallPrompt() {
installPrompt = null;
installButton.setAttribute("hidden", "");
}
プラットフォーム固有のアプリがインストールされた場合への応答
プラットフォーム固有のバージョンのアプリとウェブアプリの両方があり、プラットフォーム固有のアプリがすでにインストールされているかどうかに応じて、ウェブアプリの使い勝手を調整したい場合があります。たとえば、そのアプリがすでにインストールされているユーザーには PWA のインストールを勧めないようにしたり、コンテンツを表示するためにプラットフォーム固有のアプリを開くよう促したりできます。
これは、 Navigator.getInstalledRelatedApps() メソッドを使用して処理できます。このメソッドを使用すると、インストールされている関連プラットフォーム専用のアプリ(または PWA)を検出し、適切に対応することができます。
例を示します。
const relatedApps = await navigator.getInstalledRelatedApps();
// 特定のプラットフォーム固有アプリを探す
const psApp = relatedApps.find((app) => app.id === "com.example.myapp");
if (psApp) {
// 適切に UI を更新
}
この方法は、プラットフォーム専用のアプリの可用性に応じてブラウザーのインストール UI を抑制する beforeinstallprompt と組み合わせることもできます。
window.addEventListener("beforeinstallprompt", async (event) => {
const relatedApps = await navigator.getInstalledRelatedApps();
// 特定のプラットフォーム固有アプリを探す
const psApp = relatedApps.find((app) => app.id === "com.example.myapp");
if (psApp) {
event.preventDefault();
// 適切に UI を更新
}
});
関連情報
- PWA をインストール可能にする
beforeinstallpromptイベント- How to provide your own in-app install experience (web.dev, 2021)
- Installation prompt(英語) (web.dev, 2022)