chrome.tabGroups

説明

chrome.tabGroups API を使用して、ブラウザのタブグループ化システムを操作します。この API を使用すると、ブラウザのタブグループを変更または並べ替えることができます。タブのグループ化とグループ化解除、またはグループ内のタブのクエリを行うには、chrome.tabs API を使用します。

権限

tabGroups

対象

Chrome 89 以降 MV3 以降

型

Color

グループの色。

Enum

TabGroup

プロパティ

  • 閉じています

    boolean

    グループが折りたたまれているかどうか。折りたたまれたグループとは、タブが非表示になっているグループのことです。

  • 色

    色

    グループの色。

  • id

    数値

    グループの ID。グループ ID はブラウザ セッション内で一意です。

  • title

    string（省略可）

    グループのタイトル。

  • windowId

    数値

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

プロパティ

TAB_GROUP_ID_NONE

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

値

-1

Methods

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

    オブジェクト

    • 指数

      数値

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

    • windowId

      number（省略可）

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

  • callback

    関数（省略可）

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

    (group?: TabGroup)=>void

    • グループ

      TabGroup 省略可

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

戻り値

  • Promise<TabGroup|未定義>

    Chrome 90 以降

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

query()

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

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

パラメータ

  • queryInfo

    オブジェクト

    • 閉じています

      ブール値（省略可）

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

    • 色

      色 （省略可）

      グループの色。

    • title

      string（省略可）

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

    • windowId

      number（省略可）

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

  • callback

    関数（省略可）

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

    (result: TabGroup[])=>void

    • 件の結果

      タブグループTabGroup[]

戻り値

  • Promise<TabGroup[]>

    Chrome 90 以降

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

update()

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

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

パラメータ

  • groupId

    数値

    変更するグループの ID。

  • updateProperties

    オブジェクト

    • 閉じています

      ブール値（省略可）

      グループを閉じるかどうか。

    • 色

      色 （省略可）

      グループの色。

    • title

      string（省略可）

      グループのタイトル。

  • callback

    関数（省略可）

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

    (group?: TabGroup)=>void

    • グループ

      TabGroup 省略可

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

戻り値

  • Promise<TabGroup|未定義>

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

グループが閉じられたときに呼び出されます。ユーザーによって直接か、タブが含まれていないために自動的に発生します。

パラメータ

  • callback

    機能

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

    (group: TabGroup)=>void

onUpdated

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

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

パラメータ

  • callback

    機能

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

    (group: TabGroup)=>void