chrome.tabGroups

說明

使用 chrome.tabGroups API 與瀏覽器的分頁群組系統互動。您可以使用這項 API 修改及重新排列瀏覽器中的分頁群組。如要將分頁設為群組或取消分組,或是查詢群組中的分頁,請使用 chrome.tabs API。

權限

tabGroups

可用性

Chrome 89 以上版本 MV3 以上版本

類型

Color

群組顏色。

列舉

「grey」

「blue」

「red」

「yellow」

「green」

「pink」

「purple」

「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

      號碼 選填

      要將群組移至的視窗。預設為群組目前所在的視窗。請注意,群組只能移至 windows.WindowType 類型 "normal" 的視窗,或從這類視窗移出。

傳回

  • Promise<TabGroup | undefined>

    Chrome 90 以上版本

query()

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

取得具有指定屬性的所有群組,或所有群組 (如未指定屬性)。

參數

  • queryInfo

    物件

    • 已收合

      布林值 選填

      群組是否已收合。

    • 顏色

      顏色 (選填)

      群組的顏色。

    • 已分享

      布林值 選填

      Chrome 137 以上版本

      群組是否已共用。

    • title

      字串 選填

      根據模式比對群組標題。

    • windowId

      號碼 選填

      父項視窗的 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