browser.tabGroups

Descrição

Use a API chrome.tabGroups para interagir com o sistema de agrupamento de guias do navegador. Você pode usar essa API para modificar e reorganizar grupos de guias no navegador. Para agrupar e desagrupar guias ou consultar quais guias estão em grupos, use a API chrome.tabs.

Permissões

tabGroups

Disponibilidade

Chrome 89+ browser.* desde o Chrome 148 MV3+

Tipos

Color

A cor do grupo.

Enumeração

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

Propriedades

  • recolhida

    booleano

    Se o grupo está recolhido. Um grupo recolhido é aquele em que as guias estão ocultas.

  • cor

    Cor

    A cor do grupo.

  • ID

    número

    ID do grupo. Os IDs de grupo são exclusivos em uma sessão do navegador.

  • compartilhada

    booleano

    Chrome 137+ browser.* desde o Chrome 148

    Se o grupo é compartilhado.

  • título

    string opcional

    O título do grupo.

  • windowId

    número

    O ID da janela que contém o grupo.

Propriedades

TAB_GROUP_ID_NONE

Um ID que representa a ausência de um grupo.

Valor

-1

Métodos

get()

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

Recupera detalhes sobre o grupo especificado.

Parâmetros

  • groupId

    número

Retorna

  • Promise<TabGroup>

    Chrome 90+ browser.* desde o Chrome 148

move()

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

Move o grupo e todas as guias dele dentro da janela ou para uma nova janela.

Parâmetros

  • groupId

    número

    O ID do grupo que será movido.

  • moveProperties

    objeto

    • índice

      número

      A posição para onde o grupo será movido. Use -1 para colocar o grupo no final da janela.

    • windowId

      número optional

      A janela para onde o grupo será movido. O padrão é a janela em que o grupo está no momento. Os grupos só podem ser movidos de e para janelas com windows.WindowType do tipo "normal".

Retorna

  • Promise<TabGroup | undefined>

    Chrome 90+ browser.* desde o Chrome 148

query()

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

Recebe todos os grupos que têm as propriedades especificadas ou todos os grupos se nenhuma propriedade for especificada.

Parâmetros

  • queryInfo

    objeto

    • recolhida

      booleano opcional

      Se os grupos estão recolhidos.

    • cor

      Cor opcional

      A cor dos grupos.

    • compartilhada

      booleano opcional

      Chrome 137+ browser.* desde o Chrome 148

      Se o grupo é compartilhado.

    • título

      string opcional

      Corresponda os títulos dos grupos a um padrão.

    • windowId

      número optional

      O ID da janela pai ou windows.WINDOW_ID_CURRENT para a janela atual.

Retorna

  • Promise<TabGroup[]>

    Chrome 90+ browser.* desde o Chrome 148

update()

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

Modifica as propriedades de um grupo. As propriedades que não são especificadas em updateProperties não são modificadas.

Parâmetros

  • groupId

    número

    O ID do grupo a ser modificado.

  • updateProperties

    objeto

    • recolhida

      booleano opcional

      Se o grupo deve ser recolhido.

    • cor

      Cor opcional

      A cor do grupo.

    • título

      string opcional

      O título do grupo.

Retorna

  • Promise<TabGroup | undefined>

    Chrome 90+ browser.* desde o Chrome 148

Eventos

onCreated

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

Acionado quando um grupo é criado.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (group: TabGroup) => void

onMoved

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

Acionado quando um grupo é movido em uma janela. Os eventos de movimentação ainda são acionados para as guias individuais dentro do grupo, bem como para o próprio grupo. Esse evento não é acionado quando um grupo é movido entre janelas. Em vez disso, ele é removido de uma janela e criado em outra.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (group: TabGroup) => void

onRemoved

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

Disparado quando um grupo é fechado, seja diretamente pelo usuário ou automaticamente porque não continha guias.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (group: TabGroup) => void

onUpdated

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

Acionado quando um grupo é atualizado.

Parâmetros

  • callback

    função

    O parâmetro callback é semelhante a: 

    (group: TabGroup) => void