chrome.action

Description

Garantie de disponibilité

Manifest

Pour utiliser l'API chrome.action, spécifiez un "manifest_version" 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" (avec ses enfants) est facultative. Si l'extension n'est pas incluse, elle reste affichée dans la barre d'outils pour permettre d'accéder au menu de l'extension. C'est pourquoi nous vous recommandons de toujours inclure au moins les clés "action" et "default_icon".

Concepts et utilisation

Composantes de l'interface utilisateur

Icon

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 avoir une largeur et une hauteur de 16 pixels indépendants des appareils (DIP).

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. Si aucune correspondance exacte n'est trouvée, Chrome sélectionne la version disponible la plus proche et l'adapte à l'image, ce qui peut affecter la qualité de l'image.

Étant donné que les appareils avec des facteurs de scaling moins courants, tels que 1,5 ou 1,2x, deviennent de plus en plus courants, nous vous encourageons à fournir plusieurs tailles d'icônes. Cela permet également de protéger votre extension contre d'éventuels changements de 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 autre chemin d'accès à l'image ou en fournissant une icône générée dynamiquement à l'aide de l'élément de canevas HTML ou, si vous le définissez à partir d'un service worker d'extension, de l'API hors écran canvas.

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 dans la plupart des formats que le moteur de rendu Blink peut afficher, y compris PNG, JPEG, BMP, ICO, etc. Le format SVG n'est pas compatible. Les extensions non empaquetées doivent utiliser des images PNG.

Info-bulle (titre)

L'info-bulle, ou titre, apparaît 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 prononcé 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 la définir par programmation en appelant action.setTitle().

Badge

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

Pour créer un badge, définissez-le par programmation en appelant action.setBadgeBackgroundColor() et action.setBadgeText(). Le fichier manifeste ne contient pas de paramètre de badge par défaut. 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
  () => { /* ... */ },
);

Fenêtre pop-up

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

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

Cas d'utilisation

État par onglet

Les actions d'extension peuvent avoir différents états pour chaque onglet. Pour définir la valeur d'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 pour 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 n'est pas définie, le paramètre est considéré comme un paramètre global. Les paramètres propres aux onglets sont prioritaires sur les paramètres généraux.

État d'activation

Par défaut, les actions de la barre d'outils sont activées (cliquables) dans chaque onglet. Vous pouvez contrôler cela à l'aide des méthodes action.enable() et action.disable(). Cela n'affecte que l'envoi du pop-up (le cas échéant) ou de l'événement action.onClicked à votre extension. Cela n'affecte pas la présence de l'action dans la barre d'outils.

Exemples

Les exemples suivants illustrent des utilisations courantes 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 fréquent qu'une extension affiche une fenêtre pop-up lorsque l'utilisateur clique sur l'action associée. Pour implémenter cette fonctionnalité dans votre propre extension, déclarez le pop-up dans le fichier manifest.json et spécifiez le contenu que Chrome doit y afficher.

// 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 schéma. Lorsque l'utilisateur clique sur l'action, l'extension injecte un script de contenu dans la page actuelle. Le script de contenu affiche ensuite une alerte pour vérifier que tout fonctionne 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 les actions avec déclarativeContent

Cet exemple montre comment la logique d'arrière-plan d'une extension peut (a) désactiver une action par défaut et (b) utiliser declarativeContent pour l'activer 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);
  });
});

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

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

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

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

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

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

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

chrome.action.getUserSettings(
  callback?: function,
)

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

chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

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

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

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

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

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

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

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