Interact with the browser's tab system.

You can use this API to get a list of opened tabs, filtered by various criteria, and to open, update, move, reload, and remove tabs. You can't directly access the content hosted by tabs using this API, but you can insert JavaScript and CSS into tabs using the tabs.executeScript() or tabs.insertCSS() APIs.

You can use most of this API without any special permission. However:

Alternatively, you can get these permissions temporarily, only for the currently active tab and only in response to an explicit user action, by asking for the "activeTab" permission.

Many tab operations use a Tab ID. Tab IDs are guaranteed to be unique to a single tab only within a browser session. If the browser is restarted, then it can and will reuse tab IDs. To associate information with a tab across browser restarts, use sessions.setTabValue().

Types

tabs.MutedInfoReason
Specifies the reason a tab was muted or unmuted.
tabs.MutedInfo
This object contains a boolean indicating whether the tab is muted, and the reason for the last state change.
tabs.PageSettings

Used to control how a tab is rendered as a PDF by the tabs.saveAsPDF() method.

tabs.Tab
This type contains information about a tab.
tabs.TabStatus
Indicates whether the tab has finished loading.
tabs.WindowType
The type of window that hosts this tab.
tabs.ZoomSettingsMode
Defines whether zoom changes are handled by the browser, by the extension, or are disabled.
tabs.ZoomSettingsScope
Defines whether zoom changes will persist for the page's origin, or only take effect in this tab.
tabs.ZoomSettings
Defines zoom settings modescope, and default zoom factor.

Properties

tabs.TAB_ID_NONE
A special ID value given to tabs that are not browser tabs (for example, tabs in devtools windows).

Functions

tabs.captureVisibleTab()
Creates a data URI encoding an image of the visible area of the currently active tab in the specified window.
tabs.connect()
Sets up a messaging connection between the extension's background scripts (or other privileged scripts, such as popup scripts or options page scripts) and any content scripts running in the specified tab.
tabs.create()
Creates a new tab.
tabs.detectLanguage()
Detects the primary language of the content in a tab.
tabs.duplicate()
Duplicates a tab.
tabs.executeScript()
Injects JavaScript code into a page.
tabs.get()
Retrieves details about the specified tab.
tabs.getAllInWindow()
Gets details about all tabs in the specified window.
tabs.getCurrent()
Gets information about the tab that this script is running in, as a tabs.Tab object.
tabs.getSelected()
Gets the tab that is selected in the specified window.
tabs.getZoom()
Gets the current zoom factor of the specified tab.
tabs.getZoomSettings()
Gets the current zoom settings for the specified tab.
tabs.highlight()
Highlights one or more tabs.
tabs.insertCSS()
Injects CSS into a page.
tabs.move()
Moves one or more tabs to a new position in the same window or to a different window.
tabs.print()
Prints the contents of the active tab.
tabs.printPreview()
Opens print preview for the active tab.
tabs.query()
Gets all tabs that have the specified properties, or all tabs if no properties are specified.
tabs.reload()
Reload a tab, optionally bypassing the local web cache.
tabs.remove()
Closes one or more tabs.
tabs.removeCSS()
Removes from a page CSS which was previously injected by calling tabs.insertCSS().
tabs.saveAsPDF()
Saves the current page as a PDF.
tabs.sendMessage()
Sends a single message to the content script(s) in the specified tab.
tabs.sendRequest()
Sends a single request to the content script(s) in the specified tab. Deprecated: use tabs.sendMessage() instead.
tabs.setZoom()
Zooms the specified tab.
tabs.setZoomSettings()
Sets the zoom settings for the specified tab.
tabs.toggleReaderMode()
Toggles Reader mode for the specified tab.
tabs.update()
Navigate the tab to a new URL, or modify other properties of the tab.

Events

tabs.onActivated
Fires when the active tab in a window changes. Note that the tab's URL may not be set at the time this event fired.
tabs.onActiveChanged
Fires when the selected tab in a window changes. Deprecated: use tabs.onActivated instead.
tabs.onAttached
Fired when a tab is attached to a window, for example because it was moved between windows.
tabs.onCreated
Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired.
tabs.onDetached
Fired when a tab is detached from a window, for example because it is being moved between windows.
tabs.onHighlightChanged
Fired when the highlighted or selected tabs in a window change. Deprecated: use tabs.onHighlighted instead.
tabs.onHighlighted
Fired when the highlighted or selected tabs in a window change.
tabs.onMoved
Fired when a tab is moved within a window.
tabs.onRemoved
Fired when a tab is closed.
tabs.onReplaced
Fired when a tab is replaced with another tab due to prerendering.
tabs.onSelectionChanged
Fires when the selected tab in a window changes. Deprecated: use tabs.onActivated instead.
tabs.onUpdated
Fired when a tab is updated.
tabs.onZoomChange
Fired when a tab is zoomed.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
MutedInfo Yes No47 No Yes
MutedInfoReason Yes No47 No Yes
PageSettings No No56 No No
TAB_ID_NONE Yes Yes4554 Yes
TabStatus Yes Yes4554 Yes
WindowType Yes Yes4554 Yes
ZoomSettings Yes No45 No Yes
ZoomSettingsMode Yes No45 No Yes
ZoomSettingsScope Yes No45 No Yes
captureVisibleTab Yes *154754 Yes *
connect Yes No4554 Yes
create Yes Yes4554 Yes
detectLanguage Yes Yes45 No Yes
duplicate Yes No4754 Yes
executeScript Yes * Yes *43 *54 * Yes *
get Yes Yes4554 Yes
getAllInWindow Yes No4554 No
getCurrent Yes Yes4554 Yes
getSelected Yes No No No No
getZoom Yes No45 No Yes
getZoomSettings Yes No45 No Yes
highlight Yes No No No No
insertCSS Yes * Yes *47 *54 * Yes *
move Yes No46 No Yes
onActivated Yes Yes4554 Yes
onActiveChanged Yes No No No No
onAttached Yes154554 Yes
onCreated Yes Yes4554 Yes
onDetached Yes154554 Yes
onHighlightChanged Yes No No No No
onHighlighted Yes No4554 No
onMoved Yes No45 No Yes
onRemoved Yes Yes4554 Yes
onReplaced Yes No No No Yes
onSelectionChanged Yes No No No No
onUpdated Yes Yes4554 Yes
onZoomChange Yes No45 No Yes
print No No56 No No
printPreview No No56 No No
query Yes Yes *4554 Yes
reload Yes No4554 Yes
remove Yes Yes4554 Yes
removeCSS No No4954 No
saveAsPDF No No56 * No No
sendMessage Yes Yes *4554 Yes
sendRequest Yes No No No No
setZoom Yes No45 No Yes
setZoomSettings Yes No45 No Yes
toggleReaderMode No No58 No No
update Yes Yes4554 Yes

Example extensions

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: wbamberg, cmcaine, andrewtruongmoz, abbycar, idupree, Sheppy, Jeremie, kmaglione
 Last updated by: wbamberg,