browser.tabGroups

說明

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

權限

tabGroups

可用性

Chrome 89 以上版本 Chrome 148 起為 browser.* MV3 以上版本

類型

Color

群組顏色。

列舉

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

屬性

• 已收合

  布林值

  群組是否收合。收合群組的分頁會隱藏。

• 顏色

  顏色

  群組顏色。

• id

  數字

  群組 ID。群組 ID 在瀏覽器工作階段中不得重複。

• 已分享

  布林值

  Chrome 137 以上版本 Chrome 148 起為 browser.*

  群組是否已共用。

• title

  字串 選填

  群組名稱。

• windowId

  數字

  包含群組的視窗 ID。

屬性

TAB_GROUP_ID_NONE

代表沒有群組的 ID。

值

-1

方法

get()

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

擷取指定群組的詳細資料。

參數

• groupId

  數字

傳回

• Promise<TabGroup>

  Chrome 90 以上版本 瀏覽器 (自 Chrome 148 起)

move()

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

在視窗內移動群組和所有分頁，或移到新視窗。

參數

• groupId

  數字

  要移動的群組 ID。

• moveProperties

  物件

  • 索引

    數字

    群組要移至的位置。使用 -1 將群組放在視窗結尾。

  • windowId

    數字 選填

    要將群組移至哪個視窗。預設為群組目前所在的視窗。請注意，群組只能在 windows.WindowType 類型為 "normal" 的視窗之間移動。

傳回

• Promise<TabGroup | undefined>

  Chrome 90 以上版本 瀏覽器 (自 Chrome 148 起)

query()

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

取得具有指定屬性的所有群組，如果未指定屬性，則取得所有群組。

參數

• queryInfo

  物件

  • 已收合

    布林值 選填

    群組是否已收合。

  • 顏色

    Color 選填

    群組的顏色。

  • 已分享

    布林值 選填

    Chrome 137 以上版本 Chrome 148 起為 browser.*

    群組是否已共用。

  • title

    字串 選填

    比對群組名稱與模式。

  • windowId

    數字 選填

    父項視窗的 ID，或目前視窗的 windows.WINDOW_ID_CURRENT。

傳回

• Promise<TabGroup[]>

  Chrome 90 以上版本 瀏覽器 (自 Chrome 148 起)

update()

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

修改群組的屬性。未在 updateProperties 中指定的屬性不會遭到修改。

參數

• groupId

  數字

  要修改的群組 ID。

• updateProperties

  物件

  • 已收合

    布林值 選填

    是否要收合群組。

  • 顏色

    Color 選填

    群組的顏色。

  • title

    字串 選填

    群組名稱。

傳回

• Promise<TabGroup | undefined>

  Chrome 90 以上版本 瀏覽器 (自 Chrome 148 起)

事件

onCreated

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

建立群組時觸發。

參數

• callback

  函式

  callback 參數如下：

  (group: TabGroup) => void

  • 群組

    TabGroup

onMoved

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

在視窗內移動群組時觸發。系統仍會為群組內的個別分頁和群組本身觸發移動事件。在視窗之間移動群組時，不會觸發這個事件，而是會從一個視窗中移除，並在另一個視窗中建立。

參數

• callback

  函式

  callback 參數如下：

  (group: TabGroup) => void

  • 群組

    TabGroup

onRemoved

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

當群組關閉時 (無論是由使用者直接關閉，還是因為不含任何分頁而自動關閉)，系統就會觸發這個事件。

參數

• callback

  函式

  callback 參數如下：

  (group: TabGroup) => void

  • 群組

    TabGroup

onUpdated

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

在群組更新時觸發。

參數

• callback

  函式

  callback 參數如下：

  (group: TabGroup) => void

  • 群組

    TabGroup