chrome.action

Descrizione

Disponibilità

Manifest

Per utilizzare l'API chrome.action, specifica un valore di "manifest_version" pari a 3 e includi la chiave "action" nel file manifest.

{
  "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 chiave "action" (insieme ai relativi elementi secondari) è facoltativa. Quando non è inclusa, l'estensione è comunque visualizzata nella barra degli strumenti per consentire l'accesso al menu dell'estensione. Per questo motivo, ti consigliamo di includere sempre almeno le chiavi "action" e "default_icon".

Concetti e utilizzo

Parti dell'interfaccia utente

Icona

L'icona è l'immagine principale nella barra degli strumenti dell'estensione ed è impostata dalla chiave "default_icon" nella chiave "action" del file manifest. Le icone devono avere una dimensione di 16 pixel indipendenti dal dispositivo (DIP) in larghezza e altezza.

La chiave "default_icon" è un dizionario di dimensioni e percorsi di immagini. Chrome usa queste icone per scegliere la scala delle immagini da usare. Se non viene trovata una corrispondenza esatta, Chrome seleziona quella disponibile più vicina e la ridimensiona in base all'immagine, il che potrebbe influire sulla qualità dell'immagine.

Poiché i dispositivi con fattori di scala meno comuni, come 1,5x o 1,2x, stanno diventando sempre più comuni, ti invitiamo a fornire più dimensioni per le icone. In questo modo, l'estensione è predisposta per evitare potenziali variazioni delle dimensioni di visualizzazione delle icone. Tuttavia, se fornisci una sola dimensione, la chiave "default_icon" può anche essere impostata su una stringa con il percorso di una singola icona anziché un dizionario.

Puoi anche chiamare action.setIcon() per impostare l'icona dell'estensione in modo programmatico specificando un percorso dell'immagine diverso o fornendo un'icona generata dinamicamente utilizzando l'elemento canvas HTML o, se l'impostazione viene eseguita da un service worker delle estensioni, l'API canvas offscreen.

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}, () => { /* ... */ });

Per le estensioni pacchettizzate (installate da un file .crx), le immagini possono essere nella maggior parte dei formati supportati dal motore di rendering Blink, inclusi PNG, JPEG, BMP, ICO e altri. SVG non supportato. Le estensioni non pacchettizzate devono utilizzare immagini PNG.

Descrizione comando (titolo)

La descrizione comando, o titolo, viene visualizzata quando l'utente tiene il puntatore del mouse sopra l'icona dell'estensione nella barra degli strumenti. È inoltre incluso nel testo accessibile pronunciato dagli screen reader quando il pulsante viene attivato.

La descrizione comando predefinita viene impostata utilizzando il campo "default_title" della chiave "action" in manifest.json. Puoi anche impostarlo in modo programmatico chiamando action.setTitle().

Badge

Le azioni possono facoltativamente mostrare un "badge", ovvero un po' di testo sovrapposto all'icona. Questo ti consente di aggiornare l'azione per visualizzare una piccola quantità di informazioni sullo stato dell'estensione, ad esempio un contatore. Il badge ha un componente di testo e un colore di sfondo. Poiché lo spazio è limitato, consigliamo di utilizzare al massimo quattro caratteri per il testo del badge.

Per creare un badge, impostalo in modo programmatico chiamando action.setBadgeBackgroundColor() e action.setBadgeText(). Nel file manifest non è presente un'impostazione predefinita per il badge. I valori dei colori del badge possono essere un array di quattro numeri interi compresi tra 0 e 255 che costituiscono il colore RGBA del badge o una stringa con un valore Colore 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
  () => { /* ... */ },
);

Popup

Il popup di un'azione viene visualizzato quando l'utente fa clic sul pulsante di azione dell'estensione nella barra degli strumenti. Il popup può contenere tutti i contenuti HTML di tuo gradimento e verrà ridimensionato automaticamente per adattarlo ai relativi contenuti. Le dimensioni del popup devono essere comprese tra 25 x 25 e 800 x 600 pixel.

Il popup viene impostato inizialmente dalla proprietà "default_popup" nella chiave "action" nel file manifest.json. Se presente, questa proprietà deve indirizzare a un percorso relativo all'interno della directory dell'estensione. Può anche essere aggiornato in modo dinamico in modo che punti a un percorso relativo diverso utilizzando il metodo action.setPopup().

Casi d'uso

Stato per scheda

Le azioni delle estensioni possono avere stati diversi per ogni scheda. Per impostare un valore per una singola scheda, utilizza la proprietà tabId nei metodi di impostazione dell'API action. Ad esempio, per impostare il testo del badge per una scheda specifica:

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

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

Se la proprietà tabId viene tralasciata, l'impostazione viene considerata un'impostazione globale. Le impostazioni specifiche delle schede hanno la priorità sulle impostazioni globali.

Stato abilitato

Per impostazione predefinita, le azioni della barra degli strumenti sono attive (selezionabili) in ogni scheda. Puoi controllare questa opzione utilizzando i metodi action.enable() e action.disable(). Questa impostazione influisce solo sull'invio dell'evento popup (se presente) o action.onClicked all'estensione; non influisce sulla presenza dell'azione nella barra degli strumenti.

Esempi

I seguenti esempi mostrano alcuni modi comuni in cui le azioni vengono utilizzate nelle estensioni. Per provare questa API, installa l'esempio di API Action dal repository chrome-extension-samples.

Mostra un popup

È comune che un'estensione mostri un popup quando l'utente fa clic sull'azione corrispondente. Per implementarla nella tua estensione, dichiara il popup in manifest.json e specifica i contenuti che Chrome deve visualizzare nel popup.

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

Inserisci uno script di contenuti al clic

Un pattern comune per le estensioni è esporre la caratteristica principale utilizzando l'azione dell'estensione. L'esempio seguente mostra questo pattern. Quando l'utente fa clic sull'azione, l'estensione inserisce uno script di contenuti nella pagina corrente. Lo script dei contenuti mostra quindi un avviso per verificare che tutto abbia funzionato come previsto.

// 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!');

Emula azioni con declarativeContent

Questo esempio mostra in che modo la logica in background di un'estensione può (a) disattivare un'azione per impostazione predefinita e (b) utilizzare declarativeContent per attivare l'azione su siti specifici.

// 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,
)