Fired when the user has selected one of the suggestions your extension has added to the address bar's drop-down list.
Use this event to handle the user's selection, generally by opening the corresponding page. The event listener is passed:
omnibox.OnInputEnteredDisposition
: use this to determine whether to open the new page in the current tab, in a new foreground tab, or in a new background tab.browser.omnibox.onInputEntered.addListener(listener) browser.omnibox.onInputEntered.removeListener(listener) browser.omnibox.onInputEntered.hasListener(listener)
Events have three functions:
addListener(listener)
removeListener(listener)
listener
argument is the listener to remove.hasListener(listener)
listener
is registered for this event. Returns true
if it is listening, false
otherwise.The listener function will be passed two parameters: a string text
, and an omnibox.OnInputEnteredDisposition
.
text
String
. This is the value of the content
property of the omnibox.SuggestResult
object that the user selected.
disposition
OnInputEnteredDisposition
. A omnibox.OnInputEnteredDisposition
enumeration, indicating whether the extension should open the page in the current tab, in a new foreground tab, or in a new background tab.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
onInputEntered |
Yes |
79 |
52 |
? |
Yes |
No |
? |
? |
No |
? |
? |
? |
This example interprets the user's input as a CSS property name and populates the drop-down list with one omnibox.SuggestResult
object for each CSS property matching the input. The SuggestResult
description
is the full name of the property, and the content
is the MDN page for that property.
The example also listens to omnibox.onInputEntered
, and opens the MDN page corresponding to the selection, according to the omnibox.OnInputEnteredDisposition
argument.
browser.omnibox.setDefaultSuggestion({ description: "Type the name of a CSS property" }); /* Very short list of a few CSS properties. */ const props = [ "animation", "background", "border", "box-shadow", "color", "display", "flex", "flex", "float", "font", "grid", "margin", "opacity", "overflow", "padding", "position", "transform", "transition" ]; const baseURL = "https://developer.mozilla.org/en-US/docs/Web/CSS/"; /* Return an array of SuggestResult objects, one for each CSS property that matches the user's input. */ function getMatchingProperties(input) { var result = []; for (prop of props) { if (prop.indexOf(input) === 0) { console.log(prop); let suggestion = { content: baseURL + prop, description: prop } result.push(suggestion); } else { if (result.length != 0) { return result; } } } return result; } browser.omnibox.onInputChanged.addListener((input, suggest) => { suggest(getMatchingProperties(input)); }); browser.omnibox.onInputEntered.addListener((url, disposition) => { switch (disposition) { case "currentTab": browser.tabs.update({url}); break; case "newForegroundTab": browser.tabs.create({url}); break; case "newBackgroundTab": browser.tabs.create({url, active: false}); break; } });
Note: 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.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/omnibox/onInputEntered