chrome.tabGroups

Description

使用 chrome.tabGroups API 与浏览器的标签分组系统交互。您可以使用此 API 在浏览器中修改和重新排列选项卡组。要分组和取消分组选项卡，或查询分组中的选项卡，请使用 chrome.tabs API。

Permissions

tabGroups

Availability

Chrome 89+ MV3+

Summary

• Types

  Color

  TabGroup

• Properties

  TAB_GROUP_ID_NONE

• Methods

  get

  move

  query

  update

• Events

  onCreated

  onMoved

  onRemoved

  onUpdated

Types

Color

组的颜色。

TYPE

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

TabGroup

PROPERTIES

• collapsed

  boolean

  该组是否折叠。折叠组是隐藏选项卡的组。

• color

  Color

  组的颜色。

• id

  number

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

• title

  string optional

  组的标题。

• windowId

  number

  包含组的窗口的 ID。

Properties

TAB_GROUP_ID_NONE

表示不存在组的 ID。

VALUE

-1

Methods

get

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

Promise

检索有关指定组的详细信息。

PARAMETERS

• groupId

  number

• callback

  function optional

  The callback parameter looks like:

  (group: TabGroup) => void

  • group

    TabGroup

RETURNS

• Promise<TabGroup>

  Pending

  这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

move

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

Promise

在其窗口内移动组及其所有选项卡，或移动到新窗口。

PARAMETERS

• groupId

  number

  要移动的组的 ID。

• moveProperties

  object

  • index

    number

    组移动到的位置。使用 -1 将组放置在窗口的末尾。

  • windowId

    number optional

    要将组移动到的窗口。默认为组当前所在的窗口。请注意，组只能在 windows.WindowType 类型为“正常（normal）”的窗口中移入和移出。

• callback

  function optional

  The callback parameter looks like:

  (group?: TabGroup) => void

  • group

    TabGroup optional

    有关移动组的详细信息。

RETURNS

• Promise<TabGroup | undefined>

  Pending

  这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

query

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

Promise

获取具有指定属性的所有组，如果未指定属性，则获取所有组。

PARAMETERS

• queryInfo

  object

  • collapsed

    boolean optional

    组是否折叠。

  • color

    Color optional

    组的颜色。

  • title

    string optional

    根据模式匹配组标题。

  • windowId

    number optional

    父窗口的 ID，或current window的 windows.WINDOW_ID_CURRENT。

• callback

  function optional

  The callback parameter looks like:

  (result: TabGroup[]) => void

  • result

    TabGroup[]

RETURNS

• Promise<TabGroup[]>

  Pending

  这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

update

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

Promise

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

PARAMETERS

• groupId

  number

  要修改的组的 ID。

• updateProperties

  object

  • collapsed

    boolean optional

    该组是否应折叠。

  • color

    Color optional

    组的颜色。

  • title

    string optional

    组的标题。

• callback

  function optional

  The callback parameter looks like:

  (group?: TabGroup) => void

  • group

    TabGroup optional

    有关更新组的详细信息。

RETURNS

• Promise<TabGroup | undefined>

  Pending

  这仅在未指定callback参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与callback的第一个参数相同。

Events

onCreated

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

创建组时触发。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (group: TabGroup) => void

  • group

    TabGroup

onMoved

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

当一个组在窗口内移动时触发。组内的各个选项卡以及组本身仍会触发移动事件。当一个组在窗口之间移动时不会触发此事件；相反，它将从一个窗口中删除并在另一个窗口中创建。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (group: TabGroup) => void

  • group

    TabGroup

onRemoved

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

当一个组关闭时触发，可以由用户直接关闭，也可以自动关闭，因为它包含零个选项卡。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (group: TabGroup) => void

  • group

    TabGroup

onUpdated

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

更新组时触发。

PARAMETERS

• callback

  function

  The callback parameter looks like:

  (group: TabGroup) => void

  • group

    TabGroup

By.一粒技术服务.