Add-ons

tabs.Tab

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 Optional
boolean. 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.
autoDiscardable Optional
boolean. Whether the tab can be discarded automatically by the browser when resources are low.
cookieStoreId Optional
string. The cookie store of the tab. If different tabs can have different cookie stores (for example, to support contextual identity), you can pass this as the storeId option into various methods of the cookies API, to set and get cookies associated with this tab's cookie store. Only present if the extension has the "cookies" permission.
discarded Optional
boolean. Whether the tab is 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.
favIconUrl Optional
string. The URL of the tab's favicon. Only present if the extension has the "tabs" permission. It may also be an empty string if the tab is loading.
height Optional
integer. The height of the tab in pixels.
highlighted
boolean. Whether the tab is highlighted.
id Optional
integer. The tab's ID. Tab IDs are unique within a browser session. The tab ID may also be set to tabs.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.
isArticle
boolean. True if the tab can be rendered in Reader Mode, false otherwise.
isInReaderMode
boolean. True if the tab is currently being rendered in Reader Mode, false otherwise.
lastAccessed
double. Time at which the tab was last accessed, in milliseconds since the epoch.
mutedInfo Optional
tabs.MutedInfo. The current muted state for the tab and the reason for the last state change.
openerTabId Optional
integer. 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 Optional
string. The session ID used to uniquely identify a Tab obtained from the sessions API.
status Optional
string. Either loading or complete.
title Optional
string. The title of the tab. Only present if the extension has the "tabs" permission.
url Optional
string. The URL of the document that the tab is displaying. Only present if the extension has the "tabs" permission.
width Optional
integer. The width of the tab in pixels.
windowId
integer. The ID of the window that hosts this tab.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
active Yes Yes4554 Yes
audible45 No455432
autoDiscardable54 No No No41
cookieStoreId No No52 No No
discarded54 No575741
favIconUrl Yes Yes4554 Yes
height31 No455418
highlighted Yes No4554 Yes
id Yes Yes4554 Yes
incognito Yes Yes14554 Yes
index Yes Yes4554 Yes
isArticle No No58 No No
isInReaderMode No No58 No No
lastAccessed No No5656 No
mutedInfo46 No455433
openerTabId18 No57 No15
pinned Yes Yes4554 Yes
selected Yes No4554 Yes
sessionId31 No No No18
status Yes Yes4554 Yes
title Yes Yes4554 Yes
url Yes Yes4554 Yes
width31 No455418
windowId Yes Yes4554 Yes

1. Supported as inPrivate.

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: fscholz, wbamberg, rebloor, andrewtruongmoz, snoack, groovecoder, Sheppy, Jeremie
 Last updated by: fscholz,