chrome.tabGroups

Descrição

Use a API chrome.tabGroups para interagir com o sistema de agrupamento de guias do navegador. É possível 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 ou mais recente MV3 ou mais recente

Tipos

Color

A cor do grupo.

Enumeração

"cinza"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

Propriedades

  • fechada

    booleano

    Indica se o grupo está fechado. 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.

  • compartilhados

    booleano

    Pendente

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

Promessa 
chrome.tabGroups.get(
  groupId: number,
  callback?: function,
)

Recupera detalhes sobre o grupo especificado.

Parâmetros

  • groupId

    número

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (group: TabGroup) => void

Retorna

  • Promise<TabGroup>

    Chrome 90 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

move()

Promessa 
chrome.tabGroups.move(
  groupId: number,
  moveProperties: object,
  callback?: function,
)

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

Parâmetros

  • groupId

    número

    O ID do grupo a ser movido.

  • moveProperties

    objeto

    • index

      número

      A posição para mover o grupo. Use -1 para colocar o grupo no final da janela.

    • windowId

      número opcional

      A janela para onde o grupo será movido. Assume a janela em que o grupo está. Os grupos só podem ser movidos para e de janelas com o tipo windows.WindowType "normal".

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (group?: TabGroup) => void

    • grupo

      TabGroup opcional

      Detalhes sobre o grupo movido.

Retorna

  • Promise<TabGroup | undefined>

    Chrome 90 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

query()

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

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

Parâmetros

  • queryInfo

    objeto

    • fechada

      booleano opcional

      Se os grupos estão fechados.

    • cor

      Cor opcional

      A cor dos grupos.

    • compartilhados

      booleano opcional

      Pendente

      Se o grupo é compartilhado.

    • título

      string opcional

      Correlacionar títulos de grupos a um padrão.

    • windowId

      número opcional

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

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: TabGroup[]) => void

Retorna

  • Promise<TabGroup[]>

    Chrome 90 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

update()

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

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

    • fechada

      booleano opcional

      Se o grupo precisa ser recolhido.

    • cor

      Cor opcional

      A cor do grupo.

    • título

      string opcional

      O título do grupo.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (group?: TabGroup) => void

    • grupo

      TabGroup opcional

      Detalhes sobre o grupo atualizado.

Retorna

  • Promise<TabGroup | undefined>

    Chrome 90 e versões mais recentes

    As promessas têm suporte no Manifest V3 e versões mais recentes, mas os callbacks são fornecidos para compatibilidade com versões anteriores. Não é possível usar os dois na mesma chamada de função. A promessa é resolvida com o mesmo tipo transmitido para o callback.

Eventos

onCreated

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

Acionada quando um grupo é criado.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (group: TabGroup) => void

onMoved

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

Acionado quando um grupo é movido dentro de uma janela. Os eventos de movimentação ainda são acionados para as guias individuais dentro do grupo e para o grupo em si. 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 tem este formato: 

    (group: TabGroup) => void

onRemoved

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

Acionada quando um grupo é fechado, seja diretamente pelo usuário ou automaticamente porque não tinha nenhuma guia.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (group: TabGroup) => void

onUpdated

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

É acionado quando um grupo é atualizado.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (group: TabGroup) => void