chrome.commands

Descrizione

Manifest

Concetti e utilizzo

L'API Commands consente agli sviluppatori di estensioni di definire comandi specifici e associarli a una combinazione di chiavi predefinita. Ogni comando accettato da un'estensione deve essere dichiarato come proprietà dell'oggetto "commands" nel manifest dell'estensione.

La chiave della proprietà viene utilizzata come nome del comando. Gli oggetti comando possono avere due proprietà.

suggested_key

Una proprietà facoltativa che dichiara le scorciatoie da tastiera predefinite per il comando. Se omesso, il comando verrà slegato. Questa proprietà può assumere una stringa o un valore di oggetto.

• Un valore stringa specifica la scorciatoia da tastiera predefinita da utilizzare in tutte le piattaforme.

• Un valore oggetto consente allo sviluppatore dell'estensione di personalizzare la scorciatoia da tastiera per ciascuna piattaforma. Quando fornisci scorciatoie specifiche per piattaforma, le proprietà dell'oggetto valide sono default, chromeos, linux, mac e windows.

Per ulteriori dettagli, consulta Requisiti per le combinazioni di tasti.

description

Stringa utilizzata per fornire all'utente una breve descrizione dello scopo del comando. Questa stringa viene visualizzata nell'interfaccia utente di gestione delle scorciatoie da tastiera delle estensioni. Le descrizioni sono obbligatorie per i comandi standard, ma vengono ignorate per i comandi di azione.

Un'estensione può avere molti comandi, ma può specificare al massimo quattro scorciatoie da tastiera suggerite. L'utente può aggiungere manualmente altre scorciatoie dalla finestra di dialogo chrome://extensions/shortcuts.

Chiavi supportate

I tasti riportati di seguito sono scorciatoie per i comandi utilizzabili. Le definizioni chiave sono sensibili alle maiuscole. Se provi a caricare un'estensione con una chiave con lettere maiuscole non corrette, verrà visualizzato un errore di analisi del file manifest al momento dell'installazione.

Tasti alfabetici

A ... Z

Tasti numerici

0 ... 9

Stringhe di chiavi standard

Generali: Comma, Period, Home, End, PageUp, PageDown, Space, Insert, Delete

Tasti freccia: Up, Down, Left, Right

Tasti multimediali: MediaNextTrack, MediaPlayPause, MediaPrevTrack, MediaStop

Stringhe di tasti di modifica

Ctrl, Alt (Option su macOS), Shift, MacCtrl (solo macOS), Command (solo macOS), Search (solo ChromeOS)

Requisiti per le combinazioni di tasti

• Le scorciatoie dei comandi delle estensioni devono includere Ctrl o Alt.

  • I modificatori non possono essere utilizzati in combinazione con i tasti multimediali.

• In macOS, Ctrl viene automaticamente convertito in Command.

  • Per usare il tasto Ctrl su macOS, sostituisci Ctrl con MacCtrl durante la definizione della scorciatoia "mac".

  • L'utilizzo di MacCtrl in combinazione per un'altra piattaforma causerà un errore di convalida e impedirà l'installazione dell'estensione.

• Shift è un modificatore facoltativo su tutte le piattaforme.

• Search è un modificatore facoltativo esclusivo di ChromeOS.

• Alcune scorciatoie del sistema operativo e di Chrome (ad esempio la gestione delle finestre) hanno sempre la priorità sulle scorciatoie dei comandi delle estensioni e non possono essere sostituite.

Gestire gli eventi dei comandi

manifest.json:

{
  "name": "My extension",
  ...
  "commands": {
    "run-foo": {
      "suggested_key": {
        "default": "Ctrl+Shift+Y",
        "mac": "Command+Shift+Y"
      },
      "description": "Run \"foo\" on the current page."
    },
    "_execute_action": {
      "suggested_key": {
        "windows": "Ctrl+Shift+Y",
        "mac": "Command+Shift+Y",
        "chromeos": "Ctrl+Shift+U",
        "linux": "Ctrl+Shift+J"
      }
    }
  },
  ...
}

Nel tuo service worker, puoi associare un gestore a ciascuno dei comandi definiti nel manifest utilizzando onCommand.addListener. Ad esempio:

service-worker.js:

chrome.commands.onCommand.addListener((command) => {
  console.log(`Command: ${command}`);
});

Comandi di azione

I comandi _execute_action (Manifest V3), _execute_browser_action (Manifest V2) e _execute_page_action (Manifest V2) sono riservati rispettivamente all'azione di attivazione dell'azione, dell'azione del browser o dell'azione relativa alla pagina. Questi comandi non inviano eventi command.onCommand come i comandi standard.

Se devi intervenire in base all'apertura del popup, considera la presenza di un evento DOMContentLoaded all'interno del codice JavaScript del popup.

Ambito

Per impostazione predefinita, l'ambito dei comandi è limitato al browser Chrome. Ciò significa che, quando il browser non è attivo, le scorciatoie dei comandi sono inattive. A partire da Chrome 35, gli sviluppatori di estensioni possono contrassegnare un comando come "globale". I comandi globali funzionano anche quando Chrome non è attivo.

Le scorciatoie da tastiera suggerite per i comandi globali sono limitate a Ctrl+Shift+[0..9]. Si tratta di una misura protettiva per ridurre al minimo il rischio di ignorare le scorciatoie in altre applicazioni poiché se, ad esempio, Alt+P dovesse essere consentito come globale, la scorciatoia da tastiera per aprire una finestra di dialogo di stampa potrebbe non funzionare in altre applicazioni.

Gli utenti finali sono liberi di rimappare i comandi globali in base alla combinazione di tasti che preferiscono utilizzando l'interfaccia utente esposta su chrome://extensions/shortcuts.

Esempio:

manifest.json:

{
  "name": "My extension",
  ...
  "commands": {
    "toggle-feature-foo": {
      "suggested_key": {
        "default": "Ctrl+Shift+5"
      },
      "description": "Toggle feature foo",
      "global": true
    }
  },
  ...
}

Esempi

I seguenti esempi mostrano la funzionalità di base dell'API Commands.

Comando di base

I comandi consentono alle estensioni di mappare la logica alle scorciatoie da tastiera che possono essere richiamate dall'utente. In generale, un comando richiede solo una dichiarazione del comando nel file manifest dell'estensione e una registrazione listener, come mostrato nell'esempio seguente.

manifest.json:

{
  "name": "Command demo - basic",
  "version": "1.0",
  "manifest_version": 3,
  "background": {
    "service_worker": "service-worker.js"
  },
  "commands": {
    "inject-script": {
      "suggested_key": "Ctrl+Shift+Y",
      "description": "Inject a script on the page"
    }
  }
}

service-worker.js:

chrome.commands.onCommand.addListener((command) => {
  console.log(`Command "${command}" triggered`);
});

Comando di azione

Come descritto nella sezione Utilizzo, puoi anche mappare un comando all'azione di un'estensione. L'esempio seguente inserisce uno script di contenuti che mostra un avviso nella pagina corrente quando l'utente fa clic sull'azione dell'estensione o attiva la scorciatoia da tastiera.

manifest.json:

{
  "name": "Commands demo - action invocation",
  "version": "1.0",
  "manifest_version": 3,
  "background": {
    "service_worker": "service-worker.js"
  },
  "permissions": ["activeTab", "scripting"],
  "action": {},
  "commands": {
    "_execute_action": {
      "suggested_key": {
        "default": "Ctrl+U",
        "mac": "Command+U"
      }
    }
  }
}

service-worker.js:

chrome.action.onClicked.addListener((tab) => {
  chrome.scripting.executeScript({
    target: {tabId: tab.id},
    func: contentScriptFunc,
    args: ['action'],
  });
});

function contentScriptFunc(name) {
  alert(`"${name}" executed`);
}

// This callback WILL NOT be called for "_execute_action"
chrome.commands.onCommand.addListener((command) => {
  console.log(`Command "${command}" called`);
});

Verifica comandi registrati

Se un'estensione tenta di registrare una scorciatoia già utilizzata da un'altra estensione, la scorciatoia della seconda estensione non verrà registrata come previsto. Puoi offrire un'esperienza più solida all'utente finale prevedindo questa possibilità e verificando la presenza di collisioni al momento dell'installazione.

service-worker.js:

chrome.runtime.onInstalled.addListener((details) => {
  if (details.reason === chrome.runtime.OnInstalledReason.INSTALL) {
    checkCommandShortcuts();
  }
});

// Only use this function during the initial install phase. After
// installation the user may have intentionally unassigned commands.
function checkCommandShortcuts() {
  chrome.commands.getAll((commands) => {
    let missingShortcuts = [];

    for (let {name, shortcut} of commands) {
      if (shortcut === '') {
        missingShortcuts.push(name);
      }
    }

    if (missingShortcuts.length > 0) {
      // Update the extension UI to inform the user that one or more
      // commands are currently unassigned.
    }
  });
}

chrome.commands.getAll(
  callback?: function,
)

chrome.commands.onCommand.addListener(
  callback: function,
)