browser.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 d'un groupe, utilisez l'API chrome.tabs.

Autorisations

tabGroups

Disponibilité

Chrome 89+ browser.* depuis Chrome 148 MV3+

Types

Color

Couleur du groupe.

Énumération

"grey"

"blue"

"red"

"yellow"

"green"

"pink"

"purple"

"cyan"

"orange"

TabGroup

Propriétés

  • réduite

    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

    nombre

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

  • partagés

    booléen

    Chrome 137+ browser.* depuis Chrome 148

    Indique si le groupe est partagé.

  • titre

    chaîne facultatif

    Titre du groupe.

  • windowId

    nombre

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

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

Récupère les détails du groupe spécifié.

Paramètres

  • groupId

    nombre

Renvoie

  • Promise<TabGroup>

    Chrome 90+ browser.* depuis Chrome 148

move()

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

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

Paramètres

  • groupId

    nombre

    ID du groupe à déplacer.

  • moveProperties

    objet

    • index

      nombre

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

    • windowId

      number facultatif

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

Renvoie

  • Promise<TabGroup | undefined>

    Chrome 90+ browser.* depuis Chrome 148

query()

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

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éduite

      boolean facultatif

      Indique si les groupes sont réduits.

    • couleur

      Couleur facultatif

      Couleur des groupes.

    • partagés

      boolean facultatif

      Chrome 137+ browser.* depuis Chrome 148

      Indique si le groupe est partagé.

    • titre

      chaîne facultatif

      Faire correspondre les titres des groupes à un modèle.

    • windowId

      number facultatif

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

Renvoie

  • // Promise<TabGroup[]>

    Chrome 90+ browser.* depuis Chrome 148

update()

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

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

    nombre

    ID du groupe à modifier.

  • updateProperties

    objet

    • réduite

      boolean facultatif

      Indique si le groupe doit être réduit.

    • couleur

      Couleur facultatif

      Couleur du groupe.

    • titre

      chaîne facultatif

      Titre du groupe.

Renvoie

  • Promise<TabGroup | undefined>

    Chrome 90+ browser.* depuis Chrome 148

Événements

onCreated

browser.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

browser.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. À la place, 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

browser.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

  • callback

    fonction

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

    (group: TabGroup) => void

onUpdated

browser.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