https://github.com/mdn/webextensions-examples
Entretenu par l'équipe complémentaire de Mozilla.
WeBextensions est un moyen d'écrire des extensions du navigateur: c'est-à-dire des programmes installés dans un navigateur Web qui modifient le comportement du navigateur ou des pages Web chargées par le navigateur. WeBextensions est construite sur un ensemble d'API cross-furt, de sorte que nous les étexations écrites pour Google Chrome, Opera ou Edge sera également exécutée dans Firefox.
Le référentiel "weBExtensions-Examples" est une collection de weBextensions weBExtensions simples, complètes et installables. Les exemples montrent comment utiliser les API WeBExtensions, et vous pouvez les utiliser comme point de départ pour vos WebExtensions.
Pour un index de tous les exemples, consultez la page "Exemple d'extensions" sur MDN.
Les exemples sont mis à disposition sous la licence publique de Mozilla 2.0.
Pour utiliser le référentiel, le clonez d'abord.
Chaque exemple se trouve dans un dossier de niveau supérieur et comprend un court métat expliquant ce qu'il fait. Pour voir comment un exemple fonctionne, installez-le dans Firefox en suivant les instructions d'installation.
Pour trouver votre chemin autour de la structure interne d'une webextension, jetez un œil à l'anatomie d'une page WeBextension sur MDN.
Pour utiliser ces exemples dans Firefox, utilisez la version la plus récente de Firefox. Cependant, la plupart des exemples fonctionnent avec des versions antérieures.
Quelques exemples reposent sur des API qui ne sont disponibles que dans les versions pré-libérées de Firefox. Lorsque c'est le cas, l'exemple déclare la version minimale dont elle a besoin dans l'attribut strict_min_version
de la browser_specific_settings key
dans le fichier manifeste.json de l'extension.
Certains exemples fonctionnent uniquement sur des domaines ou des pages spécifiques. Les détails de toute restriction sont fournis dans le fichier de réadme de chaque exemple. Aucun des exemples ne fonctionne dans les fenêtres de navigation privée par défaut, voir les extensions de la navigation privée pour plus de détails.
Pour exécuter un exemple d'extension:
about:debugging
. Cliquez sur Chargement du module complémentaire temporaire et sélectionnez le fichier manifest.json
dans le dossier d'une extension d'exemple. Voici une vidéo qui montre comment procéder.web-ext run
. Cela lance Firefox et installe automatiquement l'extension. Cet outil fournit des fonctionnalités de développement supplémentaires, telles que le rechargement automatique. Ces exemples sont testés dans Firefox. Ils peuvent travailler dans d'autres navigateurs, si le navigateur prend en charge les API utilisées. Notez que ces exemples utilisent tous l'espace de noms browser
et promet de travailler avec des fonctions asynchrones. Cela signifie que les exemples ne fonctionneront pas dans Chrome à moins que vous n'utilisiez le polyfill fourni par Mozilla. Voir l'aperçu des API WeBExtension pour plus d'informations.
Pour en savoir plus sur le développement de WeBextensions, consultez la documentation WeBExtensions sur MDN pour obtenir des guides, des tutoriels et des documents de référence API complets.
Si vous rencontrez un problème:
Si vous ne pouvez pas résoudre le problème, déposez un bogue.
Nous saluons les contributions, qu'il s'agisse de nouveaux exemples, de nouvelles fonctionnalités, de corrections de bogues ou de traductions de chaînes localisables. Veuillez consulter le fichier contributing.md pour plus de détails.