說明
使用 chrome.tabGroups
API 與瀏覽器的分頁分組系統互動。您可以使用這個 API 在瀏覽器中修改及重新排列分頁群組。如要將分頁分組或取消分組,或查詢群組中的分頁,請使用 chrome.tabs
API。
權限
tabGroups
適用國家/地區
類型
Color
群組的顏色。
列舉
TabGroup
屬性
-
已收合
boolean
群組是否收合。收合的群組是指分頁遭到隱藏的群組。
-
顏色
群組的顏色。
-
id
號碼
群組的 ID。瀏覽器工作階段中的群組 ID 是唯一的。
-
title
字串 選用
群組的標題。
-
windowId
號碼
群組所屬視窗的 ID。
屬性
TAB_GROUP_ID_NONE
代表缺少群組的 ID。
值
-1
方法
get()
chrome.tabGroups.get(
groupId: number,
callback?: function,
)
擷取指定群組的詳細資料。
傳回
-
Promise<TabGroup>
Chrome 90 以上版本Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。
move()
chrome.tabGroups.move(
groupId: number,
moveProperties: object,
callback?: function,
)
將群組及其所有分頁移至視窗或新視窗。
參數
-
groupId
號碼
要移動的群組 ID。
-
moveProperties
物件
-
索引
號碼
群組移動位置。使用
-1
將群組置於視窗末端。 -
windowId
數字 選填
將群組移至哪個視窗。預設為群組目前所在的視窗。請注意,您只能將群組移入或移出
windows.WindowType
類型為"normal"
的視窗。
-
-
回呼
函式選用
callback
參數如下所示:(group?: TabGroup) => void
-
小組
TabGroup 選用
已移動群組的詳細資料。
-
傳回
-
Promise<TabGroup | undefined>
Chrome 90 以上版本Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。
query()
chrome.tabGroups.query(
queryInfo: object,
callback?: function,
)
取得具有指定屬性的所有群組;如果沒有指定屬性,則取得所有群組。
參數
-
queryInfo
物件
-
已收合
布林值 (選用)
群組是否收合。
-
顏色
顏色 選用
群組的顏色。
-
title
字串 選用
根據模式比對群組標題。
-
windowId
數字 選填
父項視窗的 ID,或目前視窗的
windows.WINDOW_ID_CURRENT
。
-
-
回呼
函式選用
callback
參數如下所示:(result: TabGroup[]) => void
-
結果
TabGroup[]
-
傳回
-
Promise<TabGroup[]>
Chrome 90 以上版本Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。
update()
chrome.tabGroups.update(
groupId: number,
updateProperties: object,
callback?: function,
)
修改群組的屬性。未在 updateProperties
中指定的屬性不會修改。
參數
傳回
-
Promise<TabGroup | undefined>
Chrome 90 以上版本Manifest V3 以上版本支援 Promise,但是為了提供回溯相容性而提供的回呼。您無法在同一個函式呼叫中同時使用這兩者。承諾會用傳遞至回呼的同類型解析。
活動
onCreated
chrome.tabGroups.onCreated.addListener(
callback: function,
)
建立群組時觸發。
onMoved
chrome.tabGroups.onMoved.addListener(
callback: function,
)
群組在視窗中移動時觸發。群組內的個別分頁和群組本身仍會觸發移動事件。群組在不同視窗之間移動時,不會觸發此事件,而是會從其中一個視窗移除,並在另一個視窗中建立。
onRemoved
chrome.tabGroups.onRemoved.addListener(
callback: function,
)
由使用者直接關閉,或因含有零個分頁而自動觸發。
onUpdated
chrome.tabGroups.onUpdated.addListener(
callback: function,
)
更新群組時觸發。