search.query()

Syntax

browser.search.query(
  queryInfo             // object
)

Parameters

queryInfo

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 CURRENT_TAB. Cannot be specified with tabId.

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.

text

string. The search query.

Return value

None.

Examples

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

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

browser.browserAction.onClicked.addListener(search);

A search with the results shown in a new window:

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

browser.browserAction.onClicked.addListener(search);

A search with the results shown in a specific tab:

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

browser.browserAction.onClicked.addListener(search);

Browser compatibility