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 はブラウザ セッション内で一意です。

  • 共有

    ブール値

    保留中

    グループが共有されているかどうか。

  • title

    文字列 省略可

    グループのタイトル。

  • windowId

    数値

    グループを含むウィンドウの ID。

プロパティ

TAB_GROUP_ID_NONE

グループがないことを表す ID。

値

-1

メソッド

get()

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

指定したグループの詳細を取得します。

パラメータ

  • groupId

    数値

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (group: TabGroup) => void

戻り値

  • Promise<TabGroup>

    Chrome 90 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

move()

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

グループとそのすべてのタブをウィンドウ内または新しいウィンドウに移動します。

パラメータ

  • groupId

    数値

    移動するグループの ID。

  • moveProperties

    オブジェクト

    • index

      数値

      グループを移動する位置。-1 を使用して、グループをウィンドウの最後に配置します。

    • windowId

      number（省略可）

      グループを移動するウィンドウ。デフォルトは、グループが現在表示されているウィンドウです。グループを移動できるのは、windows.WindowType タイプの "normal" のウィンドウ間のみです。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (group?: TabGroup) => void

    • グループ

      TabGroup 省略可

      移動されたグループの詳細。

戻り値

  • Promise<TabGroup | undefined>

    Chrome 90 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

query()

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

指定されたプロパティを持つすべてのグループを取得します。プロパティが指定されていない場合は、すべてのグループを取得します。

パラメータ

  • queryInfo

    オブジェクト

    • 閉じています

      ブール値（省略可）

      グループが閉じられているかどうか。

    • 色

      色 省略可

      グループの色。

    • 共有

      ブール値（省略可）

      保留中

      グループが共有されているかどうか。

    • title

      文字列 省略可

      グループのタイトルをパターンと照合します。

    • windowId

      number（省略可）

      親ウィンドウの ID。現在のウィンドウの場合は windows.WINDOW_ID_CURRENT。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: TabGroup[]) => void

戻り値

  • Promise<TabGroup[]>

    Chrome 90 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

update()

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

グループのプロパティを変更します。updateProperties で指定されていないプロパティは変更されません。

パラメータ

  • groupId

    数値

    変更するグループの ID。

  • updateProperties

    オブジェクト

    • 閉じています

      ブール値（省略可）

      グループを折りたたむかどうか。

    • 色

      色 省略可

      グループの色。

    • title

      文字列 省略可

      グループのタイトル。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (group?: TabGroup) => void

    • グループ

      TabGroup 省略可

      更新されたグループの詳細。

戻り値

  • Promise<TabGroup | undefined>

    Chrome 90 以降

    Promise は Manifest V3 以降でサポートされていますが、下位互換性を確保するためにコールバックが用意されています。同じ関数呼び出しで両方を使用することはできません。Promise は、コールバックに渡されるのと同じ型で解決されます。

イベント

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,
)

グループが閉じられたときに発生します。これは、ユーザーが直接閉じた場合も、タブが 0 個だったために自動的に閉じた場合も同様です。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (group: TabGroup) => void

onUpdated

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

グループが更新されたときに呼び出されます。

パラメータ

  • callback

    関数

    callback パラメータは次のようになります。 

    (group: TabGroup) => void