chrome.tabGroups

说明

使用 chrome.tabGroups API 与浏览器的标签页分组系统进行交互。您可以使用此 API 修改和重新排列浏览器中的标签页组。如需对标签页进行分组和取消分组,或查询哪些标签页位于分组中,请使用 chrome.tabs API。

权限

tabGroups

可用性

Chrome 89 及更高版本 MV3 及更高版本

类型

Color

群组的颜色。

枚举

“灰色”

“蓝色”

“红色”

“黄色”

"green"

“粉色”

“紫色”

“cyan”

"orange"

TabGroup

属性

  • 已收起

    布尔值

    群组是否已收起。收起的群组是指标签页处于隐藏状态的群组。

  • 颜色

    群组的颜色。

  • id

    数值

    群组的 ID。组 ID 在浏览器会话中是唯一的。

  • 共享

    布尔值

    Chrome 137 及更高版本

    相应群组是否为共享群组。

  • title

    字符串(选填)

    群组的标题。

  • windowId

    数值

    包含相应群组的窗口的 ID。

属性

TAB_GROUP_ID_NONE

表示没有群组的 ID。

-1

方法

get()

chrome.tabGroups.get(
  groupId: number,
)
: Promise<TabGroup>

检索指定群组的详细信息。

参数

  • groupId

    数值

返回

  • Promise<TabGroup>

    Chrome 90 及更高版本

move()

chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
)
: Promise<TabGroup | undefined>

将相应标签页组及其窗口中的所有标签页移至新窗口。

参数

  • groupId

    数值

    要移动的群组的 ID。

  • moveProperties

    对象

    • 索引

      数值

      要将群组移至的位置。使用 -1 将群组放置在窗口末尾。

    • windowId

      number 可选

      要将群组移至的窗口。默认为群组当前所在的窗口。请注意,群组只能在 windows.WindowType 类型为 "normal" 的窗口之间移动。

返回

  • Promise<TabGroup | undefined>

    Chrome 90 及更高版本

query()

chrome.tabGroups.query(
  queryInfo: object,
)
: Promise<TabGroup[]>

获取具有指定属性的所有群组,如果未指定任何属性,则获取所有群组。

参数

  • queryInfo

    对象

    • 已收起

      布尔值(可选)

      相应群组是否已收起。

    • 颜色

      颜色可选

      群组的颜色。

    • 共享

      布尔值(可选)

      Chrome 137 及更高版本

      相应群组是否为共享群组。

    • title

      字符串(选填)

      将群组标题与某种模式进行匹配。

    • windowId

      number 可选

      父窗口的 ID,或windows.WINDOW_ID_CURRENT(表示当前窗口)。

返回

  • Promise<TabGroup[]>

    Chrome 90 及更高版本

update()

chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
)
: Promise<TabGroup | undefined>

修改群组的属性。不会修改未在 updateProperties 中指定的属性。

参数

  • groupId

    数值

    要修改的群组的 ID。

  • updateProperties

    对象

    • 已收起

      布尔值(可选)

      群组是否应收起。

    • 颜色

      颜色可选

      群组的颜色。

    • title

      字符串(选填)

      群组的标题。

返回

  • Promise<TabGroup | undefined>

    Chrome 90 及更高版本

事件

onCreated

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

在创建群组时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (group: TabGroup) => void

onMoved

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

当群组在窗口内移动时触发。系统仍会针对群组中的各个标签页以及群组本身触发移动事件。当群组在窗口之间移动时,不会触发此事件;相反,系统会从一个窗口中移除该群组,并在另一个窗口中创建该群组。

参数

  • callback

    函数

    callback 参数如下所示:

    (group: TabGroup) => void

onRemoved

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

当群组关闭时触发,无论是用户直接关闭还是因群组中不包含任何标签页而自动关闭。

参数

  • callback

    函数

    callback 参数如下所示:

    (group: TabGroup) => void

onUpdated

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

在群组更新时触发。

参数

  • callback

    函数

    callback 参数如下所示:

    (group: TabGroup) => void