Intégrer l'UI de partage du système d'exploitation avec l'API Web Share

Les applications Web peuvent utiliser les mêmes fonctionnalités de partage fournies par le système que les applications spécifiques à une plate-forme.

Joe Medley

Grâce à l'API Web Share, les applications Web peuvent utiliser les mêmes fonctionnalités de partage fournies par le système que les applications spécifiques à une plate-forme. L'API Web Share permet aux applications Web de partager des liens, du texte et des fichiers avec d'autres applications installées sur l'appareil, de la même manière que les applications spécifiques à une plate-forme.

Remarque  : Le partage n'est qu'une partie de la magie. Les applications Web peuvent également être des cibles de partage, ce qui signifie qu'elles peuvent recevoir des données, des liens, du texte et des fichiers d'applications Web ou spécifiques à une plate-forme. Consultez Recevoir des données partagées pour savoir comment enregistrer votre application en tant que cible de partage.

Sélecteur de cible de partage au niveau du système avec une PWA installée comme option.

Fonctionnalités et limites

Le partage Web présente les fonctionnalités et limites suivantes :

• Il ne peut être utilisé que sur un site accessible via HTTPS.
• Si le partage s'effectue dans un iFrame tiers, l'attribut allow doit être utilisé.
• Elle doit être appelée en réponse à une action de l'utilisateur, comme un clic. Il est impossible de l'appeler via le gestionnaire onload.
• Il peut partager des URL, du texte ou des fichiers.

Browser Support

• 128
• 93
• 
• 12.1

Source

Partager des liens et du texte

Pour partager des liens et du texte, utilisez la méthode share(), qui est une méthode basée sur les promesses avec un objet de propriétés obligatoire. Pour éviter que le navigateur ne génère une erreur TypeError, l'objet doit contenir au moins l'une des propriétés suivantes : title, text, url ou files. Vous pouvez, par exemple, partager du texte sans URL ou inversement. Autoriser les trois membres élargit la flexibilité des cas d'utilisation. Imaginez qu'après avoir exécuté le code ci-dessous, l'utilisateur choisisse une application de messagerie comme cible. Le paramètre title peut devenir l'objet de l'e-mail, text le corps du message et les fichiers les pièces jointes.

if (navigator.share) {
  navigator.share({
    title: 'web.dev',
    text: 'Check out web.dev.',
    url: 'https://web.dev/',
  })
    .then(() => console.log('Successful share'))
    .catch((error) => console.log('Error sharing', error));
}

Si votre site comporte plusieurs URL pour le même contenu, partagez l'URL canonique de la page au lieu de l'URL actuelle. Au lieu de partager document.location.href, vous devez rechercher une balise d'URL canonique <meta> dans l'élément <head> de la page et la partager. Cela améliorera l'expérience de l'utilisateur. Non seulement cela évite les redirections, mais cela garantit également qu'une URL partagée offre l'expérience utilisateur appropriée pour un client particulier. Par exemple, si un ami partage une URL mobile et que vous la consultez sur un ordinateur, vous devriez voir une version classique :

let url = document.location.href;
const canonicalElement = document.querySelector('link[rel=canonical]');
if (canonicalElement !== null) {
    url = canonicalElement.href;
}
navigator.share({url});

Partager des fichiers

Pour partager des fichiers, commencez par tester et appeler navigator.canShare(). Incluez ensuite un tableau de fichiers dans l'appel à navigator.share() :

if (navigator.canShare && navigator.canShare({ files: filesArray })) {
  navigator.share({
    files: filesArray,
    title: 'Vacation Pictures',
    text: 'Photos from September 27 to October 14.',
  })
  .then(() => console.log('Share was successful.'))
  .catch((error) => console.log('Sharing failed', error));
} else {
  console.log(`Your system doesn't support sharing files.`);
}

Notez que l'exemple gère la détection des fonctionnalités en testant navigator.canShare() plutôt que navigator.share(). L'objet de données transmis à canShare() n'accepte que la propriété files. Certains types de fichiers audio, image, PDF, vidéo et texte peuvent être partagés. Pour obtenir la liste complète, consultez Extensions de fichiers autorisées dans Chromium. D'autres types de fichiers pourront être ajoutés à l'avenir.

Partage dans des iFrames tiers

Pour déclencher l'action de partage à partir d'un iFrame tiers, intégrez l'iFrame avec l'attribut allow et la valeur web-share :

<!-- On https://example.com/index.html -->
<iframe allow="web-share" src="https://third-party.example.com/iframe.html"></iframe>

Étude de cas Sur la piste du père Noël

Bouton de partage de Sur la piste du père Noël.

Sur la piste du père Noël, un projet Open Source, est une tradition de fin d'année chez Google. Chaque année en décembre, vous pouvez célébrer les fêtes de fin d'année avec des jeux et des expériences éducatives.

En 2016, l'équipe Sur la piste du père Noël a utilisé l'API Web Share sur Android. Cette API était parfaitement adaptée aux mobiles. Les années précédentes, l'équipe a supprimé les boutons de partage sur mobile, car l'espace est limité et qu'elle ne pouvait pas justifier la présence de plusieurs cibles de partage.

Mais avec l'API Web Share, ils ont pu présenter un seul bouton, ce qui leur a permis d'économiser de précieux pixels. Ils ont également constaté que les utilisateurs partageaient environ 20 % de plus avec Web Share que les utilisateurs pour lesquels l'API n'était pas activée. Accédez à Sur la piste du père Noël pour voir Web Share en action.

Prise en charge des navigateurs

La compatibilité des navigateurs avec l'API Web Share est nuancée. Nous vous recommandons d'utiliser la détection de fonctionnalités (comme décrit dans les exemples de code précédents) au lieu de supposer qu'une méthode particulière est compatible.

Voici un aperçu de la compatibilité de cette fonctionnalité. Pour en savoir plus, suivez l'un des liens d'assistance.

navigator.canShare()

Browser Support

• 128
• 93
• 
• 14

Source

navigator.share()

Browser Support

• 128
• 93
• 
• 12.1

Source

Afficher la compatibilité avec l'API

Prévoyez-vous d'utiliser l'API Web Share ? Votre soutien public aide l'équipe Chromium à prioriser les fonctionnalités et montre aux autres fournisseurs de navigateurs l'importance de les prendre en charge.

Envoyez un tweet à @ChromiumDev en utilisant le hashtag #WebShare et indiquez-nous où et comment vous l'utilisez.

Liens utiles

• Démonstrations de Web Share
• PWA Scrapbook