omnibox.setDefaultSuggestion()

この記事はまだボランティアによって 日本語 に翻訳されていません。ぜひ MDN に参加して翻訳を手伝ってください!
この記事を English (US) で読むこともできます。

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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
setDefaultSuggestionChrome Full support YesEdge No support NoFirefox Full support 52
Notes
Full support 52
Notes
Notes 'description' is interpreted as plain text, and XML markup is not recognised.
Opera Full support YesFirefox Android No support No

Legend

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

Examples

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

Example extensions

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.

ドキュメントのタグと貢献者

このページの貢献者: mdnwebdocs-bot, wbamberg, andrewtruongmoz
最終更新者: mdnwebdocs-bot,