chrome.devtools.panels

Description

Utilisez l'API chrome.devtools.panels pour intégrer votre extension à l'interface utilisateur de la fenêtre des outils pour les développeurs : créez vos propres panneaux, accédez aux panneaux existants et ajoutez des barres latérales.

Chaque panneau d'extension et barre latérale s'affiche sous la forme d'une page HTML distincte. Toutes les pages d'extension affichées dans la fenêtre des outils pour les développeurs ont accès à toutes les parties de l'API chrome.devtools, ainsi qu'à toutes les autres API d'extension.

Vous pouvez utiliser la méthode devtools.panels.setOpenResourceHandler pour installer une fonction de rappel qui gère les requêtes des utilisateurs pour ouvrir une ressource (généralement, un clic sur un lien de ressource dans la fenêtre des outils pour les développeurs). Au maximum, un seul des gestionnaires installés est appelé. Les utilisateurs peuvent spécifier (à l'aide de la boîte de dialogue "Paramètres des outils pour les développeurs") le comportement par défaut ou une extension pour gérer les requêtes d'ouverture de ressources. Si une extension appelle setOpenResourceHandler() plusieurs fois, seul le dernier gestionnaire est conservé.

Consultez Résumé des API DevTools pour une présentation générale de l'utilisation des API des outils pour les développeurs.

Fichier manifeste

Les clés suivantes doivent être déclarées dans le fichier manifeste pour utiliser cette API.

"devtools_page"

Exemple

Le code suivant ajoute un panneau contenu dans Panel.html, représenté par FontPicker.png dans la barre d'outils des outils pour les développeurs et intitulé Sélecteur de police :

chrome.devtools.panels.create("Font Picker",
                              "FontPicker.png",
                              "Panel.html",
                              function(panel) { ... });

Le code suivant ajoute un volet de barre latérale contenu dans Sidebar.html et intitulé Font Properties au panneau "Éléments", puis définit sa hauteur sur 8ex :

chrome.devtools.panels.elements.createSidebarPane("Font Properties",
  function(sidebar) {
    sidebar.setPage("Sidebar.html");
    sidebar.setHeight("8ex");
  }
);

La capture d'écran illustre l'effet de cet exemple sur la fenêtre des outils pour les développeurs :

Panneau de l'icône d'extension dans la barre d'outils des outils de développement
Panneau d'icônes d'extension dans la barre d'outils des outils de développement

Pour essayer cette API, installez l'exemple d'API de panneaux des outils de développement à partir du dépôt chrome-extension-samples.

Types

Button

Un bouton créé par l'extension.

Propriétés

  • onClicked

    Event<functionvoidvoid>

    Déclenché lorsque l'utilisateur clique sur le bouton.

    La fonction onClicked.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      () => void

  • update

    vide

    Met à jour les attributs du bouton. Si certains arguments sont omis ou définis sur null, les attributs correspondants ne sont pas mis à jour.

    La fonction update se présente comme suit : 

    (iconPath?: string, tooltipText?: string, disabled?: boolean) => {...}

    • iconPath

      chaîne facultatif

      Chemin d'accès à la nouvelle icône du bouton.

    • tooltipText

      chaîne facultatif

      Texte affiché sous forme d'info-bulle lorsque l'utilisateur pointe sur le bouton.

    • désactivé

      boolean facultatif

      Indique si le bouton est désactivé.

ElementsPanel

Représente le panneau "Éléments".

Propriétés

  • onSelectionChanged

    Event<functionvoidvoid>

    Se déclenche lorsqu'un objet est sélectionné dans le panneau.

    La fonction onSelectionChanged.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      () => void

  • createSidebarPane

    vide

    Crée un volet dans la barre latérale du panneau.

    La fonction createSidebarPane se présente comme suit : 

    (title: string) => {...}

    • titre

      chaîne

      Texte affiché dans la légende de la barre latérale.

    • Renvoie

      Promise<ExtensionSidebarPane>

      Chrome 152 ou version ultérieure

      Rappel appelé lors de la création de la barre latérale.

ExtensionPanel

Représente un panneau créé par une extension.

Propriétés

  • onHidden

    Event<functionvoidvoid>

    Déclenché lorsque l'utilisateur quitte le panneau.

    La fonction onHidden.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      () => void

  • onSearch

    Event<functionvoidvoid>

    Déclenché lors d'une action de recherche (début d'une nouvelle recherche, navigation dans les résultats de recherche ou annulation de la recherche).

    La fonction onSearch.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      (action: string, queryString?: string) => void

      • action

        chaîne

      • queryString

        chaîne facultatif

  • onShown

    Event<functionvoidvoid>

    Déclenché lorsque l'utilisateur passe au panneau.

    La fonction onShown.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      (window: Window) => void

      • fenêtre

        Fenêtre

  • createStatusBarButton

    vide

    Ajoute un bouton à la barre d'état du panneau.

    La fonction createStatusBarButton se présente comme suit : 

    (iconPath: string, tooltipText: string, disabled: boolean) => {...}

    • iconPath

      chaîne

      Chemin d'accès à l'icône du bouton. Le fichier doit contenir une image de 64 x 24 pixels composée de deux icônes de 32 x 24 pixels. L'icône de gauche est utilisée lorsque le bouton est inactif, tandis que l'icône de droite s'affiche lorsque l'utilisateur appuie sur le bouton.

    • tooltipText

      chaîne

      Texte affiché sous forme d'info-bulle lorsque l'utilisateur pointe sur le bouton.

    • désactivé

      booléen

      Indique si le bouton est désactivé.

  • afficher

    vide

    Navigateur Chrome 140+ * depuis Chrome 152

    Affiche le panneau en activant l'onglet correspondant.

    La fonction show se présente comme suit : 

    () => {...}

ExtensionSidebarPane

Une barre latérale créée par l'extension.

Propriétés

  • onHidden

    Event<functionvoidvoid>

    Déclenché lorsque le volet de la barre latérale est masqué parce que l'utilisateur quitte le panneau qui l'héberge.

    La fonction onHidden.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      () => void

  • onShown

    Event<functionvoidvoid>

    Se déclenche lorsque le volet de la barre latérale devient visible, car l'utilisateur passe au panneau qui l'héberge.

    La fonction onShown.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      (window: Window) => void

      • fenêtre

        Fenêtre

  • setExpression

    vide

    Définit une expression qui est évaluée dans la page inspectée. Le résultat s'affiche dans le volet de la barre latérale.

    La fonction setExpression se présente comme suit : 

    (expression: string, rootTitle?: string) => {...}

    • expression

      chaîne

      Expression à évaluer dans le contexte de la page inspectée. Les objets JavaScript et les nœuds DOM sont affichés dans une arborescence extensible semblable à la console/surveillance.

    • rootTitle

      chaîne facultatif

      Titre facultatif pour la racine de l'arborescence d'expressions.

    • Renvoie

      Promise<void>

      Chrome 152 ou version ultérieure

      Rappel appelé après la mise à jour du volet de la barre latérale avec les résultats de l'évaluation de l'expression.

  • setHeight

    vide

    Définit la hauteur de la barre latérale.

    La fonction setHeight se présente comme suit : 

    (height: string) => {...}

    • height

      chaîne

      Spécification de taille de type CSS, telle que '100px' ou '12ex'.

  • setObject

    vide

    Définit un objet conforme au format JSON à afficher dans le volet de la barre latérale.

    La fonction setObject se présente comme suit : 

    (jsonObject: string, rootTitle?: string) => {...}

    • jsonObject

      chaîne

      Objet à afficher dans le contexte de la page inspectée. Évalué dans le contexte de l'appelant (client API).

    • rootTitle

      chaîne facultatif

      Titre facultatif pour la racine de l'arborescence d'expressions.

    • Renvoie

      Promise<void>

      Chrome 152 ou version ultérieure

      Rappel invoqué après la mise à jour de la barre latérale avec l'objet.

  • setPage

    vide

    Définit une page HTML à afficher dans le volet de la barre latérale.

    La fonction setPage se présente comme suit : 

    (path: string) => {...}

    • chemin d'accès

      chaîne

      Chemin relatif d'une page d'extension à afficher dans la barre latérale.

SourcesPanel

Représente le panneau "Sources".

Propriétés

  • onSelectionChanged

    Event<functionvoidvoid>

    Se déclenche lorsqu'un objet est sélectionné dans le panneau.

    La fonction onSelectionChanged.addListener se présente comme suit : 

    (callback: function) => {...}

    • callback

      fonction

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

      () => void

  • createSidebarPane

    vide

    Crée un volet dans la barre latérale du panneau.

    La fonction createSidebarPane se présente comme suit : 

    (title: string) => {...}

    • titre

      chaîne

      Texte affiché dans la légende de la barre latérale.

    • Renvoie

      Promise<ExtensionSidebarPane>

      Chrome 152 ou version ultérieure

      Rappel appelé lors de la création de la barre latérale.

Theme

Navigateur Chrome 99 ou version ultérieure * depuis Chrome 152

Thème utilisé par les outils de développement.

Énumération

"default"
Thème par défaut des outils de développement. Il s'agit toujours du thème clair.

"dark"
Thème sombre.

Propriétés

elements

Panneau "Éléments".

Type

ElementsPanel

sources

Panneau "Sources".

Type

SourcesPanel

themeName

Navigateur Chrome 59 ou version ultérieure * depuis Chrome 152

Nom du thème de couleur défini dans les paramètres des outils de développement de l'utilisateur. Valeurs possibles : default (par défaut) et dark.

Type

chaîne

Méthodes

create()

browser.devtools.panels.create(
  title: string,
  iconPath: string,
  pagePath: string,
): Promise<ExtensionPanel>

Crée un panneau d'extension.

Paramètres

  • titre

    chaîne

    Titre affiché à côté de l'icône de l'extension dans la barre d'outils des outils pour les développeurs.

  • iconPath

    chaîne

    Chemin d'accès de l'icône du panneau par rapport au répertoire de l'extension.

  • pagePath

    chaîne

    Chemin d'accès de la page HTML du panneau par rapport au répertoire de l'extension.

Renvoie

  • Promise<ExtensionPanel>

    Chrome 152 ou version ultérieure

    Fonction appelée lors de la création du panneau.

openResource()

browser.devtools.panels.openResource(
  url: string,
  lineNumber: number,
  columnNumber?: number,
): Promise<void>

Demande aux outils de développement d'ouvrir une URL dans un panneau des outils de développement.

Paramètres

  • url

    chaîne

    URL de la ressource à ouvrir.

  • lineNumber

    nombre

    Spécifie le numéro de ligne vers lequel faire défiler l'écran lorsque la ressource est chargée.

  • columnNumber

    number facultatif

    Navigateur Chrome 114 ou version ultérieure * depuis Chrome 152

    Spécifie le numéro de colonne vers lequel faire défiler l'écran lorsque la ressource est chargée.

Renvoie

  • Promise<void>

    Chrome 152 ou version ultérieure

    Fonction appelée lorsque la ressource a bien été chargée.

setOpenResourceHandler()

browser.devtools.panels.setOpenResourceHandler(
  callback?: function,
): void

Spécifie la fonction à appeler lorsque l'utilisateur clique sur un lien de ressource dans la fenêtre des outils pour les développeurs. Pour annuler la définition du gestionnaire, appelez la méthode sans paramètre ou transmettez "null" comme paramètre.

Paramètres

  • callback

    function facultatif

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

    (resource: Resource, lineNumber: number) => void

    • ressource

      Ressource

      Un objet devtools.inspectedWindow.Resource pour la ressource sur laquelle l'utilisateur a cliqué.

    • lineNumber

      nombre

      Spécifie le numéro de ligne de la ressource sur laquelle l'utilisateur a cliqué.

setThemeChangeHandler()

Navigateur Chrome 99 ou version ultérieure * depuis Chrome 152 
browser.devtools.panels.setThemeChangeHandler(
  callback?: function,
): void

Spécifie la fonction à appeler lorsque le thème actuel change dans les outils de développement. Pour annuler la définition du gestionnaire, appelez la méthode sans paramètre ou transmettez null en tant que paramètre.

Paramètres

  • callback

    function facultatif

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

    (theme: Theme) => void

    • thème

      Thème

      Thème actuel dans les outils de développement.