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

    数値

戻り値

move()

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

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

パラメータ

  • groupId

    数値

    移動するグループの ID。

  • moveProperties

    オブジェクト

    • index

      数値

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

    • windowId

      number 省略可

      グループの移動先のウィンドウ。デフォルトでは、グループが現在あるウィンドウになります。グループを移動できるのは、windows.WindowType タイプの "normal" を含むウィンドウとの間のみです。

戻り値

  • Promise<TabGroup | undefined>

    Chrome 90 以降

query()

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

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

パラメータ

  • queryInfo

    オブジェクト

    • 閉じています

      ブール値（省略可）

      グループが折りたたまれているかどうか。

    • 色

      色 省略可

      グループの色。

    • 共有

      ブール値（省略可）

      Chrome 137 以降

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

    • title

      文字列 省略可

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

    • windowId

      number 省略可

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

戻り値

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

ユーザーが直接グループを閉じた場合、またはグループにタブが 1 つも含まれていないために自動的にグループが閉じられた場合に発生します。

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void

onUpdated

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

グループが更新されたときに発生します。

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void