CycleTracker : manifeste et iconographie

Pour identifier notre PWA, le document JSON doit inclure les propriétés name (nom) ou short_name (nom court), ou les deux. On peut également inclure un champ description.

name (en-US)

Le nom de la PWA. Il s'agit du nom utilisé lorsque le système d'exploitation liste les applications, comme le libellé situé à côté de l'icône de l'application, etc.

short_name (en-US)

Le nom de la PWA qui est affiché s'il n'y a pas suffisamment d'espace pour name. Cette valeur est utilisée comme libellé pour les icônes sur les écrans de smartphones, et, par exemple, dans la boîte de dialogue « Ajouter à l'écran d'accueil » sur iOS.

Lorsque name et short_name sont tous les deux renseignés, la valeur de name est utilisée dans la plupart des cas, tandis que short_name est utilisé lorsque l'espace d'affichage est limité.

description (en-US)

Une explication de ce que fait l'application. Elle fournit une description accessible (en-US) de l'objectif et des fonctionnalités de l'application.

Écrivez les premières lignes de votre fichier de manifeste. Vous pouvez utiliser le texte qui suit ou utiliser des valeurs plus descriptives ou discrètes, et une description de votre choix.

L'apparence de la PWA lors de son installation ou de son utilisation hors-ligne est définie dans le manifeste. Les champs du manifeste relatifs à cette apparence incluent notamment start_url et display, ainsi que d'autres champs permettant de personnaliser les couleurs de votre application (en-US), comme theme_color et background_color.

start_url (en-US)

La page de démarrage lorsque la PWA est lancée.

display (en-US)

Contrôle le mode d'affichage de l'application. Ce champ peut valoir fullscreen, standalone (la PWA est alors affichée dans une fenêtre dédiée (en-US)), minimal-ui (semblable à la vue standalone, mais avec certains éléments d'interface pour la navigation), et browser, qui ouvre l'application dans une fenêtre de navigateur classique.

Il existe également un champ orientation (en-US) qui définit l'orientation par défaut de la PWA et qui peut valoir portrait ou landscape (paysage). Comme notre application fonctionne dans les deux orientations, nous n'inclurons pas cette propriété.

theme_color

La couleur par défaut des éléments d'interface du système d'exploitation ou du navigateur (en-US) comme la barre d'état sur certains mobiles et la barre du titre d'application sur les systèmes d'exploitation de bureau.

background_color (en-US)

Une couleur de substitution qui peut être affichée comme arrière-plan de l'application (en-US) jusqu'à ce que le CSS soit chargé. Pour créer une transition fluide entre le lancement de l'application et la fin du chargement, mieux vaudra utiliser la couleur déclarée pour l'arrière-plan (propriété CSS background-color) de l'application.

Ajouter les définitions de présentation au fichier de manifeste que vous avez initié lors de l'exercice précédent.

Comme notre application d'exemple fonctionne sur une seule page, on pourra utiliser "/" comme valeur pour start_url, voire omettre ce champ. De même, nous pouvons afficher l'application sans l'interface utilisateur du navigateur en utilisant standalone comme valeur pour display.

Dans notre fichier CSS, nous appliquons background-color: #efe; sur le sélecteur de l'élément body. Aussi, nous utilisons ici #eeffee pour background_color afin d'obtenir une transition fluide lors du chargement de l'application.

{
  "name": "…",
  "short_name": "…",
  "description": "…",
  "start_url": "/",
  "theme_color": "#eeffee",
  "background_color": "#eeffee",
  "display": "standalone"
}

Les icônes d'une PWA aident à identifier l'application parmi les autres, aident à la rendre visuellement attractive et plus facilement découvrable. L'icône d'une PWA apparaît sur les écrans d'accueil, lanceurs d'application ou dans les résultats des magasins d'application. La taille de l'image affichée et les contraintes sur les fichiers utilisés varient selon le système et le contexte d'affichage. C'est dans le manifeste qu'on définit les images des différentes icônes.

Dans l'objet JSON qui représente le manifeste, le champ icons est un tableau d'un ou plusieurs objets représentant des icônes, chacun avec les propriétés src et sizes, et pouvant également inclure les propriétés optionnelles type et purpose. La propriété src de chaque objet icône indique la source d'un seul fichier image. La propriété sizes fournit une liste de tailles prises en charge pour cette image, séparées par des espaces, ou le mot-clé any (la valeur est analogue à l'attribut sizes de l'élément HTML <link>). La propriété type indique le type MIME de l'image.

{
  "name": "MonAppli",
  "icons": [
    {
      "src": "icones/minuscule.webp",
      "sizes": "48x48"
    },
    {
      "src": "icones/petite.png",
      "sizes": "72x72 96x96 128x128 256x256",
      "purpose": "maskable"
    },
    {
      "src": "icones/grande.png",
      "sizes": "512x512"
    },
    {
      "src": "icones/vectorielle.svg",
      "sizes": "any"
    }
  ]
}

Toutes les icônes devraient avoir le même aspect afin que votre application soit reconnaissable quelle que soit la taille utilisée. Plus l'icône est grande, plus elle pourra contenir de détails. Bien que tous les fichiers d'icônes soient des images carrées, certains systèmes d'exploitation pourront les afficher avec une autre forme, en coupant certaines sections ou en appliquant un masque sur l'icône pour obtenir une homogénéité entre les applications, voire en les réduisant, en les centrant et en ajoutant un arrière-plan si l'icône n'est pas masquable. La zone sûre (en-US), celle qui sera affichée sans perte comme un cercle correspond aux 80% intérieurs de l'image. Les icônes qui peuvent recevoir un masque sans problème peuvent être identifiées avec la propriété purpose dotée de la valeur maskable (voir les icônes adaptatives sur web.dev (en anglais)).

Dans Safari (et donc sur iOS et iPadOS), si vous incluez des éléments <link> pour les ressources non-standards apple-touch-icon dans l'élément <head>, ces icônes remplaceront celles déclarées dans le manifeste.

Ajoutez des icônes au manifeste construit dans les exercices précédents.

En jouant sur le mot « cycle » de CycleTracker et la couleur verte choisie comme thème, nos icônes peuvent être des carrés vert clair avec un cercle vert. Notre icône la plus petite, circle.ico, est un simple cercle représentant un point sur un carré utilisant la couleur du thème. Les images intermédiaires circle.svg, tire.svg, et wheel.svg, ajoutent progressivement plus de détails pour passer d'un cercle simple à une roue de plus en plus complexe, avec des rayons et un moyeu. Ceci étant écrit, la conception d'icônes est un sujet à part entière, que nous ne pouvons détailler pleinement dans ce tutoriel.

<div>
  <img alt="un cercle vert" src="circle.svg" role="img" />
  <img alt="une roue simple" src="tire.svg" role="img" />
  <img alt="une roue plus élaborée" src="wheel.svg" role="img" />
</div>

div {
  display: flex;
  gap: 5px;
}
img {
  width: 33%;
}

Nous avons désormais un fichier de manifeste utilisable. Il est temps de l'enregistrer et d'y faire référence depuis notre fichier HTML.

L'extension utilisée pour le fichier du manifeste peut être .webappmanifest, comme indiqué dans la spécification. Comme il s'agit d'un fichier JSON, on peut également l'enregistrer avec l'extension .json.

Pour une PWA, le manifeste doit être référencé dans le document HTML de l'application. Nous avons une application web fonctionnelle, mais ce n'est pas encore une PWA, car il n'y a pas encore de référence à notre manifeste JSON. Pour inclure la ressource JSON externe, on utilise un élément <link> avec l'attribut rel="manifest", et on renseigne l'attribut href pour qu'il pointe vers le manifeste.

<link rel="manifest" href="cycletracker.json" />

L'élément <link> sert généralement à référencer les feuilles de style, et dans le cas des PWA, le manifeste. On l'utilise aussi, entre autres, pour les icônes d'un site (qu'il s'agisse des « favicons » et des icônes pour les écrans d'accueil sur mobile).

<link rel="icon" href="icons/circle.svg" />

Si vous utilisez l'extension .webmanifest, il faut préciser type="application/manifest+json" si votre serveur ne gère pas automatiquement cette extension et son type MIME.

Tâche

Enregistrez le fichier de manifeste que vous avez créé jusqu'à présent, puis reliez-le depuis le fichier index.html.

Comme exercice facultatif, vous pouvez également ajouter un lien vers une icône depuis le document HTML.

Exemple de solution

L'élément <head> de votre fichier index.html pourra ressembler à :

<head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width" />
  <title>Cycle Tracker</title>
  <link rel="stylesheet" href="style.css" />
  <link rel="manifest" href="cycletracker.json" />
  <link rel="icon" href="icons/circle.svg" />
</head>

Vous pouvez voir le fichier cycletracker.json (en anglais) et le code source du projet à ce stade sur GitHub.

Lorsqu'un fichier manifeste est présent, Safari reconnaîtra votre site comme une application web. Toutefois, pour que l'application soit pleinement une PWA, il faut lui ajouter un service worker.

Certains outils de développement dans les navigateurs permettent d'inspecter les manifestes. Pour Edge, Firefox, et Chrome, les propriétés du manifeste et leur valeur sont visibles dans le panneau « Application ».

Le panneau relatif au manifeste fournit un lien vers le fichier, et des sections sur l'identité, la présentation et les icônes.

Les propriétés du manifeste qui sont prises en charge sont affichées avec leur valeur. Dans cette capture d'écran, on peut voir les propriétés orientation et id apparaître, même si elles ne font pas partie de notre manifeste. Le panneau Applications peut être utilisé pour voir les propriétés et même apprendre certaines informations. Dans cet exemple, on peut voir que pour indiquer un identifiant d'application qui correspond à l'identité actuelle, il faut que la propriété id soit renseignée avec "/".

Chrome et Edge fournissent également des erreurs et des avertissements, les gestionnaires de protocole et des informations pour améliorer le manifeste et les icônes.

Notre application ne dispose pas de gestionnaires de protocole et nous n'aborderons pas ce sujet dans ce tutoriel. S'il y en avait eu d'inclus, ils auraient été listés dans la section correspondante. Cette section étant vide, les outils de développement fournissent des liens pour des informations à ce sujet.

Le panneau relatif au manifeste inclut également des informations sur les zones sûres des icônes masquables et un lien vers un billet de blog (en anglais) sur ce sujet. Pour créer des icônes, vous pouvez utiliser l'outil imageGenerator (en anglais) qui crée plus de 100 images carrées en PNG pour Android, Apple, et Windows, ainsi qu'un fichier JSON contenant l'ensemble des chemins des images avec leur taille. Celles-ci pourront ne pas toutes vous servir, mais cet outil vous permettra de voir la diversité des configurations utilisées pour servir une PWA.

Les outils de développement sont utiles pour identifier les champs de manifeste pris en charge. On notera par exemple que les outils de développement de Firefox affichent dir, lang, orientation, scope, et id, même si notre fichier de manifeste ne contient pas ces champs. Firefox inclut également la valeur de la propriété purpose pour chaque icône, en affichant any par défaut.

Pour que notre application bénéficie des avantages d'une PWA pour l'ensemble des navigateurs et des systèmes d'exploitation, nous devons lui ajouter un service worker. Dans le prochain article, nous verrons comment faire, sans utiliser de framework.

• Précédent
• Aperçu : CycleTracker
• Suivant