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
browser.search.search(
searchProperties // object
)
Parameters
searchProperties-
object. An object with the following properties:dispositionOptional-
string. The location where the search results are displayed. Valid values areCURRENT_TAB,NEW_TAB, andNEW_WINDOW. Defaults toNEW_TAB. Cannot be specified withtabId. engineOptional-
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. tabIdOptional-
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 withdisposition.
Return value
None.
Examples
A search using the default search engine with the results shown in the current tab (default):
function search() {
browser.search.search({
query: "styracosaurus",
});
}
browser.browserAction.onClicked.addListener(search);
A search using Wikipedia with the results shown in a new window:
async function search() {
try {
// try to search using the `Wikipedia (en)` search engine
await browser.search.search({
query: "styracosaurus",
engine: "Wikipedia (en)",
disposition: "NEW_WINDOW",
});
} catch (ex) {
// if the search fails, e.g., because the search engine isn't defined to the browser, initiate the search using a url
await browser.windows.create({
url: "https://en.wikipedia.org/w/index.php?title=Special:Search&search=styracosaurus",
});
}
}
browser.browserAction.onClicked.addListener(search);
A search using Wikipedia with the results shown in the current tab:
async function search(tab) {
try {
// try to search using the `Wikipedia (en)` search engine
await browser.search.search({
query: "styracosaurus",
engine: "Wikipedia (en)",
tabId: tab.id,
});
} catch (ex) {
// if the search fails, e.g., because the search engine isn't defined to the browser, initiate the search using a url
await browser.tabs.update(tab.id, {
url: "https://en.wikipedia.org/w/index.php?title=Special:Search&search=styracosaurus",
});
}
}
browser.browserAction.onClicked.addListener(search);
Example extensions
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
search
|
|
|
|
|
|
|
|
searchProperties
|
|
|
|
|
|
|
|
searchProperties.disposition
|
|
|
|
|
|
|
|
searchProperties.engine
|
|
|
|
|
|
|
|
searchProperties.query
|
|
|
|
|
|
|
|
searchProperties.tabId
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support