chrome.action

Description

Utilisez l'API chrome.action pour contrôler l'icône de l'extension dans la barre d'outils Google Chrome.

Les icônes d'action s'affichent dans la barre d'outils du navigateur à côté de la barre multirequêtes. Une fois installées, elles apparaissent dans le menu des extensions (icône en forme de pièce de puzzle). Les utilisateurs peuvent épingler l'icône de votre extension dans la barre d'outils.

Disponibilité

Chrome 88 ou version ultérieure MV3 ou version ultérieure

Fichier manifeste

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

"action"

Pour utiliser l'API chrome.action, spécifiez un "manifest_version" de 3 et incluez la clé "action" dans votre fichier manifeste.

{
  "name": "Action Extension",
  ...
  "action": {
    "default_icon": {              // optional
      "16": "images/icon16.png",   // optional
      "24": "images/icon24.png",   // optional
      "32": "images/icon32.png"    // optional
    },
    "default_title": "Click Me",   // optional, shown in tooltip
    "default_popup": "popup.html"  // optional
  },
  ...
}

La clé "action" (ainsi que ses enfants) est facultative. Si ce n'est pas le cas, votre extension s'affiche toujours dans la barre d'outils pour vous permettre d'accéder à son menu. C'est pourquoi nous vous recommandons de toujours inclure au moins les clés "action" et "default_icon".

Concepts et utilisation

Composants de l'UI

Icône

L'icône est l'image principale de la barre d'outils de votre extension. Elle est définie par la clé "default_icon" dans la clé "action" de votre fichier manifeste. Les icônes doivent mesurer 16 pixels indépendants de l'appareil (DIP) de large et de haut.

La clé "default_icon" est un dictionnaire de tailles et de chemins d'accès aux images. Chrome utilise ces icônes pour choisir l'échelle d'image à utiliser. En l'absence de correspondance exacte, Chrome sélectionne la plus proche disponible et la met à l'échelle pour l'adapter à l'image, ce qui peut affecter la qualité de l'image.

Étant donné que les appareils avec des facteurs de mise à l'échelle moins courants, comme 1,5 fois ou 1,2 fois, sont de plus en plus courants, nous vous encourageons à fournir plusieurs tailles pour vos icônes. Cela permet également de protéger votre extension contre les modifications potentielles de la taille d'affichage des icônes. Toutefois, si vous ne fournissez qu'une seule taille, la clé "default_icon" peut également être définie sur une chaîne avec le chemin d'accès à une seule icône au lieu d'un dictionnaire.

Vous pouvez également appeler action.setIcon() pour définir l'icône de votre extension de manière programmatique en spécifiant un chemin d'image différent ou en fournissant une icône générée dynamiquement à l'aide de l'élément de canevas HTML ou, si vous définissez à partir d'un service worker d'extension, de l'API canevas hors écran.

const canvas = new OffscreenCanvas(16, 16);
const context = canvas.getContext('2d');
context.clearRect(0, 0, 16, 16);
context.fillStyle = '#00FF00';  // Green
context.fillRect(0, 0, 16, 16);
const imageData = context.getImageData(0, 0, 16, 16);
chrome.action.setIcon({imageData: imageData}, () => { /* ... */ });

Pour les extensions empaquetées (installées à partir d'un fichier .crx), les images peuvent être au format de la plupart des éléments que le moteur de rendu Blink peut afficher, y compris PNG, JPEG, BMP, ICO, etc. Le format SVG n'est pas accepté. Les extensions décompressées doivent utiliser des images PNG.

Info-bulle (titre)

L'info-bulle, ou titre, s'affiche lorsque l'utilisateur maintient le pointeur de la souris sur l'icône de l'extension dans la barre d'outils. Il est également inclus dans le texte accessible lu par les lecteurs d'écran lorsque le bouton est sélectionné.

L'info-bulle par défaut est définie à l'aide du champ "default_title" de la clé "action" dans manifest.json. Vous pouvez également le définir par programmation en appelant action.setTitle().

Badge

Les actions peuvent afficher un "badge", c'est-à-dire un peu de texte superposé à l'icône. Vous pouvez ainsi mettre à jour l'action pour afficher une petite quantité d'informations sur l'état de l'extension, comme un compteur. Le badge comporte un composant de texte et une couleur d'arrière-plan. L'espace étant limité, nous vous recommandons de limiter le texte du badge à quatre caractères maximum.

Pour créer un badge, définissez-le par programmation en appelant action.setBadgeBackgroundColor() et action.setBadgeText(). Il n'existe pas de paramètre de badge par défaut dans le fichier manifeste. Les valeurs de couleur du badge peuvent être un tableau de quatre entiers compris entre 0 et 255 qui constituent la couleur RVBA du badge, ou une chaîne avec une valeur de couleur CSS.

chrome.action.setBadgeBackgroundColor(
  {color: [0, 255, 0, 0]},  // Green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: '#00FF00'},  // Also green
  () => { /* ... */ },
);

chrome.action.setBadgeBackgroundColor(
  {color: 'green'},  // Also, also green
  () => { /* ... */ },
);

Une fenêtre pop-up d'action s'affiche lorsque l'utilisateur clique sur le bouton d'action de l'extension dans la barre d'outils. La fenêtre pop-up peut contenir n'importe quel contenu HTML et sera automatiquement redimensionnée pour s'adapter à son contenu. La taille du pop-up doit être comprise entre 25 x 25 et 800 x 600 pixels.

Le pop-up est initialement défini par la propriété "default_popup" dans la clé "action" du fichier manifest.json. Si elle est présente, cette propriété doit pointer vers un chemin d'accès relatif dans le répertoire des extensions. Il peut également être mis à jour de manière dynamique pour pointer vers un autre chemin d'accès relatif à l'aide de la méthode action.setPopup().

Cas d'utilisation

État par onglet

Les actions d'extension peuvent avoir des états différents pour chaque onglet. Pour définir une valeur pour un onglet individuel, utilisez la propriété tabId dans les méthodes de paramétrage de l'API action. Par exemple, pour définir le texte du badge d'un onglet spécifique, procédez comme suit:

function getTabId() { /* ... */}
function getTabBadge() { /* ... */}

chrome.action.setBadgeText(
  {
    text: getTabBadge(tabId),
    tabId: getTabId(),
  },
  () => { ... }
);

Si la propriété tabId est omise, le paramètre est traité comme un paramètre global. Les paramètres spécifiques à l'onglet prévalent sur les paramètres globaux.

État activé

Par défaut, les actions de la barre d'outils sont activées (cliquables) dans chaque onglet. Vous pouvez modifier cette valeur par défaut en définissant la propriété default_state dans la clé action du fichier manifeste. Si default_state est défini sur "disabled", l'action est désactivée par défaut et doit être activée par programmation pour être cliquable. Si default_state est défini sur "enabled" (valeur par défaut), l'action est activée et cliquable par défaut.

Vous pouvez contrôler l'état de manière automatisée à l'aide des méthodes action.enable() et action.disable(). Cela ne concerne que l'envoi du pop-up (le cas échéant) ou de l'événement action.onClicked à votre extension. Cela n'a aucune incidence sur la présence de l'action dans la barre d'outils.

Exemples

Les exemples suivants illustrent certaines manières courantes d'utiliser des actions dans les extensions. Pour essayer cette API, installez l'exemple d'API Action à partir du dépôt chrome-extension-samples.

Afficher un pop-up

Il est courant qu'une extension affiche une fenêtre pop-up lorsque l'utilisateur clique sur l'action de l'extension. Pour implémenter cela dans votre propre extension, déclarez la fenêtre pop-up dans votre manifest.json et spécifiez le contenu que Chrome doit afficher dans la fenêtre pop-up.

// manifest.json
{
  "name": "Action popup demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to view a popup",
    "default_popup": "popup.html"
  }
}

<!-- popup.html -->
<!DOCTYPE html>
<html>
<head>
  <style>
    html {
      min-height: 5em;
      min-width: 10em;
      background: salmon;
    }
  </style>
</head>
<body>
  <p>Hello, world!</p>
</body>
</html>

Injecter un script de contenu lors d'un clic

Un modèle courant pour les extensions consiste à exposer leur fonctionnalité principale à l'aide de l'action de l'extension. L'exemple suivant illustre ce modèle. Lorsque l'utilisateur clique sur l'action, l'extension injecte un script de contenu dans la page en cours. Le script de contenu affiche ensuite une alerte pour vérifier que tout a fonctionné comme prévu.

// manifest.json
{
  "name": "Action script injection demo",
  "version": "1.0",
  "manifest_version": 3,
  "action": {
    "default_title": "Click to show an alert"
  },
  "permissions": ["activeTab", "scripting"],
  "background": {
    "service_worker": "background.js"
  }
}

// background.js
chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    files: ['content.js']
  });
});

// content.js
alert('Hello, world!');

Émuler des actions avec declarativeContent

Cet exemple montre comment la logique en arrière-plan d'une extension peut (a) désactiver une action par défaut et (b) utiliser declarativeContent pour activer l'action sur des sites spécifiques.

// service-worker.js

// Wrap in an onInstalled callback to avoid unnecessary work
// every time the service worker is run
chrome.runtime.onInstalled.addListener(() => {
  // Page actions are disabled by default and enabled on select tabs
  chrome.action.disable();

  // Clear all rules to ensure only our expected rules are set
  chrome.declarativeContent.onPageChanged.removeRules(undefined, () => {
    // Declare a rule to enable the action on example.com pages
    let exampleRule = {
      conditions: [
        new chrome.declarativeContent.PageStateMatcher({
          pageUrl: {hostSuffix: '.example.com'},
        })
      ],
      actions: [new chrome.declarativeContent.ShowAction()],
    };

    // Finally, apply our new array of rules
    let rules = [exampleRule];
    chrome.declarativeContent.onPageChanged.addRules(rules);
  });
});

Types

OpenPopupOptions

Chrome 99 et versions ultérieures

Propriétés

  • windowId

    number facultatif

    ID de la fenêtre dans laquelle ouvrir le pop-up d'action. Si ce champ n'est pas spécifié, la fenêtre active est la valeur par défaut.

TabDetails

Propriétés

  • tabId

    number facultatif

    ID de l'onglet pour lequel interroger l'état. Si aucun onglet n'est spécifié, l'état non spécifique à l'onglet est renvoyé.

UserSettings

Chrome 91 ou version ultérieure

Ensemble de paramètres spécifiés par l'utilisateur concernant l'action d'une extension.

Propriétés

  • isOnToolbar

    booléen

    Indique si l'icône d'action de l'extension est visible dans la barre d'outils de niveau supérieur des fenêtres du navigateur (c'est-à-dire si l'extension a été "épinglée" par l'utilisateur).

UserSettingsChange

Chrome 130 ou version ultérieure

Propriétés

  • isOnToolbar

    booléen facultatif

    Indique si l'icône d'action de l'extension est visible dans la barre d'outils de niveau supérieur des fenêtres du navigateur (c'est-à-dire si l'extension a été "épinglée" par l'utilisateur).

Méthodes

disable()

Promesse 
chrome.action.disable(
  tabId?: number,
  callback?: function,
)

Désactive l'action pour un onglet.

Paramètres

  • tabId

    number facultatif

    ID de l'onglet pour lequel vous souhaitez modifier l'action.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

enable()

Promesse 
chrome.action.enable(
  tabId?: number,
  callback?: function,
)

Active l'action pour un onglet. Par défaut, les actions sont activées.

Paramètres

  • tabId

    number facultatif

    ID de l'onglet pour lequel vous souhaitez modifier l'action.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

getBadgeBackgroundColor()

Promesse 
chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

Récupère la couleur d'arrière-plan de l'action.

Paramètres

  • détails

    TabDetails

  • rappel

    fonction facultatif

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

    (result: ColorArray) => void

Renvoie

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

getBadgeText()

Promesse 
chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

Récupère le texte du badge de l'action. Si aucun onglet n'est spécifié, le texte du badge non spécifique à l'onglet est renvoyé. Si displayActionCountAsBadgeText est activé, un texte d'espace réservé est renvoyé, sauf si l'autorisation declarativeNetRequestFeedback est présente ou si un texte de badge spécifique à l'onglet a été fourni.

Paramètres

  • détails

    TabDetails

  • rappel

    fonction facultatif

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

    (result: string) => void

    • résultat

      chaîne

Renvoie

  • Promise<string>

    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.

getBadgeTextColor()

Promise Chrome 110 et versions ultérieures 
chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

Récupère la couleur du texte de l'action.

Paramètres

  • détails

    TabDetails

  • rappel

    fonction facultatif

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

    (result: ColorArray) => void

Renvoie

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

getPopup()

Promesse 
chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

Récupère le document HTML défini comme fenêtre pop-up pour cette action.

Paramètres

  • détails

    TabDetails

  • rappel

    fonction facultatif

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

    (result: string) => void

    • résultat

      chaîne

Renvoie

  • Promise<string>

    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.

getTitle()

Promesse 
chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

Récupère le titre de l'action.

Paramètres

  • détails

    TabDetails

  • rappel

    fonction facultatif

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

    (result: string) => void

    • résultat

      chaîne

Renvoie

  • Promise<string>

    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.

getUserSettings()

Promise Chrome 91 et versions ultérieures 
chrome.action.getUserSettings(
  callback?: function,
)

Renvoie les paramètres spécifiés par l'utilisateur concernant l'action d'une extension.

Paramètres

  • rappel

    fonction facultatif

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

    (userSettings: UserSettings) => void

Renvoie

  • Promise<UserSettings>

    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.

isEnabled()

Promise Chrome 110 et versions ultérieures 
chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

Indique si l'action de l'extension est activée pour un onglet (ou globalement si aucun tabId n'est fourni). Les actions activées à l'aide de declarativeContent uniquement renvoient toujours la valeur "false".

Paramètres

  • tabId

    number facultatif

    ID de l'onglet dont vous souhaitez vérifier l'état d'activation.

  • rappel

    fonction facultatif

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

    (isEnabled: boolean) => void

    • isEnabled

      booléen

      "True" si l'action de l'extension est activée.

Renvoie

  • Promise<boolean>

    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.

openPopup()

Promise Chrome 127 et versions ultérieures 
chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

Ouvre le pop-up de l'extension. Entre Chrome 118 et Chrome 126, cette fonctionnalité n'est disponible que pour les extensions installées par le biais de règles.

Paramètres

  • options

    OpenPopupOptions facultatif

    Spécifie les options d'ouverture du pop-up.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

setBadgeBackgroundColor()

Promesse 
chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

Définit la couleur de l'arrière-plan du badge.

Paramètres

  • détails

    objet

    • couleur

      chaîne | ColorArray

      Tableau de quatre entiers compris dans la plage [0,255] qui constituent la couleur RVBA du badge. Par exemple, le rouge opaque est [255, 0, 0, 255]. Peut également s'agir d'une chaîne avec une valeur CSS, le rouge opaque étant #FF0000 ou #F00.

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

setBadgeText()

Promesse 
chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

Définit le texte du badge pour l'action. Le badge s'affiche au-dessus de l'icône.

Paramètres

  • détails

    objet

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

    • texte

      chaîne facultatif

      Vous pouvez transmettre un nombre illimité de caractères, mais seuls quatre peuvent tenir dans l'espace. Si une chaîne vide ('') est transmise, le texte du badge est effacé. Si tabId est spécifié et que text est nul, le texte de l'onglet spécifié est effacé et le texte du badge global est utilisé par défaut.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

setBadgeTextColor()

Promise Chrome 110 et versions ultérieures 
chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

Définit la couleur du texte du badge.

Paramètres

  • détails

    objet

    • couleur

      chaîne | ColorArray

      Tableau de quatre entiers compris dans la plage [0,255] qui constituent la couleur RVBA du badge. Par exemple, le rouge opaque est [255, 0, 0, 255]. Peut également s'agir d'une chaîne avec une valeur CSS, le rouge opaque étant #FF0000 ou #F00. Si vous ne définissez pas cette valeur, une couleur sera automatiquement choisie pour contraster avec la couleur d'arrière-plan du badge afin que le texte soit visible. Les couleurs dont les valeurs alpha sont équivalentes à 0 ne seront pas définies et une erreur sera renvoyée.

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

setIcon()

Promesse 
chrome.action.setIcon(
  details: object,
  callback?: function,
)

Définit l'icône de l'action. L'icône peut être spécifiée sous la forme du chemin d'accès à un fichier image ou des données de pixel d'un élément de canevas, ou sous la forme d'un dictionnaire de l'un de ces éléments. Vous devez spécifier la propriété path ou imageData.

Paramètres

  • détails

    objet

    • imageData

      ImageData | objet facultatif

      Objet ImageData ou dictionnaire {size -> ImageData} représentant l'icône à définir. Si l'icône est spécifiée en tant que dictionnaire, l'image réelle à utiliser est choisie en fonction de la densité de pixels de l'écran. Si le nombre de pixels de l'image qui s'intègre dans une unité d'espace d'écran est égal à scale, l'image de taille scale * n est sélectionnée, où n correspond à la taille de l'icône dans l'UI. Vous devez spécifier au moins une image. Notez que "details.imageData = foo" est équivalent à "details.imageData = {'16': foo}".

    • chemin d'accès

      chaîne | objet facultatif

      Chemin d'accès à une image relatif ou dictionnaire {taille -> chemin d'accès à une image relatif} pointant vers l'icône à définir. Si l'icône est spécifiée en tant que dictionnaire, l'image réelle à utiliser est choisie en fonction de la densité de pixels de l'écran. Si le nombre de pixels de l'image qui s'intègre dans une unité d'espace d'écran est égal à scale, l'image de taille scale * n est sélectionnée, où n correspond à la taille de l'icône dans l'UI. Vous devez spécifier au moins une image. Notez que "details.path = foo" est équivalent à "details.path = {'16': foo}".

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 96 ou version ultérieure

    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.

setPopup()

Promesse 
chrome.action.setPopup(
  details: object,
  callback?: function,
)

Définit le document HTML à ouvrir en tant que fenêtre pop-up lorsque l'utilisateur clique sur l'icône de l'action.

Paramètres

  • détails

    objet

    • pop-up

      chaîne

      Chemin d'accès relatif au fichier HTML à afficher dans une fenêtre pop-up. Si elle est définie sur la chaîne vide (''), aucun pop-up ne s'affiche.

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

setTitle()

Promesse 
chrome.action.setTitle(
  details: object,
  callback?: function,
)

Définit le titre de l'action. Cette information s'affiche dans l'info-bulle.

Paramètres

  • détails

    objet

    • tabId

      number facultatif

      Limite la modification à un onglet particulier. Réinitialise automatiquement lorsque l'onglet est fermé.

    • titre

      chaîne

      Chaîne que l'action doit afficher lorsque vous pointez dessus.

  • rappel

    fonction facultatif

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

    () => void

Renvoie

  • Promise<void>

    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.

Événements

onClicked

chrome.action.onClicked.addListener(
  callback: function,
)

Déclenché lorsqu'un utilisateur clique sur une icône d'action. Cet événement ne se déclenche pas si l'action comporte une fenêtre pop-up.

Paramètres

  • rappel

    fonction

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

    (tab: tabs.Tab) => void

onUserSettingsChanged

Chrome 130 ou version ultérieure 
chrome.action.onUserSettingsChanged.addListener(
  callback: function,
)

Déclenché lorsque les paramètres spécifiés par l'utilisateur concernant l'action d'une extension changent.

Paramètres