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 à des panneaux existants et ajoutez des barres latérales.

Chaque panneau et chaque barre latérale d'extension s'affichent sous la forme d'une page HTML distincte. Toutes les pages d'extension affichées dans la fenêtre des outils de développement 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). Un seul des gestionnaires installés est appelé au maximum. 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 le résumé des API DevTools pour obtenir une présentation générale de l'utilisation des API DevTools.

Fichier manifeste

Pour utiliser cette API, vous devez déclarer les clés suivantes dans le fichier manifeste.

"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é Propriétés de la police 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 d'icônes d'extension dans la barre d'outils des outils pour les développeurs
Panneau d'icônes d'extension dans la barre d'outils DevTools.

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

Types

Button

Bouton créé par l'extension.

Propriétés

  • onClicked

    Event<functionvoidvoid>

    Déclenché lors d'un clic sur le bouton.

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

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

    • rappel

      fonction

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

      () => void

  • update

    vide

    Met à jour les attributs du bouton. Si certains des arguments sont omis ou 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é

      booléen facultatif

      Indique si le bouton est désactivé.

ElementsPanel

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

Propriétés

  • onSelectionChanged

    Event<functionvoidvoid>

    Déclenché lorsqu'un objet est sélectionné dans le panneau.

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

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

    • rappel

      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, callback?: function) => {...}

    • titre

      chaîne

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

    • rappel

      fonction facultatif

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

      (result: ExtensionSidebarPane) => void

      • Objet ExtensionSidebarPane pour le volet de barre latérale créé.

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) => {...}

    • rappel

      fonction

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

      () => void

  • onSearch

    Event<functionvoidvoid>

    Déclenché lors d'une action de recherche (démarrage 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) => {...}

    • rappel

      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) => {...}

    • rappel

      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. L'icône de droite s'affiche lorsque le bouton est enfoncé.

    • 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é.

ExtensionSidebarPane

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é lorsque l'utilisateur quitte le panneau qui l'héberge.

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

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

    • rappel

      fonction

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

      () => void

  • onShown

    Event<functionvoidvoid>

    Déclenché lorsque le volet de la barre latérale devient visible lorsque l'utilisateur passe au panneau qui l'héberge.

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

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

    • rappel

      fonction

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

      (window: Window) => void

      • fenêtre

        Fenêtre

  • setExpression

    vide

    Définit une expression é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, callback?: function) => {...}

    • 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/la surveillance.

    • rootTitle

      chaîne facultatif

      Titre facultatif de la racine de l'arborescence d'expression.

    • rappel

      fonction facultatif

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

      () => void

  • setHeight

    vide

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

    La fonction setHeight se présente comme suit : 

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

    • hauteur

      chaîne

      Une spécification de taille semblable à 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, callback?: function) => {...}

    • jsonObject

      chaîne

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

    • rootTitle

      chaîne facultatif

      Titre facultatif de la racine de l'arborescence d'expression.

    • rappel

      fonction facultatif

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

      () => void

  • 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 d'accès relatif d'une page d'extension à afficher dans la barre latérale.

SourcesPanel

Représente le panneau "Sources".

Propriétés

  • onSelectionChanged

    Event<functionvoidvoid>

    Déclenché lorsqu'un objet est sélectionné dans le panneau.

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

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

    • rappel

      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, callback?: function) => {...}

    • titre

      chaîne

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

    • rappel

      fonction facultatif

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

      (result: ExtensionSidebarPane) => void

      • Objet ExtensionSidebarPane pour le volet de barre latérale créé.

Propriétés

elements

Panneau "Elements" (Éléments).

Type

ElementsPanel

sources

Panneau "Sources".

Type

SourcesPanel

themeName

Chrome 59 et versions ultérieures

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

Type

chaîne

Méthodes

create()

chrome.devtools.panels.create(
  title: string,
  iconPath: string,
  pagePath: string,
  callback?: function,
)

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

  • rappel

    fonction facultatif

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

    (panel: ExtensionPanel) => void

    • panneau

      ExtensionPanel

      Objet ExtensionPanel représentant le panneau créé.

openResource()

chrome.devtools.panels.openResource(
  url: string,
  lineNumber: number,
  columnNumber?: number,
  callback?: function,
)

Demande aux outils pour les développeurs d'ouvrir une URL dans un panneau des outils pour les développeurs.

Paramètres

  • url

    chaîne

    URL de la ressource à ouvrir.

  • lineNumber

    Nombre

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

  • columnNumber

    number facultatif

    Chrome 114 ou version ultérieure

    Spécifie le numéro de colonne vers lequel faire défiler la ressource lors du chargement.

  • rappel

    fonction facultatif

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

    () => void

setOpenResourceHandler()

chrome.devtools.panels.setOpenResourceHandler(
  callback?: function,
)

Indique la fonction à appeler lorsque l'utilisateur clique sur un lien de ressource dans la fenêtre des outils de développement. Pour ne pas définir le gestionnaire, appelez la méthode sans paramètre ou transmettez la valeur nulle en tant que paramètre.

Paramètres