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:
- to access
Tab.url,Tab.title, andTab.favIconUrl, you need to have the "tabs" permission. In Firefox this also means you need "tabs" toqueryby URL. - to use
tabs.executeScript()ortabs.insertCSS()you must have the host permission for the tab
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.
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.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
mode,scope, 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.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.captureVisibleTab()- Creates a data URI encoding an image of the visible area of the currently active tab in the specified window.
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.Tabobject. 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.removeCSS()- Removes from a page CSS which was previously injected by calling
tabs.insertCSS(). tabs.move()- Moves one or more tabs to a new position in the same window or to a different window.
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.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.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.onActivatedinstead. 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.onHighlightedinstead. 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.onActivatedinstead. tabs.onUpdated- Fired when a tab is updated.
tabs.onZoomChange- Fired when a tab is zoomed.
Browser compatibility
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
MutedInfo | Yes | No | 47 | No | Yes |
MutedInfoReason | Yes | No | 47 | No | Yes |
TAB_ID_NONE | Yes | Yes | 45 | 54 | Yes |
Tab | Yes * | Yes * | 45 * | 54 * | Yes * |
TabStatus | Yes | Yes | 45 | 54 | Yes |
WindowType | Yes | Yes | 45 | 54 | Yes |
ZoomSettings | Yes | No | 45 | No | Yes |
ZoomSettingsMode | Yes | No | 45 | No | Yes |
ZoomSettingsScope | Yes | No | 45 | No | Yes |
captureVisibleTab | Yes | 15 | 47 | 54 | Yes |
connect | Yes * | No | 45 | 54 | Yes * |
create | Yes * | Yes * | 45 * | 54 * | Yes * |
detectLanguage | Yes | Yes | 45 | No | Yes |
duplicate | Yes | No | 47 | 54 | Yes |
executeScript | Yes * | Yes * | 43 * | 54 * | Yes * |
get | Yes | Yes | 45 | 54 | Yes |
getAllInWindow | Yes | No | 45 | 54 | No |
getCurrent | Yes | Yes | 45 | 54 | Yes |
getSelected | Yes | No | No | No | No |
getZoom | Yes | No | 45 | No | Yes |
getZoomSettings | Yes | No | 45 | No | Yes |
highlight | Yes | No | No | No | No |
insertCSS | Yes * | Yes * | 47 * | 54 * | Yes * |
move | Yes | No | 46 | No | Yes |
onActivated | Yes | Yes | 45 | 54 | Yes |
onActiveChanged | Yes | No | No | No | No |
onAttached | Yes | 15 | 45 | 54 | Yes |
onCreated | Yes | Yes | 45 | 54 | Yes |
onDetached | Yes | 15 | 45 | 54 | Yes |
onHighlightChanged | Yes | No | No | No | No |
onHighlighted | Yes | No | 45 | 54 | No |
onMoved | Yes | No | 45 | No | Yes |
onRemoved | Yes | Yes | 45 | 54 | Yes |
onReplaced | Yes | No | 45 * | 54 * | Yes |
onSelectionChanged | Yes | No | No | No | No |
onUpdated | Yes | Yes | 45 * | 54 | Yes |
onZoomChange | Yes | No | 45 | No | Yes |
query | Yes * | Yes * | 45 * | 54 * | Yes * |
reload | Yes | No | 45 | 54 | Yes |
remove | Yes | Yes | 45 | 54 | Yes |
removeCSS | No | No | 49 | 54 | No |
sendMessage | Yes * | Yes * | 45 | 54 | Yes * |
sendRequest | Yes | No | No | No | No |
setZoom | Yes | No | 45 | No | Yes |
setZoomSettings | Yes | No | 45 | No | Yes |
update | Yes * | Yes * | 45 * | 54 * | Yes * |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Edge incompatibilities
Promises are not supported in Edge. Use callbacks instead.
Chrome incompatibilities
tabs
-
In Firefox, relative URLs passed into
tabs.executeScript()ortabs.insertCSS()are resolved relative to the current page URL. In Chrome, these URLs are resolved relative to the extension's base URL. To work cross-browser, you can specify the path as an absolute URL, starting at the extension's root, like this:/path/to/script.js - In Firefox, querying tabs by URL with
tabs.query()requires"tabs"permission. In Chrome, it's possible without the"tabs"permission but will limit results to tabs whose URLs match host permissions.
Example extensions
- annotate-page
- apply-css
- beastify
- bookmark-it
- chill-out
- context-menu-copy-link-with-types
- context-menu-demo
- contextual-identities
- cookie-bg-picker
- firefox-code-search
- history-deleter
- imagify
- list-cookies
- open-my-page-button
- permissions
- tabs-tabs-tabs
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.
// 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.