browser.tabGroups

Описание

Используйте chrome.tabGroups API для взаимодействия с системой группировки вкладок браузера. С помощью этого API можно изменять и переупорядочивать группы вкладок в браузере. Чтобы группировать вкладки, отменять группировку или запрашивать, какие вкладки находятся в группах, используйте chrome.tabs API.

Разрешения

tabGroups

Доступность

Chrome 89+ browser.* начиная с Chrome 148 MV3+

Типы

Color

Цвет группы.

Перечисление

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

Свойства

  • свернуто

    Логическое значение

    Свернута ли группа. В свернутой группе вкладок не видно.

  • цвет

    Цвет

    Цвет группы.

  • id

    число

    Идентификатор группы. Идентификаторы групп уникальны в рамках сеанса браузера.

  • Совместный

    Логическое значение

    Chrome 137 и более поздних версий browser.* начиная с Chrome 148

    Общий ли доступ у группы.

  • название

    Строка (необязательно)

    Название группы.

  • windowId

    число

    Идентификатор окна, в котором находится группа.

Свойства

TAB_GROUP_ID_NONE

Идентификатор, который указывает на отсутствие группы.

Значение

-1

Методы

get()

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

Получает сведения об указанной группе.

Параметры

  • groupId

    число

Возвраты

  • Promise<TabGroup>

    Chrome 90 и более поздних версий browser.* начиная с Chrome 148

move()

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

Перемещает группу и все ее вкладки в пределах окна или в новое окно.

Параметры

  • groupId

    число

    Идентификатор группы, которую нужно переместить.

  • moveProperties

    Объект

    • индекс

      число

      Позиция, на которую нужно переместить группу. Чтобы разместить группу в конце окна, используйте -1.

    • windowId

      number (необязательно)

      Окно, в которое нужно переместить группу. По умолчанию используется окно, в котором сейчас находится группа. Обратите внимание, что группы можно перемещать только в окна и из окон с типом "normal" (windows.WindowType).

Возвраты

  • Promise<TabGroup | undefined>

    Chrome 90 и более поздних версий browser.* начиная с Chrome 148

query()

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

Возвращает все группы с указанными свойствами или все группы, если свойства не указаны.

Параметры

  • queryInfo

    Объект

    • свернуто

      Логическое значение (необязательно)

      Свернуты ли группы.

    • цвет

      Цвет необязательно

      Цвет групп.

    • Совместный

      Логическое значение (необязательно)

      Chrome 137 и более поздних версий browser.* начиная с Chrome 148

      Общий ли доступ у группы.

    • название

      Строка (необязательно)

      Сопоставлять названия групп с шаблоном.

    • windowId

      number (необязательно)

      Идентификатор родительского окна или windows.WINDOW_ID_CURRENT для текущего окна.

Возвраты

  • Promise<TabGroup[]>

    Chrome 90 и более поздних версий browser.* начиная с Chrome 148

update()

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

Изменяет свойства группы. Свойства, не указанные в updateProperties, не изменяются.

Параметры

  • groupId

    число

    Идентификатор группы, которую нужно изменить.

  • updateProperties

    Объект

    • свернуто

      Логическое значение (необязательно)

      Указывает, должна ли группа быть свернута.

    • цвет

      Цвет необязательно

      Цвет группы.

    • название

      Строка (необязательно)

      Название группы.

Возвраты

  • Promise<TabGroup | undefined>

    Chrome 90 и более поздних версий browser.* начиная с Chrome 148

События

onCreated

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

Срабатывает при создании группы.

Параметры

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (group: TabGroup) => void

onMoved

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

Срабатывает, когда группа перемещается в пределах окна. События перемещения по-прежнему запускаются для отдельных вкладок в группе, а также для самой группы. Это событие не активируется, когда группа перемещается между окнами. Вместо этого она удаляется из одного окна и создается в другом.

Параметры

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (group: TabGroup) => void

onRemoved

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

Срабатывает, когда группа закрывается пользователем или автоматически, если в ней нет вкладок.

Параметры

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (group: TabGroup) => void

onUpdated

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

Срабатывает при обновлении группы.

Параметры

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (group: TabGroup) => void