omnibox

Type Object
Mandatory No
Example
"omnibox": {
  "keyword": "mdn"
}

Use the omnibox key to define an omnibox keyword for your WebExtension.

When the user types this keyword into the browser's address bar, followed by a space, then any subsequent characters will be sent to the WebExtension using the omnibox API. The WebExtension will then be able to populate the address bar's drop-down suggestions list with its own suggestions.

If two or more WebExtensions define the same keyword, then the WebExtension that was installed last gets to control the keyword. Any previously installed WebExtensions that defined the same keyword will no longer be able to use the omnibox API.

Example

"omnibox": {
  "keyword": "mdn"
}

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,