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 tasti 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 Command possono avere due proprietà.

suggested_key

Una proprietà facoltativa che dichiara le scorciatoie da tastiera predefinite per il comando. Se omesso, il comando non sarà associato. Questa proprietà può accettare una stringa o un valore oggetto.

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

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

Per ulteriori dettagli, consulta la sezione Requisiti delle combinazioni di tasti.

description

Una 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 dell'estensione. 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

Le seguenti chiavi sono scorciatoie dei comandi utilizzabili. Le definizioni delle chiavi sono sensibili alle maiuscole. Il tentativo di caricare un'estensione con una chiave con lettere maiuscole e minuscole errate comporterà un errore di analisi del manifest al momento dell'installazione.

Chiavi alfa

A … Z

Tasti numerici

0 … 9

Stringhe di chiavi standard

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

Tasti freccia: Up, Down, Left, Right

Tasti multimediali: MediaNextTrack, MediaPlayPause, MediaPrevTrack, MediaStop

Stringhe dei tasti di modifica

Ctrl, Alt, 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.

  • Su molte tastiere macOS, Alt si riferisce al tasto Opzione.

  • Su macOS, è possibile utilizzare anche Command o MacCtrl al posto di Ctrl o Alt (vedi il punto elenco successivo).

• Su macOS, Ctrl viene convertito automaticamente in Command.

  • Command può essere utilizzato anche nella scorciatoia "mac" per fare riferimento esplicitamente al tasto Comando.

  • Per utilizzare il tasto Control su macOS, sostituisci Ctrl con MacCtrl quando definisci la scorciatoia "mac".

  • L'utilizzo di MacCtrl nella 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 es. la gestione delle finestre) hanno sempre la priorità sulle scorciatoie dei comandi delle estensioni e non possono essere sostituite.

Gestire gli eventi di comando

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 worker di servizio, 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 della tua azione, dell'azione del browser o dell'azione della pagina. Questi comandi non inviano eventi command.onCommand come i comandi standard.

Se devi intervenire in base all'apertura del popup, ti consigliamo di ascoltare un evento DOMContentLoaded all'interno del codice JavaScript del popup.

Ambito

Per impostazione predefinita, i comandi hanno come ambito il browser Chrome. Ciò significa che quando il browser non ha il focus, le scorciatoie da tastiera dei comandi non sono attive. A partire da Chrome 35, gli sviluppatori di estensioni possono optionally contrassegnare un comando come "globale". I comandi globali funzionano anche quando Chrome non ha il focus.

I suggerimenti di scorciatoie da tastiera per i comandi globali sono limitati a Ctrl+Shift+[0..9]. Si tratta di una misura di protezione per ridurre al minimo il rischio di sostituire le scorciatoie in altre applicazioni, poiché se, ad esempio, Alt+P fosse 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 alla combinazione di tasti che preferiscono utilizzando l'interfaccia utente esposta in 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 flessibilità della 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. Nella sua forma più di base, un comando richiede solo una dichiarazione del comando nel file manifest dell'estensione e la registrazione di un ascoltatore, 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 Concetti e 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`);
});

Verificare i 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 utente finale più solida anticipando questa possibilità e controllando 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,
)