W3cubDocs

/Web Extensions

omnibox.setDefaultSuggestion()

Set the default suggestion to appear in the address bar drop-down list when the user starts interacting with your extension.

Once the user has entered your keyword and started interacting with your extension, the default suggestion will always appear first in the drop-down list. Unlike the suggestions you supply in omnibox.onInputChanged, this item can't be selected. Use it to provide the user with some guidance about what to type and what they can expect to see when they do.

Syntax

browser.omnibox.setDefaultSuggestion(
  suggestion            // object
)

Parameters

suggestion
object. An object containing a single string property description, which will be displayed as the first item in the drop-down when the user starts interacting with your extension.

Return value

None.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
setDefaultSuggestion
Yes
79
52
'description' is interpreted as plain text, and XML markup is not recognised.
?
Yes
No
?
?
No
?
?
?

Examples

browser.omnibox.setDefaultSuggestion({
  description: "Type the name of a CSS property"
});

Example extensions

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/setDefaultSuggestion