omnibox.setDefaultSuggestion()

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

Once the user has entered your keyword and started interacting with your add-on, 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 add-on.

Return value

None.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 52.0 No Yes

Compatibility notes

Firefox

  • 'description' is interpreted as plain text, and XML markup is not recognised.

Examples

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

Acknowledgements

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.

Document Tags and Contributors

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