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.

autoDiscardableOptional

boolean. Whether the tabs can be discarded automatically by the browser when resources are low.

cookieStoreId Optional

string. Use this to return only tabs whose cookie store ID is cookieStoreId. This option is only available if the extension has the "cookies" permission.

currentWindowOptional

boolean. Whether the tabs are in the current window.

discardedOptional

boolean. Whether the tabs are discarded. A discarded tab is one whose content has been unloaded from memory, but is still visible in the tab strip. Its content gets reloaded the next time it's activated.

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

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

Get all tabs:

function logTabs(tabs) {
  for (let 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 (let 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 (let 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 (let 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 extensions

• annotate-page
• apply-css
• beastify
• bookmark-it
• chill-out
• contextual-identities
• cookie-bg-picker
• history-deleter
• imagify
• list-cookies
• tabs-tabs-tabs

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.