内容表

• 类型
• 函数
• 事件
• 浏览器兼容性
• Example extensions

omnibox

Enables extensions to implement customized behavior when the user types into the browser's address bar.

When the user focuses the browser's address bar and starts typing, the browser displays a drop-down list containing suggested pages, based on what they typed. This gives the user a quick way to access, for example, pages from their history or bookmarks.

The omnibox API provides the extension a way to customize the suggestions displayed in the drop-down, when the user enters a keyword defined by the extension. It works as follows:

1. First, the extension must include an " omnibox " key in its manifest.json file, which defines a keyword.
2. When the user focuses the address bar and types the keyword, followed by a space, the extension will get an omnibox.onInputStarted 事件。
3. Optionally, the extension can call omnibox.setDefaultSuggestion() to define the first suggestion that will be displayed in the address bar drop-down.
4. As the user continues to type characters after this, the extension will get omnibox.onInputChanged events. The event listener will be passed the current value the user has typed, and will be able to populate the address bar drop-down with suggestions. If the extension set a default suggestion using omnibox.setDefaultSuggestion() , then this will appear first in the drop-down.
5. If the user accepts a suggestion, the extension will get an omnibox.onInputEntered event. The event listener will be passed the accepted suggestion.
6. If the user dismisses the drop-down, the extension will get an omnibox.onInputCancelled 事件。

类型

omnibox.OnInputEnteredDisposition

Describes the recommended method to handle the selected suggestion: open in the current tab, open in a new foreground tab, or open in a new background tab.

omnibox.SuggestResult

Object representing a suggestion to add to the address bar drop-down.

函数

omnibox.setDefaultSuggestion()

Defines the first suggestion that appears in the drop-down when the user enters the keyword for your extension, followed by a space.

事件

omnibox.onInputStarted

Fired when the user focuses the address bar and types your extension's omnibox keyword, followed by a space.

omnibox.onInputChanged

Fired whenever the user's input changes, after they have focused the address bar and typed your extension's omnibox keyword, followed by a space.

omnibox.onInputEntered

Fired when the user accepts one of your extension's suggestions.

omnibox.onInputCancelled

Fired when the user dismisses the address bar drop-down, after they have focused the address bar and typed your extension's omnibox keyword.

浏览器兼容性

BCD tables only load in the browser

Example extensions

• firefox-code-search

注意： This API is based on Chromium's chrome.omnibox API。

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Found a problem with this page?

• Edit on GitHub
• Source on GitHub
• Report a problem with this content on GitHub
• Want to fix the problem yourself? See our Contribution guide .

最后修改： Jan 28, 2022 , 由 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
       1. 方法
          1. setDefaultSuggestion()
       2. 类型
          1. OnInputEnteredDisposition
          2. SuggestResult
       3. 事件
          1. onInputCancelled
          2. onInputChanged
          3. onInputEntered
          4. onInputStarted
   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