chrome.tabGroups

説明

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

権限

tabGroups

対象

Chrome 89 以降 MV3 以降 をご覧ください。

型

Color

グループの色。

列挙型

"グレー"

"青"

"赤"

"黄"

"緑"

"ピンク"

"紫"

"シアン"

"オレンジ"

TabGroup

プロパティ

  • 閉じています

    ブール値

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

  • 色

    色

    グループの色。

  • id

    数値

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

  • title

    文字列（省略可）

    グループのタイトル。

  • windowId

    数値

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

プロパティ

TAB_GROUP_ID_NONE

グループの不在を表す ID。

値

-1

メソッド

get()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

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

パラメータ

  • groupId

    数値

  • callback

    関数（省略可）

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

    (group: TabGroup) => void

戻り値

  • Promise <TabGroup>

    Chrome 90 以降

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

move()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

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

パラメータ

  • groupId

    数値

    移動するグループの ID。

  • moveProperties

    オブジェクト

    • index

      数値

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

    • windowId

      数値（省略可）

      グループの移動先となるウィンドウ。デフォルトでは、グループが現在表示されているウィンドウになります。なお、グループの移動は、windows.WindowType タイプが "normal" のウィンドウ間でのみ可能です。

  • callback

    関数（省略可）

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

    (group?: TabGroup) => void

    • グループ

      TabGroup （省略可）

      移動したグループの詳細。

戻り値

  • Promise<TabGroup |未定義>

    Chrome 90 以降

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

query()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.tabGroups.query(
  queryInfo: object,
  callback?: function,
)

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

パラメータ

  • queryInfo

    オブジェクト

    • 閉じています

      ブール値（省略可）

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

    • 色

      色（省略可）

      グループの色。

    • title

      文字列（省略可）

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

    • windowId

      数値（省略可）

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

  • callback

    関数（省略可）

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

    (result: TabGroup[]) => void

戻り値

  • Promise <TabGroup[]>

    Chrome 90 以降

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

update()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.tabGroups.update(
  groupId: number,
  updateProperties: object,
  callback?: function,
)

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

パラメータ

  • groupId

    数値

    変更するグループの ID。

  • updateProperties

    オブジェクト

    • 閉じています

      ブール値（省略可）

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

    • 色

      色（省略可）

      グループの色。

    • title

      文字列（省略可）

      グループのタイトル。

  • 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