options_ui
| 型 | Object |
|---|---|
| 必須 | いいえ |
| マニフェストバージョン | 2 以上 |
| 例 |
json |
options_ui キーは、拡張機能のオプションページを定義するために使用します。このページを使用すると、ユーザーが拡張機能の設定を変更できるようになります。
ユーザーがオプションページを開く方法はブラウザーによって異なり、open_in_tab 設定にも依存します。拡張機能から runtime.openOptionsPage() を使用してページを開くこともできます。
options_ui を拡張機能にパッケージされた HTML ファイルへのパスとして指定します。通常のウェブページのように、HTML、CSS、JavaScript ファイルを含めることができます。しかし、通常のページと異なり、拡張機能が権限を持つすべての WebExtension API を使用できます。しかし、バックグラウンドスクリプトとは異なるスコープで実行されます。
オプションページとバックグラウンドスクリプトの JavaScript 上で、データや関数を共有したい場合、バックグラウンドスクリプトの Window への参照を runtime.getBackgroundPage() を使用して直接取得するか、拡張機能内で実行されているいずれかのページの Window を extension.getViews() で取得します。あるいは、JavaScript で runtime.sendMessage()、runtime.onMessage、runtime.connect() を使用することで、オプションページとバックグラウンドスクリプト間で相互にコミュニケーションできます。
後者の方法 (や同等の runtime.Port ) でも バックグラウンドスクリプトと コンテンツスクリプト とでオプションを共有できます。
一般的に、オプションページで変更された設定は、ストレージ API を使用して、storage.sync (ユーザーがログインしているすべてのブラウザーインスタンス間で設定を同期する場合) または storage.local (現在のマシン / プロファイルのローカル設定にする場合) に保存します。バックグラウンドスクリプトまたはコンテンツスクリプトが変更を知る必要がある場合、これらのスクリプトで storage.onChanged にリスナーを追加できます。
構文
options_ui キーは次のコンテンツを持つオブジェクトです。
| 名前 | 型 | 説明 |
|---|---|---|
browser_style省略可 Manifest V3 では |
Boolean |
省略可能です。デフォルト値は次のとおりです。
Firefox では |
open_in_tab省略可 |
Boolean |
デフォルト値は |
page |
String |
必須です。 オプションページの仕様を含む HTML ファイルへのパスです。
パスは |
例
"options_ui": {
"page": "options/options.html"
}