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

js
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.

Examples

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

Example extensions

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
setDefaultSuggestion
Chrome – Full support
Chrome 9 (Release date: 2011-02-03)
footnote Full support
Edge – Full support
Edge 79 (Release date: 2020-01-15)
footnote Full support
Firefox – Full support
Firefox 52 (Release date: 2017-03-07)
footnote
footnote 'description' is interpreted as plain text, and XML markup is not recognized.
Opera – Full support
Opera 15 (Release date: 2013-07-02)
footnote Full support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
See implementation notes.

Note: This API is based on Chromium's chrome.omnibox API.