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
. Thequery()
function will only get tabs whose properties match the properties included here. To learn more about these properties, see thetabs.Tab
documentation.-
active
Optionalboolean
. Whether the tabs are active in their windows.audible
Optionalboolean
. Whether the tabs are audible.- autoDiscardableOptional
boolean
. Whether the tabs can be discarded automatically by the browser when resources are low.cookieStoreId
Optionalstring
. Use this to return only tabs whose cookie store ID iscookieStoreId
. This option is only available if the extension has the"cookies"
permission.currentWindow
Optionalboolean
. Whether the tabs are in the current window.discarded
Optionalboolean
. 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.highlighted
Optionalboolean
. Whether the tabs are highlighted.index
Optionalinteger
. The position of the tabs within their windows.muted
Optionalboolean
. Whether the tabs are muted.lastFocusedWindow
Optionalboolean
. Whether the tabs are in the last focused window.pinned
Optionalboolean
. Whether the tabs are pinned.status
Optionaltabs.TabStatus
. Whether the tabs have completed loading.title
Optionalstring
. Match page titles against a pattern.url
Optional
orstring
. Match tabs against one or more match patterns. Note that fragment identifiers are not matched.array
ofstring
windowId
Optionalinteger
. The ID of the parent window, orwindows.WINDOW_ID_CURRENT
for the current window.windowType
Optionaltabs.WindowType
. The type of window the tabs are in.
Return value
A Promise
that will be fulfilled with an array
of
objects, containing infomation about each matching tab. If any error occurs, the promise will be rejected with an error message.tabs.Tab
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.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | Yes 1 | 45 2 | 54 2 | Yes |
pinned | Yes | No | 45 | 54 | Yes |
highlighted | Yes | No | 45 | 54 | Yes |
index | 18 | Yes | 45 | 54 | 15 |
currentWindow | 19 | Yes | 45 | 54 | 15 |
lastFocusedWindow | 19 | Yes | 45 | 54 | 15 |
audible | 45 | No | 45 | 54 | 32 |
muted | 45 | No | 45 | 54 | 32 |
cookieStoreId | No | No | 52 | No | No |
discarded | 54 | No | No | No | 41 |
autoDiscardable | 54 | No | No | No | 41 |
2. 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 (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
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.
// 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.