chrome.tabs

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.

• muted

  boolean

  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.

Properties

• active

  boolean

  Whether the tab is active in its window. Does not necessarily mean the window is focused.

• audible

  boolean optional

  Since Chrome 45.

  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.

• autoDiscardable

  boolean

  Since Chrome 54.

  Whether the tab can be discarded automatically by the browser when resources are low.

• discarded

  boolean

  Since Chrome 54.

  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's manifest includes the "tabs" permission. It may also be an empty string if the tab is loading.

• groupId

  number

  Since Chrome 88.

  The ID of the group that the tab belongs to.

• height

  number optional

  The height of the tab in pixels.

• highlighted

  boolean

  Whether the tab is highlighted.

• id

  number optional

  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.

• incognito

  boolean

  Whether the tab is in an incognito window.

• index

  number

  The zero-based index of the tab within its window.

• mutedInfo

  MutedInfo optional

  Since Chrome 46.

  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

  Since Chrome 79.

  The URL the tab is navigating to, before it has committed. This property is only present if the extension's manifest includes the "tabs" permission and there is a pending navigation.

• pinned

  boolean

  Whether the tab is pinned.

• selected

  boolean

  Deprecated. Please use Tab.highlighted.

  Whether the tab is selected.

• sessionId

  string optional

  The session ID used to uniquely identify a tab obtained from the sessions API.

• status

  TabStatus optional

  The tab's loading status.

• title

  string optional

  The title of the tab. This property is only present if the extension's manifest includes the "tabs" permission.

• url

  string optional

  The last committed URL of the main frame of the tab. This property is only present if the extension's manifest includes the "tabs" permission and may be an empty string if the tab has not yet committed. See also Tab.pendingUrl.

• width

  number optional

  The width of the tab in pixels.

• windowId

  number

  The ID of the window that contains the tab.

Properties

• defaultZoomFactor

  number optional

  Since Chrome 43.

  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.

Enum

Enum

Enum

Enum

Enum

Value

Parameters

• windowId

  number optional

  The target window. Defaults to the current window.

• options

  extensionTypes.ImageDetails optional
• callback

  function

  The callback parameter should be a function that looks like this:

  (dataUrl: string) => {...}

  • dataUrl

    string

    A data URL that encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML img element for display.

Parameters

• tabId

  number
• connectInfo

  object
  • frameId

    number optional

    Since Chrome 41.

    Open a port to a specific frame identified by frameId instead of all frames in the tab.

  • name

    string optional

    Is passed into onConnect for content scripts that are listening for the connection event.

Returns

• returns

  runtime.Port

  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.

Parameters

• createProperties

  object
  • active

    boolean optional

    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.

  • index

    number optional

    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.

  • pinned

    boolean optional

    Whether the tab should be pinned. Defaults to false

  • selected

    boolean optional

    Deprecated. Please use active.

    Whether the tab should become the selected tab in the window. Defaults to true

  • url

    string optional

    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.

  • windowId

    number optional

    The window in which to create the new tab. Defaults to the current window.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

    The created tab.

Parameters

• tabId

  number optional

  Defaults to the active tab of the current window.

• callback

  function

  The callback parameter should be a function that looks like this:

  (language: string) => {...}

  • language

    string

    An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The second to fourth columns are checked and the first non-NULL value is returned, except for Simplified Chinese for which zh-CN is returned. For an unknown/undefined language, und is returned.

Parameters

• tabId

  number

  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.

• callback

  function

  Called after the operation is completed.

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

    The discarded tab, if it was successfully discarded; undefined otherwise.

Parameters

• tabId

  number

  The ID of the tab to duplicate.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

    Details about the duplicated tab. The Tab object does not contain url, pendingUrl, title, and favIconUrl if the "tabs" permission has not been requested.

Parameters

• tabId

  number optional

  The ID of the tab in which to run the script; defaults to the active tab of the current window.

• details

  extensionTypes.InjectDetails

  Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.

• callback

  function

  Called after all the JavaScript has been executed.

  The callback parameter should be a function that looks like this:

  (result: any[]) => {...}

  • result

    any[]

    The result of the script in every injected frame.

Parameters

• tabId

  number
• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

Parameters

• windowId

  number optional

  Defaults to the current window.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tabs: Tab[]) => {...}

  • tabs

    Tab[]

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

Parameters

• windowId

  number optional

  Defaults to the current window.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

Parameters

• tabId

  number optional

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

• callback

  function

  Called with the tab's current zoom factor after it has been fetched.

  The callback parameter should be a function that looks like this:

  (zoomFactor: number) => {...}

  • zoomFactor

    number

    The tab's current zoom factor.

Parameters

• tabId

  number optional

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

• callback

  function

  Called with the tab's current zoom settings.

  The callback parameter should be a function that looks like this:

  (zoomSettings: ZoomSettings) => {...}

  • zoomSettings

    ZoomSettings

    The tab's current zoom settings.

Parameters

• tabId

  number

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

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabId

  number

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

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• options

  object
  • createProperties

    object optional

    Configurations for creating a group. Cannot be used if groupId is already specified.

    • windowId

      number optional

      The window of the new group. Defaults to the current window.

  • groupId

    number optional

    The ID of the group to add the tabs to. If not specified, a new group will be created.

  • tabIds

    number | number[]

    The tab ID or list of tab IDs to add to the specified group.

• callback

  function

  The callback parameter should be a function that looks like this:

  (groupId: number) => {...}

  • groupId

    number

    The ID of the group that the tabs were added to.

Parameters

• highlightInfo

  object
  • tabs

    number[] | number

    One or more tab indices to highlight.

  • windowId

    number optional

    The window that contains the tabs.

• callback

  function

  The callback parameter should be a function that looks like this:

  (window: windows.Window) => {...}

  • window

    windows.Window

    Contains details about the window whose tabs were highlighted.

Parameters

• tabId

  number optional

  The ID of the tab in which to insert the CSS; defaults to the active tab of the current window.

• details

  extensionTypes.InjectDetails

  Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.

• callback

  function

  Called when all the CSS has been inserted.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabIds

  number | number[]

  The tab ID or list of tab IDs to move.

• moveProperties

  object
  • index

    number

    The position to move the window to. Use -1 to place the tab at the end of the window.

  • windowId

    number optional

    Defaults to the window the tab is currently in.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tabs: Tab | Tab[]) => {...}

  • tabs

    Tab | Tab[]

    Details about the moved tabs.

Parameters

• queryInfo

  object
  • active

    boolean optional

    Whether the tabs are active in their windows.

  • audible

    boolean optional

    Since Chrome 45.

    Whether the tabs are audible.

  • autoDiscardable

    boolean optional

    Since Chrome 54.

    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

    Since Chrome 54.

    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.

  • groupId

    number optional

    Since Chrome 88.

    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.

  • index

    number optional

    The position of the tabs within their windows.

  • lastFocusedWindow

    boolean optional

    Whether the tabs are in the last focused window.

  • muted

    boolean optional

    Since Chrome 45.

    Whether the tabs are muted.

  • pinned

    boolean optional

    Whether the tabs are pinned.

  • status

    TabStatus optional

    The tab loading status.

  • title

    string optional

    Match page titles against a pattern. This property is ignored if the extension does not have the "tabs" permission.

  • 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.

  • windowId

    number optional

    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.

• callback

  function

  The callback parameter should be a function that looks like this:

  (result: Tab[]) => {...}

  • result

    Tab[]

Parameters

• tabId

  number

  The ID of the tab to reload; defaults to the selected tab of the current window.

• reloadProperties

  object
  • bypassCache

    boolean optional

    Whether to bypass local caching. Defaults to false.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabIds

  number | number[]

  The tab ID or list of tab IDs to close.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabId

  number optional

  The ID of the tab from which to remove the CSS; defaults to the active tab of the current window.

• details

  extensionTypes.DeleteInjectionDetails

  Details of the CSS text to remove. Either the code or the file property must be set, but both may not be set at the same time.

• callback

  function

  Called when all the CSS has been removed.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabId

  number
• message

  any

  The message to send. This message should be a JSON-ifiable object.

• options

  object

  Since Chrome 41.

  • frameId

    number optional

    Send a message to a specific frame identified by frameId instead of all frames in the tab.

• responseCallback

  function

  The responseCallback function looks like this:

  responseCallback(response: any) => {...}

  • response

    any

    The JSON response object sent by the handler of the message. If an error occurs while connecting to the specified tab, the callback is called with no arguments and runtime.lastError is set to the error message.

Parameters

• tabId

  number
• request

  any
• responseCallback

  function

  The responseCallback function looks like this:

  responseCallback(response: any) => {...}

  • response

    any

    The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback is called with no arguments and runtime.lastError is set to the error message.

Parameters

• tabId

  number optional

  The ID of the tab to zoom; defaults to the active tab of the current window.

• zoomFactor

  number

  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.

• callback

  function

  Called after the zoom factor has been changed.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabId

  number optional

  The ID of the tab to change the zoom settings for; defaults to the active tab of the current window.

• zoomSettings

  ZoomSettings

  Defines how zoom changes are handled and at what scope.

• callback

  function

  Called after the zoom settings are changed.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabIds

  number | number[]

  The tab ID or list of tab IDs to remove from their respective groups.

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• tabId

  number optional

  Defaults to the selected tab of the current window.

• updateProperties

  object
  • active

    boolean optional

    Whether the tab should be active. Does not affect whether the window is focused (see windows.update).

  • autoDiscardable

    boolean optional

    Since Chrome 54.

    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.

  • muted

    boolean optional

    Since Chrome 45.

    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.

  • pinned

    boolean optional

    Whether the tab should be pinned.

  • selected

    boolean optional

    Deprecated. Please use highlighted.

    Whether the tab should be selected.

  • url

    string optional

    A URL to navigate the tab to. JavaScript URLs are not supported; use executeScript instead.

• callback

  function

  The callback parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

    Details about the updated tab. The Tab object does not contain url, pendingUrl, title, and favIconUrl if the "tabs" permission has not been requested.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (activeInfo: object) => {...}

  • activeInfo

    object
    • tabId

      number

      The ID of the tab that has become active.

    • windowId

      number

      The ID of the window the active tab changed inside of.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, selectInfo: object) => {...}

  • tabId

    number

    The ID of the tab that has become active.

  • selectInfo

    object
    • windowId

      number

      The ID of the window the selected tab changed inside of.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, attachInfo: object) => {...}

  • tabId

    number
  • attachInfo

    object
    • newPosition

      number
    • newWindowId

      number

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tab: Tab) => {...}

  • tab

    Tab

    Details of the tab that was created.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, detachInfo: object) => {...}

  • tabId

    number
  • detachInfo

    object
    • oldPosition

      number
    • oldWindowId

      number

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (selectInfo: object) => {...}

  • selectInfo

    object
    • tabIds

      number[]

      All highlighted tabs in the window.

    • windowId

      number

      The window whose tabs changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (highlightInfo: object) => {...}

  • highlightInfo

    object
    • tabIds

      number[]

      All highlighted tabs in the window.

    • windowId

      number

      The window whose tabs changed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, moveInfo: object) => {...}

  • tabId

    number
  • moveInfo

    object
    • fromIndex

      number
    • toIndex

      number
    • windowId

      number

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, removeInfo: object) => {...}

  • tabId

    number
  • removeInfo

    object
    • isWindowClosing

      boolean

      True when the tab was closed because its parent window was closed.

    • windowId

      number

      The window whose tab is closed.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (addedTabId: number, removedTabId: number) => {...}

  • addedTabId

    number
  • removedTabId

    number

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, selectInfo: object) => {...}

  • tabId

    number

    The ID of the tab that has become active.

  • selectInfo

    object
    • windowId

      number

      The ID of the window the selected tab changed inside of.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (tabId: number, changeInfo: object, tab: Tab) => {...}

  • tabId

    number
  • changeInfo

    object

    Lists the changes to the state of the tab that was updated.

    • audible

      boolean optional

      Since Chrome 45.

      The tab's new audible state.

    • autoDiscardable

      boolean optional

      Since Chrome 54.

      The tab's new auto-discardable state.

    • discarded

      boolean optional

      Since Chrome 54.

      The tab's new discarded state.

    • favIconUrl

      string optional

      The tab's new favicon URL.

    • groupId

      number optional

      Since Chrome 88.

      The tab's new group.

    • mutedInfo

      MutedInfo optional

      Since Chrome 46.

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

    • pinned

      boolean optional

      The tab's new pinned state.

    • status

      TabStatus optional

      The tab's loading status.

    • title

      string optional

      Since Chrome 48.

      The tab's new title.

    • url

      string optional

      The tab's URL if it has changed.

  • tab

    Tab

    Gives the state of the tab that was updated.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (ZoomChangeInfo: object) => {...}

  • ZoomChangeInfo

    object
    • newZoomFactor

      number
    • oldZoomFactor

      number
    • tabId

      number
    • zoomSettings

      ZoomSettings