options_ui

类型 对象
Mandatory No
范例
"options_ui": {
  "page": "options/options.html"
}
									

使用 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 , or  runtime.connect() . The latter (or  runtime.Port  equivalents) can also be used to share options between your background script(s) and your content script(s).

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) (或 content script(s) ) need to know about the change, your script(s) might choose to add a listener to storage.onChanged .

句法

options_ui key is an object with the following contents:

名称 类型 描述
browser_style
可选
布尔 默认为 true .

Use this to include a stylesheet in your page that will make it look consistent with the browser's UI and with other extensions that use the browser_style property. Although it defaults to true , it's recommended that you include this property.

In Firefox, the stylesheet can be seen at chrome://browser/content/extension.css ,或 chrome://browser/content/extension-mac.css on macOS. When setting dimensions, be aware that this style sheet currently sets box-sizing: border-box (见 box-sizing ).

Firefox Style Guide describes the classes you can apply to elements in the popup in order to get particular styles.

open_in_tab
可选
布尔 默认为 false .

true , the options page will open in a normal browser tab, rather than being integrated into the browser's add-ons manager.

page 字符串

Mandatory.

The path to an HTML file containing the specification of your options 页面。

The path is relative to the location of manifest.json 本身。

范例

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

						

浏览器兼容性

BCD tables only load in the browser

另请参阅

Found a problem with this page?

最后修改: , 由 MDN 贡献者

  1. 浏览器扩展名
  2. 快速入门
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
    6. What next?
  3. 概念
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Working with files
    5. 国际化
    6. Content Security Policy
    7. Native messaging
    8. Differences between API implementations
    9. Chrome incompatibilities
  4. 用户界面
    1. 用户界面
    2. Toolbar button
    3. Address bar button
    4. Sidebars
    5. Context menu items
    6. Options page
    7. Extension pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. 如何
    1. Intercept HTTP requests
    2. Modify a web page
    3. Insert external content
    4. Share objects with page scripts
    5. Add a button to the toolbar
    6. Implement a settings page
    7. Work with the Tabs API
    8. Work with the Bookmarks API
    9. Work with the Cookies API
    10. Work with contextual identities
    11. Interact with the clipboard
    12. Build a cross-browser extension
  6. Firefox differentiators
  7. JavaScript API
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. captivePortal
    8. clipboard
    9. 命令
    10. contentScripts
    11. contextualIdentities
    12. Cookie
    13. devtools
    14. dns
    15. downloads
    16. events
    17. extension
    18. extensionTypes
    19. find
    20. history
    21. i18n
    22. identity
    23. idle
    24. management
    25. menus
    26. notifications
    27. omnibox
    28. pageAction
    29. permissions
    30. pkcs11
    31. privacy
    32. proxy
    33. runtime
    34. search
    35. sessions
    36. sidebarAction
    37. storage
    38. tabs
    39. theme
    40. topSites
    41. 类型
    42. userScripts
    43. webNavigation
    44. webRequest
    45. windows
  8. Manifest keys
    1. 介绍
    1. 作者
    2. background
    3. browser_action
    4. browser_specific_settings
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. 命令
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. dictionaries
    15. externally_connectable
    16. homepage_url
    17. icons
    18. incognito
    19. manifest_version
    20. name
    21. offline_enabled
    22. omnibox
    23. optional_permissions
    24. options_page
    25. options_ui
    26. page_action
    27. permissions
    28. protocol_handlers
    29. short_name
    30. sidebar_action
    31. storage
    32. theme
    33. theme_experiment
    34. user_scripts
    35. version
    36. version_name
    37. web_accessible_resources
  9. Extension Workshop
    1. Develop
    2. Publish
    3. Manage
    4. Enterprise
  10. Contact us
  11. Channels
    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat