chrome.tabs (original) (raw)

Skip to main content

• Docs

  • Overview
  • Get Started
  • Develop
  • How To
  • AI
  • Reference
  • Samples
  • Chrome Web Store

• Case studies

• Blog

• New in Chrome

• Manifest V3

• ➡ Manifest V2

• accessibilityFeatures

• action

• alarms

• audio

• bookmarks

• browsingData

• certificateProvider

• commands

• contentSettings

• contextMenus

• cookies

• debugger

• declarativeContent

• declarativeNetRequest

• desktopCapture

• devtools.inspectedWindow

• devtools.network

• devtools.panels

• devtools.performance

• devtools.recorder

• dns

• documentScan

• dom

• downloads

• enterprise.deviceAttributes

• enterprise.hardwarePlatform

• enterprise.login

• enterprise.networkingAttributes

• enterprise.platformKeys

• events

• extension

• extensionTypes

• fileBrowserHandler

• fileSystemProvider

• fontSettings

• gcm

• history

• i18n

• identity

• idle

• input.ime

• instanceID

• loginState

• management

• notifications

• offscreen

• omnibox

• pageCapture

• permissions

• platformKeys

• power

• printerProvider

• printing

• printingMetrics

• privacy

• processes

• proxy

• readingList

• runtime

• scripting

• search

• sessions

• sidePanel

• storage

• system.cpu

• system.display

• system.memory

• system.storage

• systemLog

• tabCapture

• tabGroups

• tabs

• topSites

• tts

• ttsEngine

• types

• userScripts

• vpnProvider

• wallpaper

• webAuthenticationProxy

• webNavigation

• webRequest

• windows

chrome.tabs

Description

Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser.

The Tabs API not only offers features for manipulating and managing tabs, but can also detect thelanguage of the tab, take a screenshot, andcommunicate with a tab's content scripts.

Permissions

Most features don't require any permissions to use. For example: creating a new tab,reloading a tab, navigating to another URL, etc.

There are three permissions developers should be aware of when working with the Tabs API.

The "tabs" permission

This permission does not give access to the chrome.tabs namespace. Instead, it grants an extension the ability to call tabs.query() against four sensitive properties on tabs.Tab instances: url, pendingUrl, title, andfavIconUrl.

{
  "name": "My extension",
  ...
  "permissions": [
    "tabs"
  ],
  ...
}

Host permissions

Host permissions allow an extension to read and query a matching tab's four sensitivetabs.Tab properties. They can also interact directly with the matching tabs using methods such as tabs.captureVisibleTab(),scripting.executeScript(), scripting.insertCSS(), andscripting.removeCSS().

{
  "name": "My extension",
  ...
  "host_permissions": [
    "http://*/*",
    "https://*/*"
  ],
  ...
}

The "activeTab" permission

activeTab grants an extension temporary host permission for the current tab in response to a user invocation. Unlike host permissions, activeTab does not trigger any warnings.

{
  "name": "My extension",
  ...
  "permissions": [
    "activeTab"
  ],
  ...
}

Use cases

The following sections demonstrate some common use cases.

Open an extension page in a new tab

A common pattern for extensions is to open an onboarding page in a new tab when the extension is installed. The following example shows how to do this.

background.js:

chrome.runtime.onInstalled.addListener(({reason}) => {
  if (reason === 'install') {
    chrome.tabs.create({
      url: "onboarding.html"
    });
  }
});

Get the current tab

This example demonstrates how an extension's service worker can retrieve the active tab from the currently-focused window (or most recently-focused window, if no Chrome windows are focused). This can usually be thought of as the user's current tab.

  async function getCurrentTab() {
    let queryOptions = { active: true, lastFocusedWindow: true };
    // `tab` will either be a `tabs.Tab` instance or `undefined`.
    let [tab] = await chrome.tabs.query(queryOptions);
    return tab;
  }

  function getCurrentTab(callback) {
    let queryOptions = { active: true, lastFocusedWindow: true };
    chrome.tabs.query(queryOptions, ([tab]) => {
      if (chrome.runtime.lastError)
      console.error(chrome.runtime.lastError);
      // `tab` will either be a `tabs.Tab` instance or `undefined`.
      callback(tab);
    });
  }

Mute the specified tab

This example shows how an extension can toggle the muted state for a given tab.

  async function toggleMuteState(tabId) {
    const tab = await chrome.tabs.get(tabId);
    const muted = !tab.mutedInfo.muted;
    await chrome.tabs.update(tabId, {muted});
    console.log(`Tab <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>t</mi><mi>a</mi><mi>b</mi><mi mathvariant="normal">.</mi><mi>i</mi><mi>d</mi></mrow><mi>i</mi><mi>s</mi></mrow><annotation encoding="application/x-tex">{tab.id} is </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">t</span><span class="mord mathnormal">ab</span><span class="mord">.</span><span class="mord mathnormal">i</span><span class="mord mathnormal">d</span></span><span class="mord mathnormal">i</span><span class="mord mathnormal">s</span></span></span></span>{muted ? "muted" : "unmuted"}`);
  }

  function toggleMuteState(tabId) {
    chrome.tabs.get(tabId, async (tab) => {
      let muted = !tab.mutedInfo.muted;
      await chrome.tabs.update(tabId, { muted });
      console.log(`Tab <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>t</mi><mi>a</mi><mi>b</mi><mi mathvariant="normal">.</mi><mi>i</mi><mi>d</mi></mrow><mi>i</mi><mi>s</mi></mrow><annotation encoding="application/x-tex">{tab.id} is </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">t</span><span class="mord mathnormal">ab</span><span class="mord">.</span><span class="mord mathnormal">i</span><span class="mord mathnormal">d</span></span><span class="mord mathnormal">i</span><span class="mord mathnormal">s</span></span></span></span>{ muted ? "muted" : "unmuted" }`);
    });
  }

Move the current tab to the first position when clicked

This example shows how to move a tab while a drag may or may not be in progress. While this example uses chrome.tabs.move, you can use the same waiting pattern for other calls that modify tabs while a drag is in progress.

  chrome.tabs.onActivated.addListener(moveToFirstPosition);

  async function moveToFirstPosition(activeInfo) {
    try {
      await chrome.tabs.move(activeInfo.tabId, {index: 0});
      console.log("Success.");
    } catch (error) {
      if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
        setTimeout(() => moveToFirstPosition(activeInfo), 50);
      } else {
        console.error(error);
      }
    }
  }

  chrome.tabs.onActivated.addListener(moveToFirstPositionMV2);

  function moveToFirstPositionMV2(activeInfo) {
    chrome.tabs.move(activeInfo.tabId, { index: 0 }, () => {
      if (chrome.runtime.lastError) {
        const error = chrome.runtime.lastError;
        if (error == "Error: Tabs cannot be edited right now (user may be dragging a tab).") {
          setTimeout(() => moveToFirstPositionMV2(activeInfo), 50);
        } else {
          console.error(error);
        }
      } else {
        console.log("Success.");
      }
    });
  }

Pass a message to a selected tab's content script

This example demonstrates how an extension's service worker can communicate with content scripts in specific browser tabs using tabs.sendMessage().

function sendMessageToActiveTab(message) {
  const [tab] = await chrome.tabs.query({ active: true, lastFocusedWindow: true });
  const response = await chrome.tabs.sendMessage(tab.id, message);
  // TODO: Do something with the response.
}

Extension examples

For more Tabs API extensions demos, explore any of the following:

• Manifest V2 - Tabs API extensions.
• Manifest V3 - Tabs Manager.

Types

MutedInfo

The tab's muted state and the reason for the last state change.

Properties

• extensionId
  string optional
  The ID of the extension that changed the muted state. Not set if an extension was not the reason the muted state last changed.
• Whether the tab is muted (prevented from playing sound). The tab may be muted even if it has not played or is not currently playing sound. Equivalent to whether the 'muted' audio indicator is showing.
• reason
  MutedInfoReason optional
  The reason the tab was muted or unmuted. Not set if the tab's mute state has never been changed.

MutedInfoReason

An event that caused a muted state change.

Enum

"user"
A user input action set the muted state.

"capture"
Tab capture was started, forcing a muted state change.

"extension"
An extension, identified by the extensionId field, set the muted state.

Tab

Properties

• Whether the tab is active in its window. Does not necessarily mean the window is focused.
• Whether the tab has produced sound over the past couple of seconds (but it might not be heard if also muted). Equivalent to whether the 'speaker audio' indicator is showing.
• Whether the tab can be discarded automatically by the browser when resources are low.
• 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 is reloaded the next time it is activated.
• favIconUrl
  string optional
  The URL of the tab's favicon. This property is only present if the extension has the "tabs" permission or has host permissions for the page. It may also be an empty string if the tab is loading.
• Whether the tab is frozen. A frozen tab cannot execute tasks, including event handlers or timers. It is visible in the tab strip and its content is loaded in memory. It is unfrozen on activation.
• The ID of the group that the tab belongs to.
• The height of the tab in pixels.
• Whether the tab is highlighted.
• The ID of the tab. Tab IDs are unique within a browser session. Under some circumstances a tab may not be assigned an ID; for example, when querying foreign tabs using the sessions API, in which case a session ID may be present. Tab ID can also be set to chrome.tabs.TAB_ID_NONE for apps and devtools windows.
• Whether the tab is in an incognito window.
• The zero-based index of the tab within its window.
• The last time the tab became active in its window as the number of milliseconds since epoch.
• mutedInfo
  MutedInfo optional
  The tab's muted state and the reason for the last state change.
• openerTabId
  number optional
  The ID of the tab that opened this tab, if any. This property is only present if the opener tab still exists.
• pendingUrl
  string optional
  The URL the tab is navigating to, before it has committed. This property is only present if the extension has the "tabs" permission or has host permissions for the page and there is a pending navigation.
• Whether the tab is pinned.
• Please use tabs.Tab.highlighted.
  Whether the tab is selected.
• sessionId
  string optional
  The session ID used to uniquely identify a tab obtained from the sessions API.
• splitViewId
  number optional
  The ID of the Split View that the tab belongs to.
• status
  TabStatus optional
  The tab's loading status.
• The title of the tab. This property is only present if the extension has the "tabs" permission or has host permissions for the page.
• The last committed URL of the main frame of the tab. This property is only present if the extension has the "tabs" permission or has host permissions for the page. May be an empty string if the tab has not yet committed. See also Tab.pendingUrl.
• The width of the tab in pixels.
• The ID of the window that contains the tab.

TabStatus

The tab's loading status.

Enum

"unloaded"

"loading"

"complete"

WindowType

The type of window.

Enum

"normal"

"popup"

"panel"

"app"

"devtools"

ZoomSettings

Defines how zoom changes in a tab are handled and at what scope.

Properties

• defaultZoomFactor
  number optional
  Used to return the default zoom level for the current tab in calls to tabs.getZoomSettings.
• mode
  ZoomSettingsMode optional
  Defines how zoom changes are handled, i.e., which entity is responsible for the actual scaling of the page; defaults to automatic.
• scope
  ZoomSettingsScope optional
  Defines whether zoom changes persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.

ZoomSettingsMode

Defines how zoom changes are handled, i.e., which entity is responsible for the actual scaling of the page; defaults to automatic.

Enum

"automatic"
Zoom changes are handled automatically by the browser.

"manual"
Overrides the automatic handling of zoom changes. The onZoomChange event will still be dispatched, and it is the extension's responsibility to listen for this event and manually scale the page. This mode does not support per-origin zooming, and thus ignores the scope zoom setting and assumes per-tab.

"disabled"
Disables all zooming in the tab. The tab reverts to the default zoom level, and all attempted zoom changes are ignored.

ZoomSettingsScope

Defines whether zoom changes persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.

Enum

"per-origin"
Zoom changes persist in the zoomed page's origin, i.e., all other tabs navigated to that same origin are zoomed as well. Moreover, per-origin zoom changes are saved with the origin, meaning that when navigating to other pages in the same origin, they are all zoomed to the same zoom factor. The per-origin scope is only available in the automatic mode.

"per-tab"
Zoom changes only take effect in this tab, and zoom changes in other tabs do not affect the zooming of this tab. Also, per-tab zoom changes are reset on navigation; navigating a tab always loads pages with their per-origin zoom factors.

Properties

MAX_CAPTURE_VISIBLE_TAB_CALLS_PER_SECOND

The maximum number of times that captureVisibleTab can be called per second. captureVisibleTab is expensive and should not be called too often.

SPLIT_VIEW_ID_NONE

An ID that represents the absence of a split tab.

TAB_ID_NONE

An ID that represents the absence of a browser tab.

TAB_INDEX_NONE

An index that represents the absence of a tab index in a tab_strip.

Methods

captureVisibleTab()

chrome.tabs.captureVisibleTab(
  windowId?: number,
  options?: ImageDetails,
): Promise

Captures the visible area of the currently active tab in the specified window. In order to call this method, the extension must have either the <all_urls> permission or the activeTab permission. In addition to sites that extensions can normally access, this method allows extensions to capture sensitive sites that are otherwise restricted, including chrome:-scheme pages, other extensions' pages, and data: URLs. These sensitive sites can only be captured with the activeTab permission. File URLs may be captured only if the extension has been granted file access.

Returns

connect()

chrome.tabs.connect(
  tabId: number,
  connectInfo?: object,
): runtime.Port

Connects to the content script(s) in the specified tab. The runtime.onConnect event is fired in each content script running in the specified tab for the current extension. For more details, see Content Script Messaging.

Parameters

• connectInfo
  object optional
  • documentId
    string optional
    Open a port to a specific document identified by documentId instead of all frames in the tab.
  • Open a port to a specific frame identified by frameId instead of all frames in the tab.
  • Is passed into onConnect for content scripts that are listening for the connection event.

Returns

• A port that can be used to communicate with the content scripts running in the specified tab. The port's runtime.Port event is fired if the tab closes or does not exist.

create()

chrome.tabs.create(
  createProperties: object,
): Promise<Tab>

Creates a new tab.

Parameters

• • Whether the tab should become the active tab in the window. Does not affect whether the window is focused (see windows.update). Defaults to true.
  • The position the tab should take in the window. The provided value is clamped to between zero and the number of tabs in the window.
  • openerTabId
    number optional
    The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as the newly created tab.
  • Whether the tab should be pinned. Defaults to false
  • selected
    boolean optional
    Please use active.
    Whether the tab should become the selected tab in the window. Defaults to true
  • The URL to initially navigate the tab to. Fully-qualified URLs must include a scheme (i.e., 'http://www.google.com', not 'www.google.com'). Relative URLs are relative to the current page within the extension. Defaults to the New Tab Page.
  • The window in which to create the new tab. Defaults to the current window.

Returns

detectLanguage()

chrome.tabs.detectLanguage(
  tabId?: number,
): Promise

Detects the primary language of the content in a tab.

Returns

discard()

chrome.tabs.discard(
  tabId?: number,
): Promise<Tab | undefined>

Discards a tab from memory. Discarded tabs are still visible on the tab strip and are reloaded when activated.

Parameters

• The ID of the tab to be discarded. If specified, the tab is discarded unless it is active or already discarded. If omitted, the browser discards the least important tab. This can fail if no discardable tabs exist.

Returns

duplicate()

chrome.tabs.duplicate(
  tabId: number,
): Promise<Tab | undefined>

Duplicates a tab.

Parameters

• The ID of the tab to duplicate.

Returns

get()

chrome.tabs.get(
  tabId: number,
): Promise<Tab>

Retrieves details about the specified tab.

Parameters

Returns

getCurrent()

chrome.tabs.getCurrent(): Promise<Tab | undefined>

Gets the tab that this script call is being made from. Returns undefined if called from a non-tab context (for example, a background page or popup view).

Returns

getZoom()

chrome.tabs.getZoom(
  tabId?: number,
): Promise

Gets the current zoom factor of a specified tab.

Parameters

• The ID of the tab to get the current zoom factor from; defaults to the active tab of the current window.

Returns

getZoomSettings()

chrome.tabs.getZoomSettings(
  tabId?: number,
): Promise<ZoomSettings>

Gets the current zoom settings of a specified tab.

Parameters

• The ID of the tab to get the current zoom settings from; defaults to the active tab of the current window.

Returns

goBack()

chrome.tabs.goBack(
  tabId?: number,
): Promise

Go back to the previous page, if one is available.

Parameters

• The ID of the tab to navigate back; defaults to the selected tab of the current window.

Returns

goForward()

chrome.tabs.goForward(
  tabId?: number,
): Promise

Go foward to the next page, if one is available.

Parameters

• The ID of the tab to navigate forward; defaults to the selected tab of the current window.

Returns

group()

chrome.tabs.group(
  options: object,
): Promise

Adds one or more tabs to a specified group, or if no group is specified, adds the given tabs to a newly created group.

Parameters

• • createProperties
    object optional
    Configurations for creating a group. Cannot be used if groupId is already specified.
    * The window of the new group. Defaults to the current window.
  • The ID of the group to add the tabs to. If not specified, a new group will be created.
  • tabIds
    number | [number, ...number[]]
    The tab ID or list of tab IDs to add to the specified group.

Returns

highlight()

chrome.tabs.highlight(
  highlightInfo: object,
): Promise<windows.Window>

Highlights the given tabs and focuses on the first of group. Will appear to do nothing if the specified tab is currently active.

Parameters

• • One or more tab indices to highlight.
  • The window that contains the tabs.

Returns

move()

chrome.tabs.move(
  tabIds: number | number[],
  moveProperties: object,
): Promise<Tab | Tab[]>

Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.

Parameters

• The tab ID or list of tab IDs to move.
• • The position to move the window to. Use -1 to place the tab at the end of the window.
  • Defaults to the window the tab is currently in.

Returns

query()

chrome.tabs.query(
  queryInfo: object,
): Promise<Tab[]>

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

Parameters

• • Whether the tabs are active in their windows.
  • Whether the tabs are audible.
  • autoDiscardable
    boolean optional
    Whether the tabs can be discarded automatically by the browser when resources are low.
  • currentWindow
    boolean optional
    Whether the tabs are in the current window.
  • discarded
    boolean optional
    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 is reloaded the next time it is activated.
  • Whether the tabs are frozen. A frozen tab cannot execute tasks, including event handlers or timers. It is visible in the tab strip and its content is loaded in memory. It is unfrozen on activation.
  • The ID of the group that the tabs are in, or tabGroups.TAB_GROUP_ID_NONE for ungrouped tabs.
  • highlighted
    boolean optional
    Whether the tabs are highlighted.
  • The position of the tabs within their windows.
  • lastFocusedWindow
    boolean optional
    Whether the tabs are in the last focused window.
  • Whether the tabs are muted.
  • Whether the tabs are pinned.
  • splitViewId
    number optional
    The ID of the Split View that the tabs are in, or tabs.SPLIT_VIEW_ID_NONE for tabs that aren't in a Split View.
  • status
    TabStatus optional
    The tab loading status.
  • Match page titles against a pattern. This property is ignored if the extension does not have the "tabs" permission or host permissions for the page.
  • url
    string | string[] optional
    Match tabs against one or more URL patterns. Fragment identifiers are not matched. This property is ignored if the extension does not have the "tabs" permission or host permissions for the page.
  • The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window.
  • windowType
    WindowType optional
    The type of window the tabs are in.

Returns

reload()

chrome.tabs.reload(
  tabId?: number,
  reloadProperties?: object,
): Promise

Reload a tab.

Parameters

• The ID of the tab to reload; defaults to the selected tab of the current window.
• reloadProperties
  object optional
  • bypassCache
    boolean optional
    Whether to bypass local caching. Defaults to false.

Returns

remove()

chrome.tabs.remove(
  tabIds: number | number[],
): Promise

Closes one or more tabs.

Parameters

• The tab ID or list of tab IDs to close.

Returns

sendMessage()

chrome.tabs.sendMessage(
  tabId: number,
  message: any,
  options?: object,
): Promise

Sends a single message to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The runtime.onMessage event is fired in each content script running in the specified tab for the current extension.

Parameters

• The message to send. This message should be a JSON-ifiable object.
• • documentId
    string optional
    Send a message to a specific document identified by documentId instead of all frames in the tab.
  • Send a message to a specific frame identified by frameId instead of all frames in the tab.

Returns

setZoom()

chrome.tabs.setZoom(
  tabId?: number,
  zoomFactor: number,
): Promise

Zooms a specified tab.

Parameters

• The ID of the tab to zoom; defaults to the active tab of the current window.
• The new zoom factor. A value of 0 sets the tab to its current default zoom factor. Values greater than 0 specify a (possibly non-default) zoom factor for the tab.

Returns

setZoomSettings()

chrome.tabs.setZoomSettings(
  tabId?: number,
  zoomSettings: ZoomSettings,
): Promise

Sets the zoom settings for a specified tab, which define how zoom changes are handled. These settings are reset to defaults upon navigating the tab.

Parameters

• The ID of the tab to change the zoom settings for; defaults to the active tab of the current window.
• Defines how zoom changes are handled and at what scope.

Returns

ungroup()

chrome.tabs.ungroup(
  tabIds: number | [number, ...number[]],
): Promise

Removes one or more tabs from their respective groups. If any groups become empty, they are deleted.

Parameters

• tabIds
  number | [number, ...number[]]
  The tab ID or list of tab IDs to remove from their respective groups.

Returns

update()

chrome.tabs.update(
  tabId?: number,
  updateProperties: object,
): Promise<Tab | undefined>

Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified.

Parameters

• Defaults to the selected tab of the current window.
• • Whether the tab should be active. Does not affect whether the window is focused (see windows.update).
  • autoDiscardable
    boolean optional
    Whether the tab should be discarded automatically by the browser when resources are low.
  • highlighted
    boolean optional
    Adds or removes the tab from the current selection.
  • Whether the tab should be muted.
  • openerTabId
    number optional
    The ID of the tab that opened this tab. If specified, the opener tab must be in the same window as this tab.
  • Whether the tab should be pinned.
  • selected
    boolean optional
    Please use highlighted.
    Whether the tab should be selected.
  • A URL to navigate the tab to. JavaScript URLs are not supported; use scripting.executeScript instead.

Returns

Events

onActivated

chrome.tabs.onActivated.addListener(
  callback: function,
)

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, but you can listen to onUpdated events so as to be notified when a URL is set.

Parameters

• The callback parameter looks like:
  (activeInfo: object) => void
  • • The ID of the tab that has become active.
      • The ID of the window the active tab changed inside of.

onAttached

chrome.tabs.onAttached.addListener(
  callback: function,
)

Fired when a tab is attached to a window; for example, because it was moved between windows.

Parameters

• The callback parameter looks like:
  (tabId: number, attachInfo: object) => void

onCreated

chrome.tabs.onCreated.addListener(
  callback: function,
)

Fired when a tab is created. Note that the tab's URL and tab group membership may not be set at the time this event is fired, but you can listen to onUpdated events so as to be notified when a URL is set or the tab is added to a tab group.

Parameters

• The callback parameter looks like:
  (tab: Tab) => void

onDetached

chrome.tabs.onDetached.addListener(
  callback: function,
)

Fired when a tab is detached from a window; for example, because it was moved between windows.

Parameters

• The callback parameter looks like:
  (tabId: number, detachInfo: object) => void

onHighlighted

chrome.tabs.onHighlighted.addListener(
  callback: function,
)

Fired when the highlighted or selected tabs in a window changes.

Parameters

• The callback parameter looks like:
  (highlightInfo: object) => void
  • • All highlighted tabs in the window.
      • The window whose tabs changed.

onMoved

chrome.tabs.onMoved.addListener(
  callback: function,
)

Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response to the manually-moved tab. This event is not fired when a tab is moved between windows; for details, see tabs.onDetached.

Parameters

• The callback parameter looks like:
  (tabId: number, moveInfo: object) => void

onRemoved

chrome.tabs.onRemoved.addListener(
  callback: function,
)

Fired when a tab is closed.

Parameters

• The callback parameter looks like:
  (tabId: number, removeInfo: object) => void
  • • True when the tab was closed because its parent window was closed.
      • The window whose tab is closed.

onReplaced

chrome.tabs.onReplaced.addListener(
  callback: function,
)

Fired when a tab is replaced with another tab due to prerendering or instant.

Parameters

• The callback parameter looks like:
  (addedTabId: number, removedTabId: number) => void

onUpdated

chrome.tabs.onUpdated.addListener(
  callback: function,
)

Fired when a tab is updated.

Parameters

• The callback parameter looks like:
  (tabId: number, changeInfo: object, tab: Tab) => void
  • • The tab's new audible state.
      • autoDiscardable
        boolean optional
        The tab's new auto-discardable state.
      • discarded
        boolean optional
        The tab's new discarded state.
      • favIconUrl
        string optional
        The tab's new favicon URL.
      • The tab's new frozen state.
      • The tab's new group.
      • mutedInfo
        MutedInfo optional
        The tab's new muted state and the reason for the change.
      • The tab's new pinned state.
      • splitViewId
        number optional
        The tab's new Split View.
      • status
        TabStatus optional
        The tab's loading status.
      • The tab's new title.
      • The tab's URL if it has changed.

onZoomChange

chrome.tabs.onZoomChange.addListener(
  callback: function,
)

Fired when a tab is zoomed.

Parameters

• The callback parameter looks like:
  (ZoomChangeInfo: object) => void

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.