chrome.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 para consultar quais guias estão em grupos, use a API chrome.tabs.

Permissões

tabGroups

Disponibilidade

Chrome 89 ou superior MV3

Tipos

Color

A cor do grupo.

Enumeração

"cinza"

"azul"

"vermelho"

"amarelo"

"verde"

"rosa"

"roxo"

"ciano"

"laranja"

TabGroup

Propriedades

  • fechada

    booleano

    Indica se o grupo está recolhido. Os grupos recolhidos têm guias ocultas.

  • cor

    Cor

    A cor do grupo.

  • id

    number

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

  • título

    string opcional

    O título do grupo.

  • windowId

    number

    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

Menos de 1

Métodos

get()

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

Recupera detalhes sobre o grupo especificado.

Parâmetros

  • groupId

    number

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (group: TabGroup) => void

Retorna

  • Promessa<TabGroup>

    Chrome 90 ou superior

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

move()

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

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

Parâmetros

  • groupId

    number

    O ID do grupo a ser movido.

  • moveProperties

    objeto

    • index

      number

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

    • windowId

      número opcional

      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 o windows.WindowType tipo "normal".

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (group?: TabGroup) => void

    • grupo

      TabGroup opcional

      Detalhes sobre o grupo movido.

Retorna

  • Promessa<TabGroup | indefinido>

    Chrome 90 ou superior

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

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

      Indica se os grupos estão recolhidos.

    • cor

      Cor opcional

      A cor dos grupos.

    • título

      string opcional

      Associe os títulos do grupo a um padrão.

    • windowId

      número opcional

      O ID da janela mãe ou windows.WINDOW_ID_CURRENT da janela atual.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (result: TabGroup[]) => void

Retorna

  • Promessa<TabGroup[]>

    Chrome 90 ou superior

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

update()

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

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

Parâmetros

  • groupId

    number

    O ID do grupo a ser modificado.

  • updateProperties

    objeto

    • fechada

      booleano opcional

      Se o grupo deve 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 esta aparência: 

    (group?: TabGroup) => void

    • grupo

      TabGroup opcional

      Detalhes sobre o grupo atualizado.

Retorna

  • Promessa<TabGroup | indefinido>

    Chrome 90 ou superior

    O Manifesto V3 e versões mais recentes oferecem suporte a promessas, mas callbacks são fornecidos para a compatibilidade com versões anteriores. Não é possível usar ambos na mesma chamada de função. A promessa é resolvida com o mesmo tipo passado ao retorno de chamada.

Eventos

onCreated

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

Disparado quando um grupo é criado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (group: TabGroup) => void

onMoved

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

Disparado quando um grupo é movido dentro de uma janela. Os eventos de movimentação ainda são disparados para as guias individuais dentro do grupo, assim como para o próprio grupo. Este evento não é acionado quando um grupo é movido entre janelas. ele será removido de uma janela e criado em outra.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (group: TabGroup) => void

onRemoved

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

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

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (group: TabGroup) => void

onUpdated

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

Disparado quando um grupo é atualizado.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (group: TabGroup) => void