The type tabs.Tab
contains information about a tab. This provides access to information about what content is in the tab, how large the content is, what special states or restrictions are in effect, and so forth.
Type
Values of this type are objects. They contain the following properties:
active
boolean
. Whether the tab is active in its window. This may be true even if the tab's window is not currently focused.audible
Optionalboolean
. If the tab is not muted: whether the tab is producing sound. If the tab is muted: whether the tab would be producing sound, if it were not muted.favIconUrl
Optionalstring
. The URL of the tab's favicon. Only present if the add-on has the"tabs"
permission. It may also be an empty string if the tab is loading.height
Optionalinteger
. The height of the tab in pixels.highlighted
boolean
. Whether the tab is highlighted.id
Optionalinteger
. The tab's ID. Tab IDs are unique within a browser session. The tab ID may also be set totabs.TAB_ID_NONE
for browser windows that don't host content tabs (for example, devtools windows).incognito
boolean
. Whether the tab is in a private browsing window.index
integer
. The zero-based index of the tab within its window.mutedInfo
Optionaltabs.MutedInfo
. The current muted state for the tab and the reason for the last state change.openerTabId
Optionalinteger
. The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists.pinned
boolean
. Whether the tab is pinned.selected
boolean
. Whether the tab is selected.sessionId
Optionalstring
. The session ID used to uniquely identify aTab
obtained from thesessions
API.status
Optionalstring
. Either loading or complete.title
Optionalstring
. The title of the tab. Only present if the add-on has the"tabs"
permission.url
Optionalstring
. The URL of the document that the tab is displaying. Only present if the add-on has the"tabs"
permission.width
Optionalinteger
. The width of the tab in pixels.windowId
integer
. The ID of the window that hosts this 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 | 45.0 | No | 33 |
Compatibility notes
Edge
- 'highlighted', 'selected', and 'openerTabId' are not supported.
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.