browser.tabGroups

説明

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

権限

tabGroups

対象

Chrome 89 以降 Chrome 148 以降の browser.* MV3 以降

型

Color

グループの色。

列挙型

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

プロパティ

  • 閉じています

    ブール値

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

  • 色

    色

    グループの色。

  • id

    数値

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

  • 共有

    ブール値

    Chrome 137 以降 Chrome 148 以降の browser.*

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

  • title

    文字列 省略可

    グループのタイトル。

  • windowId

    数値

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

プロパティ

TAB_GROUP_ID_NONE

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

値

-1

メソッド

get()

browser.tabGroups.get(
  groupId: number,
): Promise<TabGroup>

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

パラメータ

  • groupId

    数値

戻り値

  • Promise<TabGroup>

    Chrome 90 以降 Chrome 148 以降の browser.*

move()

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

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

パラメータ

  • groupId

    数値

    移動するグループの ID。

  • moveProperties

    オブジェクト

    • index

      数値

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

    • windowId

      number 省略可

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

戻り値

  • Promise<TabGroup | undefined>

    Chrome 90 以降 Chrome 148 以降の browser.*

query()

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

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

パラメータ

  • queryInfo

    オブジェクト

    • 閉じています

      boolean 省略可

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

    • 色

      Color 省略可

      グループの色。

    • 共有

      boolean 省略可

      Chrome 137 以降 Chrome 148 以降の browser.*

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

    • title

      文字列 省略可

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

    • windowId

      number 省略可

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

戻り値

  • Promise<TabGroup[]>

    Chrome 90 以降 Chrome 148 以降の browser.*

update()

browser.tabGroups.update(
  groupId: number,
  updateProperties: object,
): Promise<TabGroup | undefined>

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

パラメータ

  • groupId

    数値

    変更するグループの ID。

  • updateProperties

    オブジェクト

    • 閉じています

      boolean 省略可

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

    • 色

      Color 省略可

      グループの色。

    • title

      文字列 省略可

      グループのタイトル。

戻り値

  • Promise<TabGroup | undefined>

    Chrome 90 以降 Chrome 148 以降の browser.*

イベント

onCreated

browser.tabGroups.onCreated.addListener(
  callback: function,
)

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

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void

onMoved

browser.tabGroups.onMoved.addListener(
  callback: function,
)

グループがウィンドウ内で移動されたときに呼び出されます。移動イベントは、グループ自体だけでなく、グループ内の個々のタブでも引き続き発生します。このイベントは、グループがウィンドウ間で移動されたときには発生しません。代わりに、1 つのウィンドウから削除され、別のウィンドウで作成されます。

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void

onRemoved

browser.tabGroups.onRemoved.addListener(
  callback: function,
)

ユーザーが直接、またはタブが 0 個になったために自動的に、グループが閉じられたときに呼び出されます。

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void

onUpdated

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

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

パラメータ

  • callback

    関数

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

    (group: TabGroup) => void