tabs.query()

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

Syntax

chrome.tabs.query(
  queryInfo,             // object
  function(result) {...} // function
)

This API is also available as browser.tabs.query() in a version that returns a promise.

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.
callback
function. The function is passed the following arguments:
result
array of tabs.Tab. Infomation about each matching tab.

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.

Examples

Get all tabs:

function logTabs(tabs) {
  console.log(tabs);
}

chrome.tabs.query({}, logTabs);

Get all tabs in the current window:

function logTabs(tabs) {
  console.log(tabs);
}

chrome.tabs.query({currentWindow: true}, logTabs);

Get the active tab in the current window:

function logTabs(tabs) {
  console.log(tabs);
}

chrome.tabs.query({currentWindow: true, active: true}, logTabs);

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

function logTabs(tabs) {
  console.log(tabs);
}

chrome.tabs.query({url: "*://*.mozilla.org/*"}, logTabs);

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: Makyen, Jeremie, wbamberg
 Last updated by: Makyen,