Ajouter une interface utilisateur d'installation enrichie

Les plates-formes de téléchargement d'applications offrent aux développeurs un espace permettant aux développeurs de présenter leurs applications avant de les installer, avec des captures d'écran et des informations textuelles qui les aident à faire leur choix. L'interface d'installation enrichie fournit un espace similaire permettant aux développeurs d'applications Web d'inviter leurs utilisateurs à installer leur application, directement depuis le navigateur. Cette interface utilisateur améliorée est disponible dans Chrome pour Android et dans les environnements pour ordinateur.

Invite par défaut

Consultez l'exemple ci-dessous pour voir l'expérience par défaut, qui ne fournit pas assez de contexte.

Boîte de dialogue d'installation par défaut du navigateur pour le bureau.
Boîte de dialogue d'installation par défaut sur le bureau


Boîte de dialogue d'installation par défaut du navigateur pour mobile.
Boîte de dialogue d'installation par défaut sur mobile

Interface utilisateur plus riche

Pour que la boîte de dialogue d'installation enrichie s'affiche au lieu de l'invite par défaut standard, ajoutez les champs screenshots et description à votre fichier manifeste Web. Consultez l'exemple Squoosh.app ci-dessous:

Interface utilisateur plus riche sur les ordinateurs et les mobiles
Interface d'installation enrichie sur les ordinateurs et les mobiles.

La boîte de dialogue d'installation enrichie comprend le contenu des champs description et screenshots du fichier manifeste Web.

Pour afficher la boîte de dialogue, il vous suffit d'ajouter au moins une capture d'écran pour le facteur de forme correspondant, mais nous vous recommandons d'ajouter également la description. Vous trouverez ci-dessous les détails concernant ces champs.

Captures d'écran

Les captures d'écran apportent vraiment un complément d'information à la nouvelle interface d'installation, et nous vous recommandons vivement de les utiliser. Dans le fichier manifeste, vous ajoutez le membre screenshots, qui accepte un tableau nécessitant au moins une image et Chrome en affiche jusqu'à huit. Un exemple est présenté ci-dessous.

 "screenshots": [
    {
     "src": "source/image1.gif",
      "sizes": "640x320",
      "type": "image/gif",
      "form_factor": "wide",
      "label": "Wonder Widgets"
    }
]

Les captures d'écran doivent respecter les critères suivants:

  • La largeur et la hauteur doivent être comprises entre 320 et 3 840 pixels.
  • La dimension maximale ne peut pas être plus de 2,3 fois plus longue que la dimension minimale.
  • Toutes les captures d'écran ayant le même facteur de forme doivent avoir des formats identiques.
  • Seuls les formats d'image JPEG et PNG sont acceptés.
  • Seules huit captures d'écran seront affichées. Si d'autres éléments sont ajoutés, le user-agent les ignore simplement.

Vous devez également inclure la taille et le type de l'image pour qu'elle s'affiche correctement. Regardez cette démonstration.

Le form_factor indique au navigateur si la capture d'écran doit apparaître sur les environnements pour ordinateur (wide) ou mobile (narrow).

Description

Le membre description décrit l'application dans l'invite d'installation pour inviter l'utilisateur à la conserver.

La boîte de dialogue s'affiche même sans description, mais nous vous recommandons de l'utiliser. Une limite est appliquée après sept lignes de texte (environ 324 caractères). Les descriptions plus longues sont tronquées et des points de suspension sont ajoutés (comme vous pouvez le voir dans cet exemple).

{
…
"description": "Compress and compare images with different codecs
right in your browser."
}
Description ajoutée
Description ajoutée.
Description plus longue qui a été tronquée.
Les descriptions plus longues sont tronquées.

La description s'affiche en haut de l'invite d'installation.

Vous avez peut-être remarqué, d'après les captures d'écran, que les boîtes de dialogue d'installation indiquent également l'origine de l'application. Les origines trop longues pour s'adapter à l'UI sont tronquées. C'est ce qu'on appelle également "eliding", c'est-à-dire une mesure de sécurité pour protéger les utilisateurs.

Complément d'informations

Démonstration

HTML

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta name="color-scheme" content="dark light" />
    <link rel="manifest" href="manifest.json" />
    <title>How to add Richer Install UI to your web app</title>
    <!-- TODO: Devsite - Removed inline handlers -->
    <!-- <script>
      if ('serviceWorker' in navigator) {
        window.addEventListener('load', () => {
          navigator.serviceWorker.register('sw.js');
        });
      }
    </script>
    <script type="module" src="script.js"></script> -->
  </head>
  <body>
    <h1>How to add Richer Install UI to your web app</h1>
    <ol>
      <li>
        Install the app by clicking the button below. After the installation,
        the button is disabled.
        <p>
          <button disabled type="button">Install</button>
        </p>
      </li>
      <li>
        When you click on install a dialog similar to the ones from app stores
        will be displayed.
      </li>
      <li>
        The dialog includes the `description` and `screenshots` set in the app
        manifest.
      </li>
      <li>
        Screenshots should be different depending if the app is being installed
        on a mobile or desktop device, according to the `form_factor` value set
        for the screenshots on the manifest
      </li>
    </ol>
  </body>
</html>

JS


        // The install button.
const installButton = document.querySelector('button');

// Only relevant for browsers that support installation.
if ('BeforeInstallPromptEvent' in window) {
  // Variable to stash the `BeforeInstallPromptEvent`.
  let installEvent = null;

  // Function that will be run when the app is installed.
  const onInstall = () => {
    // Disable the install button.
    installButton.disabled = true;
    // No longer needed.
    installEvent = null;
  };

  window.addEventListener('beforeinstallprompt', (event) => {
    // Do not show the install prompt quite yet.
    event.preventDefault();
    // Stash the `BeforeInstallPromptEvent` for later.
    installEvent = event;
    // Enable the install button.
    installButton.disabled = false;
  });

  installButton.addEventListener('click', async () => {
    // If there is no stashed `BeforeInstallPromptEvent`, return.
    if (!installEvent) {
      return;
    }
    // Use the stashed `BeforeInstallPromptEvent` to prompt the user.
    installEvent.prompt();
    const result = await installEvent.userChoice;
    // If the user installs the app, run `onInstall()`.
    if (result.outcome === 'accepted') {
      onInstall();
    }
  });

  // The user can decide to ignore the install button
  // and just use the browser prompt directly. In this case
  // likewise run `onInstall()`.
  window.addEventListener('appinstalled', () => {
    onInstall();
  });
}