Welcome Getting started API Reference Samples
Welcome Getting started API Reference Samples

chrome.tabGroups

  • Description

    Use the chrome.tabGroups API to interact with the browser's tab grouping system. You can use this API to modify and rearrange tab groups in the browser. To group and ungroup tabs, or to query what tabs are in groups, use the chrome.tabs API.

  • Permissions
    tabGroups
  • Availability
    Dev channel only.

Summary

  • Types
  • Properties
  • Methods
    chrome.tabGroups.get(groupId: number, callback: function)
    chrome.tabGroups.move(groupId: number, moveProperties: object, callback: function)
    chrome.tabGroups.query(queryInfo: object, callback: function)
    chrome.tabGroups.update(groupId: number, updateProperties: object, callback: function)

Types

TabGroup

Properties

  • collapsed
    boolean

    Whether the group is collapsed. A collapsed group is one whose tabs are hidden.

  • color

    The group's color.

  • id
    number

    The ID of the group. Group IDs are unique within a browser session.

  • title
    string optional

    The title of the group.

  • windowId
    number

    The ID of the window that contains the group.

Color

The group's color.

Enum

"grey", "blue", "red", "yellow", "green", "pink", "purple", or "cyan"

Properties

TAB_GROUP_ID_NONE

An ID that represents the absence of a group.

Value

number -1

Methods

get

chrome.tabGroups.get(groupId: number, callback: function)

Retrieves details about the specified group.

Parameters

  • groupId
    number
  • callback
    function

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

    (group: TabGroup) => {...}

move

chrome.tabGroups.move(groupId: number, moveProperties: object, callback: function)

Moves the group and all its tabs within its window, or to a new window.

Parameters

  • groupId
    number

    The ID of the group to move.

  • moveProperties
    object
    • index
      number

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

    • windowId
      number optional

      The window to move the group to. Defaults to the window the group is currently in. Note that groups can only be moved to and from windows with windows.WindowType type "normal".

  • callback
    function

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

    (group: TabGroup) => {...}
    • Details about the moved group.

query

chrome.tabGroups.query(queryInfo: object, callback: function)

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

Parameters

  • queryInfo
    object
    • collapsed
      boolean optional

      Whether the groups are collapsed.

    • color
      Color optional

      The color of the groups.

    • title
      string optional

      Match group titles against a pattern.

    • windowId
      number optional

      The ID of the parent window, or windows.WINDOW_ID_CURRENT for the current window.

  • callback
    function

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

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

update

chrome.tabGroups.update(groupId: number, updateProperties: object, callback: function)

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

Parameters

  • groupId
    number

    The ID of the group to modify.

  • updateProperties
    object
    • collapsed
      boolean optional

      Whether the group should be collapsed.

    • color
      Color optional

      The color of the group.

    • title
      string optional

      The title of the group.

  • callback
    function

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

    (group: TabGroup) => {...}
    • Details about the updated group.

We serve cookies on this site to analyze traffic, remember your preferences, and optimize your experience.