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 dans le navigateur. Pour regrouper et dissocier des onglets, ou pour interroger les onglets appartenant à des groupes, utilisez l'API chrome.tabs.

Autorisations

tabGroups

Disponibilité

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

Types

Color

Couleur du groupe.

Énumération

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

Propriétés

  • réduit

    booléen

    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

    Total

    ID du groupe. Les ID de groupe sont uniques dans une session de navigateur.

  • partagés

    booléen

    En attente

    Indique si le groupe est partagé.

  • titre

    chaîne facultatif

    Titre du groupe.

  • windowId

    Total

    ID de la fenêtre contenant le groupe.

Propriétés

TAB_GROUP_ID_NONE

ID représentant l'absence d'un 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

    Total

  • callback

    fonction facultatif

    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 la version 3 du fichier manifeste 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 se résout 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

    Total

    ID du groupe à déplacer.

  • moveProperties

    objet

    • index

      Total

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

    • windowId

      number facultatif

      Fenêtre vers laquelle déplacer le groupe. Par défaut, la fenêtre dans laquelle se trouve le groupe est utilisée. Notez que les groupes ne peuvent être déplacés que vers et depuis des fenêtres de type "normal" avec windows.WindowType.

  • callback

    fonction facultatif

    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 la version 3 du fichier manifeste 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 se résout 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 qui possèdent 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.

    • partagés

      booléen facultatif

      En attente

      Indique si le groupe est partagé.

    • titre

      chaîne facultatif

      Faire correspondre les titres de groupe à un modèle

    • windowId

      number facultatif

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

  • callback

    fonction facultatif

    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 la version 3 du fichier manifeste 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 se résout 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

    Total

    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.

    • titre

      chaîne facultatif

      Titre du groupe.

  • callback

    fonction facultatif

    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 la version 3 du fichier manifeste et les versions ultérieures, mais des rappels sont fournis pour la rétrocompatibilité. Vous ne pouvez pas utiliser les deux dans le même appel de fonction. La promesse se résout avec le même type que celui transmis au rappel.

Événements

onCreated

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

Déclenché lorsqu'un groupe est créé.

Paramètres

  • callback

    fonction

    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 sont toujours déclenchés pour les onglets individuels 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 à une autre. Il est supprimé d'une fenêtre et créé dans une autre.

Paramètres

  • callback

    fonction

    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, car il ne contenait aucun onglet.

Paramètres

  • callback

    fonction

    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

  • callback

    fonction

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

    (group: TabGroup) => void