tabs.query()

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

This is an asynchronous function that returns a Promise.

Syntax

var querying = browser.tabs.query(
  queryInfo             // object
)

Parameters

queryInfo
object. The query() function will only get tabs whose properties match the properties included here. To learn more about these properties, see the tabs.Tab documentation.
activeOptional
boolean. Whether the tabs are active in their windows.
audibleOptional
boolean. Whether the tabs are audible.
currentWindowOptional
boolean. Whether the tabs are in the current window.
highlightedOptional
boolean. Whether the tabs are highlighted.
indexOptional
integer. The position of the tabs within their windows.
mutedOptional
boolean. Whether the tabs are muted.
lastFocusedWindowOptional
boolean. Whether the tabs are in the last focused window.
pinnedOptional
boolean. Whether the tabs are pinned.
statusOptional
tabs.TabStatus. Whether the tabs have completed loading.
titleOptional
string. Match page titles against a pattern.
urlOptional
string or array of string. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.
windowIdOptional
integer. The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window.
windowTypeOptional
tabs.WindowType. The type of window the tabs are in.

Return value

A Promise that will be fulfilled with an array of tabs.Tab objects, containing infomation about each matching tab. If any error occurs, the promise will be rejected with an error message.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 No 33

Compatibility notes

Edge

  • 'highlighted' is not supported.
  • The 'panel', 'app', and 'devtools' values for 'WindowType' are not supported.

Firefox

  • An add-on must have the 'tabs' permission if it wants to use 'url' in the 'queryInfo' parameter.

Examples

Get all tabs:

function logTabs(tabs) {
  for (tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({});
querying.then(logTabs, onError);

Get all tabs in the current window:

function logTabs(tabs) {
  for (tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true});
querying.then(logTabs, onError);

Get the active tab in the current window:

function logTabs(tabs) {
  for (tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({currentWindow: true, active: true});
querying.then(logTabs, onError);

Get tabs for all HTTP and HTTPS URLs under "mozilla.org" or any of its subdomains:

function logTabs(tabs) {
  for (tab of tabs) {
    // tab.url requires the `tabs` permission
    console.log(tab.url);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

var querying = browser.tabs.query({url: "*://*.mozilla.org/*"});
querying.then(logTabs, onError);

Example add-ons

Acknowledgements

This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, baku, Jeremie
 Last updated by: wbamberg,