Object
必須 いいえ
"options_ui": {
  "page": "options/options.html"
}

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

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

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

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

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

構文

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

名前 説明
browser_style Boolean

省略可能。既定では true

これを使ってページにブラウザーの UI と browser_style プロパティを使う他の拡張機能とで一貫した見た目とするようなスタイルシートを入れることができる。既定では true だが、このプロパティを入れるのは推奨される。

Firefox では、chrome://browser/content/extension.css か、OS X では chrome://browser/content/extension-mac.css でスタイルシートを見ることができる。

Firefox Style Guide はポップアップ内の要素が特定のスタイルを取るために適用させるクラスを説明している。

open_in_tab Boolean

省略可能。既定値は false

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

page String

必須。

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

パスは manifest.json 自体への相対パス。

Chrome incompatibilities

None.

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

ブラウザ実装状況

Update compatibility data on GitHub
デスクトップモバイル
ChromeEdgeFirefoxOperaAndroid 版 Firefox
基本対応Chrome 完全対応 40Edge 未対応 なしFirefox 完全対応 48Opera 完全対応 27
補足
完全対応 27
補足
補足 Options pages are always opened in a separate browser tab.
Firefox Android 完全対応 57
browser_styleChrome 完全対応 40
代替名
完全対応 40
代替名
代替名 非標準の名前 chrome_style を使用しています。
Edge 未対応 なしFirefox 完全対応 55Opera 完全対応 27
代替名
完全対応 27
代替名
代替名 非標準の名前 chrome_style を使用しています。
Firefox Android 完全対応 57
open_in_tabChrome 完全対応 40Edge 未対応 なしFirefox 完全対応 48Opera 未対応 なしFirefox Android 完全対応 57

凡例

完全対応  
完全対応
未対応  
未対応
実装ノートを参照してください。
実装ノートを参照してください。
非標準の名前を使用しています。
非標準の名前を使用しています。

 

ドキュメントのタグと貢献者

このページの貢献者: Uemmra3, YuichiNukiyama
最終更新者: Uemmra3,