options_ui

Object
必須 いいえ
マニフェストバージョン 2 以上
json
"options_ui": {
  "page": "options/options.html"
}

options_ui キーは、拡張機能のオプションページを定義するために使用します。

オプションページは、拡張機能の設定を含みます。オプションページはブラウザーのアドオンマネージャー、または拡張機能内で runtime.openOptionsPage() を使用することでアクセスできます。

options_ui を拡張機能にパッケージされた HTML ファイルへのパスとして指定します。通常のウェブページのように、HTML、CSS、JavaScript ファイルを含めることができます。しかし、通常のページと異なり、拡張機能が権限を持つすべての WebExtension API を使用できます。しかし、バックグラウンドスクリプトとは異なるスコープで実行されます。

オプションページバックグラウンドスクリプトの JavaScript 上で、データや関数を共有したい場合、バックグラウンドスクリプトの Window への参照を extension.getBackgroundPage() (en-US) を使用して直接取得するか、拡張機能内で実行されているいずれかのページの Windowextension.getViews() (en-US) で取得します。あるいは、JavaScript で runtime.sendMessage()runtime.onMessageruntime.connect() (en-US) を使用することで、オプションページとバックグラウンドスクリプト間で相互にコミュニケーションできます。 後者の方法 (や同等の runtime.Port (en-US) ) でも バックグラウンドスクリプトコンテンツスクリプト とでオプションを共有できます。

一般的に、オプションページで変更されたオプションは、ストレージ API を使用して、storage.sync() (ユーザーがログインしているすべてのブラウザーインスタンス間で設定を同期する場合) か storage.local() (現在のマシン / プロファイルのローカル設定にする場合) のいずれかに保存します。バックグラウンドスクリプトに変更を通知する必要がある場合、バックグラウンドスクリプトstorage.onChanged (en-US) にリスナーを追加します。

構文

options_ui キーは次のコンテンツを持つオブジェクトです。

| open_in_tab | Boolean | 省略可能。既定値は falsetrue の場合、オプションページはブラウザーのアドオンマネージャーに統合されたものではなく、通常のブラウザータブで開かれる。 | | page | String | 必須。オプションページの仕様を含む HTML ファイルへのパス。パスは manifest.json 自体への相対パス。 |

名前 説明
browser_style (en-US)
省略可
Boolean

既定値は true です。

ブラウザーの UI と、browser_style プロパティを使用する他の拡張機能とで見た目が一致するようにするスタイルシートを、ページに記載するために使用します。既定値は true ですが、このプロパティを記載することをお勧めします。

Firefox では chrome://browser/content/extension.css、macOS では chrome://browser/content/extension-mac.css で、このスタイルシートは見ることができます。寸法を設定する場合、このスタイルシートが現在 box-sizing: border-box を設定していることに注意してください(box-sizing を参照してください)。

Firefox スタイルガイドでは、特定のスタイルを取得するためにポップアップの要素に適用できるクラスについて記述しています。

open_in_tab
省略可
Boolean

既定値は false です。

true の場合、オプションページはブラウザーのアドオンマネージャーに統合されるのではなく、通常のブラウザータブで開かれます。

page String

必須です。

オプションページの仕様を含む HTML ファイルへのパスです。

パスは manifest.json 自体の位置からの相対パスです。

json
"options_ui": {
  "page": "options/options.html"
}

ブラウザーの互換性

BCD tables only load in the browser

関連情報