Exemple : page web contextuelle de la visionneuse d’images

Cet exemple est une extension de navigateur, sans JavaScript, qui affiche l’image stars.jpeg sur une petite page web dans une fenêtre contextuelle de n’importe quel onglet Microsoft Edge :

Extension « Page web contextuelle de visualisation d’images » en cours d’exécution

Cloner le dépôt MicrosoftEdge-Extensions

Vous pouvez utiliser différents outils pour cloner un référentiel GitHub. Vous pouvez télécharger un répertoire sélectionné ou cloner l’intégralité du dépôt.

Clonez le référentiel MicrosoftEdge-Extensions sur votre lecteur local, puis basculez vers une branche opérationnelle, comme suit.

  1. Dans une invite de commandes, entrez git pour vérifier si git est installé en case activée.

  2. Si ce n’est pas déjà fait, téléchargez Git et installez-le.

  3. Si ce n’est pas déjà fait, lancez une invite de commande où git est installé.

  4. Accédez au répertoire dans lequel vous souhaitez cloner le dépôt MicrosoftEdge-Extensions . Par exemple :

    cd C:/Users/localAccount/GitHub/
    
  5. Dans Microsoft Edge, accédez au référentiel MicrosoftEdge-Extensions .

  6. Cliquez sur la flèche vers le bas à droite du bouton vert Code , puis dans la section Cloner à l’aide de l’URL Web , cliquez sur le bouton Copier l’URL dans le presse-papiers en regard de https://github.com/microsoft/MicrosoftEdge-Extensions.git.

  7. Dans la fenêtre d’invite de commandes, entrez la commande suivante :

    git clone https://github.com/microsoft/MicrosoftEdge-Extensions.git
    

    Le /MicrosoftEdge-Extensions/ répertoire est ajouté dans le répertoire que vous avez spécifié.

Créer une branche active et basculer vers celle-ci

  1. Consultez la liste des répertoires :

    ls
    

    Le /MicrosoftEdge-Extensions/ répertoire est répertorié.

  2. Basculez vers le nouveau répertoire :

    cd MicrosoftEdge-Extensions
    
  3. Créer une branche qui fonctionne :

    git branch test
    
  4. Basculez vers la branche de travail :

    git switch test
    

    Renvoie : Switched to branch 'test'

Vous êtes maintenant libre de modifier le code dans votre branche de travail, sans altérer le code qui se trouve dans la branche « principale » du dépôt. Plus tard, vous souhaiterez peut-être revenir à la branche « principale » ou créer une autre branche basée sur la branche « principale ».

Installer l’exemple en local (chargement indépendant)

Au lieu d’installer l’exemple à partir du site web des modules complémentaires Microsoft Edge , vous allez l’installer localement, de sorte que vous pouvez éventuellement le modifier et tester rapidement les modifications. L’installation locale est parfois appelée chargement indépendant d’une extension.

  1. Dans Microsoft Edge, cliquez sur le bouton Extensions (icône Extensions), en regard de la barre d’adresses, si cette icône est affichée. Vous pouvez également sélectionner Paramètres et autres (icône> « Paramètres et plus »). La fenêtre contextuelle Extensions s’ouvre :

    La fenêtre contextuelle Extensions si aucune extension n’est installée

  2. Cliquez sur Gérer les extensions. La page Gestion des extensions s’ouvre dans un nouvel onglet :

    Activation du mode Développeur

  3. Activez le bouton bascule du mode développeur.

  4. Lors de la première installation de votre extension, cliquez sur le bouton Charger décompressé (icône « Charger décompressé »). La boîte de dialogue Sélectionner le répertoire d’extensions s’ouvre.

  5. Sélectionnez le répertoire qui contient les fichiers sources de l’extension, par manifest.jsonexemple .

    Exemple de chemin d’accès :

    C:\Users\localAccount\GitHub\MicrosoftEdge-Extensions\Extension-samples\picture-viewer-popup-webpage

  6. Cliquez sur le bouton Sélectionner un dossier .

    La boîte de dialogue Sélectionner le répertoire d’extensions se ferme.

    L’extension est installée dans le navigateur, comme une extension installée à partir du site web des modules complémentaires Microsoft Edge :

    Page des extensions installées, montrant une extension chargée d’un test

Exécution de l’exemple

  1. Accédez à une page web, telle que l’application TODO, dans une nouvelle fenêtre ou un nouvel onglet. Pour cet exemple, cette étape est facultative et sert uniquement à correspondre aux captures d’écran ; Cet exemple ne nécessite pas l’ouverture d’une page web.

  2. Actualisez la page web. Cela est parfois nécessaire après le rechargement d’une extension.

  3. Dans Microsoft Edge, à droite de la barre d’adresse, si cette icône est affichée, cliquez sur le bouton Extensions (icône Extensions). Vous pouvez également sélectionner Paramètres et autres (icône> « Paramètres et plus »).

    La fenêtre contextuelle Extensions s’ouvre :

    La fenêtre contextuelle Extensions

  4. Cliquez sur l’icône ou le nom de l’extension (page web contextuelle de la visionneuse d’images).

    L’extension s’ouvre et l’icône de l’extension est ajoutée en regard de la barre d’adresse et de l’icône des extensions (icône des extensions). L’extension affiche popup.html, contenant stars.jpeg, dans une fenêtre contextuelle :

    Extension simple en cours d’exécution

  5. Cliquez sur le bouton de l’extension en regard de la barre d’adresse. La fenêtre contextuelle se ferme.

Voir aussi :

Étudier l’échantillon

Dans les sections suivantes, vous étudiez l’échantillon. Ensuite, pour développer votre propre extension Microsoft Edge, vous pouvez copier et modifier le répertoire de l’exemple, puis installer et tester l’extension résultante.

Files et répertoires

L’exemple a la structure de répertoire suivante :

Exemple de chemin d’accès pour l’exemple :

C:\Users\localAccount\GitHub\MicrosoftEdge-Extensions\Extension-samples\picture-viewer-popup-webpage

Répertoires et fichiers dans le /picture-viewer-popup-webpage/ répertoire :

/icons/
   extension-icon16x16.png
   extension-icon32x32.png
   extension-icon48x48.png
   extension-icon128x128.png
/images/
   stars.jpeg
/popup/
   popup.html
manifest.json
  • Le /icons/ répertoire contient les versions d’un .png fichier utilisé pour représenter l’extension près de la barre d’adresse du navigateur.
  • Le /images/ répertoire contient stars.jpeg, qui est affiché dans la fenêtre contextuelle de l’extension.
  • Le /popup/ répertoire contient popup.html, qui définit le contenu de la page web affichée dans la fenêtre contextuelle de l’extension.
  • manifest.json Contient des informations de base sur l’extension.

Le fichier manifeste (manifest.json)

Chaque package d’extension doit avoir un manifest.json fichier à la racine. Le manifeste fournit des détails sur votre extension, la version du package d’extension, ainsi que le nom et la description de l’extension.

manifest.json Contient les lignes suivantes :

{
  "name": "Picture viewer pop-up webpage",
  "version": "0.0.0.1",
  "manifest_version": 3,
  "description": "A browser extension that displays an image in a pop-up webpage.",
  "icons": {
      "16": "icons/extension-icon16x16.png",
      "32": "icons/extension-icon32x32.png",
      "48": "icons/extension-icon48x48.png",
      "128": "icons/extension-icon128x128.png"
  },
  "action": {
      "default_popup": "popup/popup.html"
  }
}

Icônes de lancement de l’extension

Le /icons/ répertoire contient les fichiers image de l’icône. Les icônes servent d’image d’arrière-plan au bouton sur lequel vous cliquez pour lancer l’extension :

Icône de l’extension dans la liste contextuelle Extensions

Lorsque l’extension est en cours d’exécution, l’une des icônes s’affiche dans la barre d’outils, à côté de la barre d’adresse :

Icône sur la barre d’outils

Pour fermer l’extension, cliquez sur l’icône de l’extension dans la barre d’outils ou cliquez sur le bouton Extensions (icône Extensions).

Recommandations pour les icônes :

  • Utilisez PNG format, mais vous pouvez également utiliser BMP, GIFICO ou JPEG formats.
  • Si vous fournissez un fichier d’icône unique, utilisez 128 x 128 px, qui peuvent être redimensionnés par le navigateur si nécessaire.

La boîte de dialogue contextuelle (popup.html)

popup.html dans le répertoire s’exécute /popup/ lorsque vous lancez l’extension. Lorsque vous cliquez sur l’icône pour lancer l’extension, ce fichier s’affiche sous forme de boîte de dialogue modale.

popup.html Contient le code suivant, pour afficher un titre et l’image des étoiles :

<html lang="en">
    <head>
        <meta charset="UTF-8" />
        <title>Picture viewer pop-up webpage</title>
    </head>
    <body>
        <div>
            <img src="/images/stars.jpeg" alt="Stars" />
        </div>
    </body>
</html>

La page web contextuelle (popup.html) est enregistrée en tant que "default_popup" dans manifest.jsonla action section clé :

manifest.json (partie)

{
    "action": {
        "default_popup": "popup/popup.html"
    }
}

Étapes suivantes

Pour développer votre propre extension Microsoft Edge, vous pouvez copier et modifier le répertoire de l’exemple, puis installer et tester l’extension résultante.

Après avoir exécuté et testé cet exemple d’extension, vous pouvez passer à Exemple : Insertion d’images à l’aide d’un script de contenu, qui insère dynamiquement un code JavaScript s’exécutant en tant que contenu dans l’onglet du navigateur.

Voir aussi

GitHub :