webextensions examples

webextensions-examples

https://github.com/mdn/webextensions-examples

Mozillaのアドオンチームによって維持されています。

WebExtensionsは、ブラウザ拡張機能を記述する方法です。つまり、ブラウザによってロードされたブラウザまたはWebページの動作を変更するWebブラウザ内にインストールされたプログラムです。 WebExtensionsは一連のクロスブラウザーAPIに基づいて構築されるため、Google Chrome、Opera、またはEdge向けに書かれたWebExtensionsは、ほとんどの場合、Firefoxでも実行されます。

「WebExtensions-Examples」リポジトリは、シンプルで完全な、インストール可能なWebExtensionsのコレクションです。例は、WebExtensions APIを使用する方法を示しており、WebExtensionsの出発点としてそれらを使用できます。

すべての例のインデックスについては、MDNの「拡張機能の例」ページを参照してください。

例は、Mozilla Public License 2.0で利用可能になります。

「webextensions-examples」の使用方法

リポジトリを使用するには、最初にクローンを作成します。

各例はトップレベルのフォルダーにあり、それが何をするかを説明する短いREADMEが含まれています。例を確認するには、インストールの指示に従ってFirefoxにインストールします。

WebExtensionの内部構造の周りを見つけるには、MDNのWebExtensionページの解剖学をご覧ください。

これらの例をFirefoxで使用するには、Firefoxの最新のリリースを使用してください。ただし、ほとんどの例は以前のリリースで動作します。

いくつかの例は、Firefoxのプレリリースバージョンでのみ利用可能なAPIに依存しています。この場合、この例では、拡張機能のmanifest.jsonファイルのbrowser_specific_settings keyのstrict_min_version属性で必要な最小バージョンを宣言します。

例のインストール

いくつかの例は、特定のドメインまたはページでのみ動作します。制限の詳細は、各例のREADMEファイルに記載されています。プライベートブラウジングウィンドウでは、デフォルトではプライベートブラウジングウィンドウで動作する例はありません。詳細については、プライベートブラウジングの拡張機能を参照してください。

拡張機能を実行するには：

1. Firefoxを開き、 about:debuggingページをロードします。 [一時的なアドオンの読み込み]をクリックし、[拡張子]のフォルダー内のmanifest.jsonファイルを選択します。これがこれを行う方法を示すビデオです。
2. Web-Extツールをインストールします。コマンドラインで、拡張機能のフォルダーのサンプルを開き、 web-ext run型で操作します。これにより、Firefoxが起動し、拡張機能が自動的にインストールされます。このツールは、自動リロードなどの追加の開発機能を提供します。

他のブラウザのサポート

これらの例はFirefoxでテストされています。ブラウザが使用されているAPIをサポートしている場合、他のブラウザで動作する場合があります。これらの例はすべてbrowser名前空間を使用し、非同期関数を扱うことを約束することに注意してください。これは、Mozillaが提供するポリフィルを使用しない限り、例がChromeで機能しないことを意味します。詳細については、WebExtension APIの概要を参照してください。

もっと詳しく知る

WebExtensionsの開発の詳細については、開始ガイド、チュートリアル、および完全なAPIリファレンスドキュメントについては、MDNのWebExtensionsドキュメントを参照してください。

問題？

問題が発生した場合：

• アドオン談話フォーラムに質問を投稿します
• Dev-Addonsメーリングリストにメールしてください
• マトリックスのアドオンルームのアドオンチームに連絡してください

問題を解決できない場合は、バグを提出してください。

貢献

新しい例、新機能、バグ修正、ローカライズ可能な文字列の翻訳であろうと、貢献を歓迎します。詳細については、Convinting.mdファイルを参照してください。