search.search()

Perform a search using the search engine specified or the default search engine if no search engine is specified.

The results are displayed in the current tab, a new tab, or a new window according to the disposition property or in the tab specified in the tabId property. If neither is specified, the results display in a new tab.

To use this function, your extension must have the "search" manifest permission.

To get the installed search engines, use search.get().

Syntax

js

browser.search.search(
  searchProperties       // object
)

Parameters

searchProperties

object. An object with the following properties:

disposition Optional

string. The location where the search results are displayed. Valid values are CURRENT_TAB, NEW_TAB, and NEW_WINDOW. Defaults to NEW_TAB. Cannot be specified with tabId.

engine Optional

string. The name of the search engine. If the search engine name doesn't exist, the function rejects the call with an error. If this property is omitted, the default search engine is used.

query

string. The search query.

tabId Optional

integer. An optional identifier for the tab you want to execute the search in. If this property is omitted, the search results are displayed in a new tab. Cannot be specified with disposition.

Return value

None.

Examples

A search using the default search engine with the results shown in the current tab (default):

js

function search() {
  browser.search.search({
    query: "styracosaurus",
  });
}

browser.browserAction.onClicked.addListener(search);

A search using Wikipedia with the results shown in a new window:

js

function search() {
  browser.search.search({
    query: "styracosaurus",
    engine: "Wikipedia (en)",
    disposition: "NEW_WINDOW",
  });
}

browser.browserAction.onClicked.addListener(search);

A search using Wikipedia with the results shown in the current tab:

js

function search(tab) {
  browser.search.search({
    query: "styracosaurus",
    engine: "Wikipedia (en)",
    tabId: tab.id,
  });
}

browser.browserAction.onClicked.addListener(search);

Example extensions

Browser compatibility

BCD tables only load in the browser