chrome.tabGroups

Description

Utilisez l'API chrome.tabGroups pour interagir avec le système de regroupement d'onglets du navigateur. Vous pouvez utiliser cette API pour modifier et réorganiser les groupes d'onglets du navigateur. Pour regrouper et dissocier des onglets, ou pour demander quels onglets figurent dans des groupes, utilisez l'API chrome.tabs.

Autorisations

tabGroups

Garantie de disponibilité

Chrome 89 ou version ultérieure MV3 ou version ultérieure

Types

Color

Couleur du groupe.

Enum

"grey"

"blue"

"red"

"green"

"cyan"

"orange"

TabGroup

Propriétés

  • réduit

    boolean

    Indique si le groupe est réduit. Un groupe réduit est un groupe dont les onglets sont masqués.

  • couleur

    Couleur

    Couleur du groupe.

  • id

    number

    Identifiant du groupe. Les ID de groupe sont uniques au sein d'une session de navigateur.

  • title

    string facultatif

    Titre du groupe.

  • windowId

    number

    ID de la fenêtre contenant le groupe.

Propriétés

TAB_GROUP_ID_NONE

ID représentant l'absence de groupe.

Valeur

-1

Méthodes

get()

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

Récupère les informations sur le groupe spécifié.

Paramètres

  • groupId

    number

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    (group: TabGroup)=>void

Renvoie

  • Promise<TabGroup>

    Chrome 90 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

move()

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

Déplace le groupe et tous ses onglets dans sa fenêtre ou dans une nouvelle fenêtre.

Paramètres

  • groupId

    number

    Identifiant du groupe à déplacer.

  • moveProperties

    objet

    • index

      number

      Position vers laquelle déplacer le groupe. Utilisez -1 pour placer le groupe à la fin de la fenêtre.

    • windowId

      numéro facultatif

      Fenêtre vers laquelle déplacer le groupe. La valeur par défaut correspond à la fenêtre dans laquelle se trouve le groupe. Notez que les groupes ne peuvent être déplacés vers et depuis des fenêtres qu'avec windows.WindowType de type "normal".

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    (group?: TabGroup)=>void

    • groupe

      TabGroup facultatif

      Informations sur le groupe déplacé.

Renvoie

  • Promise<TabGroup|undefined>

    Chrome 90 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

query()

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

Récupère tous les groupes comportant les propriétés spécifiées, ou tous les groupes si aucune propriété n'est spécifiée.

Paramètres

  • queryInfo

    objet

    • réduit

      Booléen facultatif

      Indique si les groupes sont réduits.

    • couleur

      Couleur facultatif

      Couleur des groupes.

    • title

      string facultatif

      Faire correspondre les titres de groupe à un modèle.

    • windowId

      numéro facultatif

      ID de la fenêtre parent, ou windows.WINDOW_ID_CURRENT pour la fenêtre actuelle.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    (result: TabGroup[])=>void

Renvoie

  • Promise<TabGroup[]>

    Chrome 90 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

update()

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

Modifie les propriétés d'un groupe. Les propriétés qui ne sont pas spécifiées dans updateProperties ne sont pas modifiées.

Paramètres

  • groupId

    number

    ID du groupe à modifier.

  • updateProperties

    objet

    • réduit

      Booléen facultatif

      Indique si le groupe doit être réduit.

    • couleur

      Couleur facultatif

      Couleur du groupe.

    • title

      string facultatif

      Titre du groupe.

  • rappel

    fonction facultative

    Le paramètre callback se présente comme suit : 

    (group?: TabGroup)=>void

    • groupe

      TabGroup facultatif

      Informations sur le groupe mis à jour.

Renvoie

  • Promise<TabGroup|undefined>

    Chrome 90 et versions ultérieures

    Les promesses sont compatibles avec Manifest V3 et les versions ultérieures, mais des rappels sont fournis pour assurer la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse est résolue avec le même type que celui transmis au rappel.

Événements

onCreated

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

Déclenché lors de la création d'un groupe

Paramètres

  • rappel

    function

    Le paramètre callback se présente comme suit : 

    (group: TabGroup)=>void

onMoved

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

Déclenché lorsqu'un groupe est déplacé dans une fenêtre. Les événements de déplacement restent déclenchés pour chaque onglet du groupe, ainsi que pour le groupe lui-même. Cet événement n'est pas déclenché lorsqu'un groupe est déplacé d'une fenêtre à l'autre. Au lieu de cela, il est supprimé d'une fenêtre pour être créé dans une autre.

Paramètres

  • rappel

    function

    Le paramètre callback se présente comme suit : 

    (group: TabGroup)=>void

onRemoved

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

Déclenché lorsqu'un groupe est fermé, soit directement par l'utilisateur, soit automatiquement parce qu'il ne contenait aucun onglet.

Paramètres

  • rappel

    function

    Le paramètre callback se présente comme suit : 

    (group: TabGroup)=>void

onUpdated

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

Déclenché lorsqu'un groupe est mis à jour

Paramètres

  • rappel

    function

    Le paramètre callback se présente comme suit : 

    (group: TabGroup)=>void