options_ui

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

Use the options_ui key to define an options page for your extension.

The options page contains settings for the extension. The user can access it from the browser's add-ons manager, and you can open it from within your extension using runtime.openOptionsPage().

You specify options_ui as a path to an HTML file packaged with your extension. The HTML file can include CSS and JavaScript files, just like a normal web page. Unlike a normal page, though, the JavaScript can use all the WebExtension APIs that the extension has permissions for. However, it runs in a different scope than your background scripts.

If you want to share data or functions between the JavaScript on your options page and your background script(s), you can do so directly by obtaining a reference to the Window of your background scripts by using extension.getBackgroundPage(), or a reference to the Window of any of the pages running within your extension with extension.getViews(). Alternately, you can communicate between the JavaScript for your options page and your background script(s) using runtime.sendMessage(), runtime.onMessage, and/or runtime.connect().

In general, you will want to store options changed on option pages using the storage API to either storage.sync (if you want the settings synchronized across all instances of that browser that the user is logged into), or storage.local (if the settings are local to the current machine/profile). If you do so and your background script(s) need to know about the change, your background script might choose to add a listener to storage.onChanged.

Syntax

The options_ui key is an object with the following contents:

Example

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

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.