Type Objet
Obligatoire Non
Exemple
"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y",
      "linux": "Ctrl+Shift+U"
    },
    "description": "Send a 'toggle-feature' event"
  }
}

Utilisez la clé commands pour définir un ou plusieurs raccourcis clavier pour votre extension.

Chaque raccourci est défini avec un nom, une combinaison de touches et une description. Une fois que vous avez défini certaines commandes dans manifest.json, vous pouvez suivre les combinaisons de touches associées proposées par l'API JavaScript commands.

Syntaxe

La clé commands est un objet, et chaque raccourci est une propriété de celui-ci. Le nom de la propriété est le nom du raccourci.

Chaque raccourci est lui-même un objet, qui possède jusqu'à deux propriétés:

  • suggested_key: définit la combinaison de touches
  • description: une chaîne qui décrit ce raccourci

La propriétésuggested_key est elle-même un objet  pouvant avoir l'une des propriétés suivantes, qui sont toutes des chaînes :

  • "default", "mac", "linux", "windows", "chromeos", "android", "ios"

La valeur de chaque propriété est le raccourci clavier pour la commande sur la plateforme donnée, sous la forme d'une chaîne contenant les touches séparées par "+". La valeur de "défaut" est utilisée sur toutes les plateformes qui ne sont pas listées explicitement.

Par exemple:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Alt+Shift+U",
      "linux": "Ctrl+Shift+U"
    },
    "description": "Send a 'toggle-feature' event to the extension"
  },
  "do-another-thing": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

Cela définit deux raccourcis:

  • Une nommée "toggle-feature", accessible à l'aide de Ctrl+Shift+U sur Linux, et Alt+Shift+U sur toutes les autres plateformes
  • Une nommée "do-another-thing", accesible à l'aide de Ctrl+Shift+Y sur toutes les plateformes.

Vous pouvez ensuite répondre à la première de ces commandes avec le code  suivant :

browser.commands.onCommand.addListener(function(command) {
  if (command == "toggle-feature") {
    console.log("toggling the feature!");
  }
});

Raccourcis spéciaux

Il existe trois raccourcis spéciaux:

  • _execute_browser_action : fonctionne comme un clic  sur une action navigateur de l'extension.
  • _execute_page_action : fonctionne comme un clic sur une action de page de l'extension.
  • _execute_sidebar_action : ouvre la barre latérale de l'extension. Uniquement supportée dans Firefox, et uniquement à partir de Firefox version 54.

Par exemple, cela définit une clé de combinaison pour cliquer sur l'action du navigateur d'extension :

"commands": {
  "_execute_browser_action": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

Les valeurs de raccourci

Il existe deux formats valides pour les touches de raccourci : comme une combinaison de touches ou comme une clé multimédia.

Combinaisons de touches

Sur Mac, "Ctrl" est interprété comme "Command", donc si vous avez réellement besoin de "Ctrl", spécifiez "MacCtrl".

Les combinaisons de touches doivent être composées de deux ou trois touches :

  • modificateur (obligatoire, à l'exception des touches de fonction). Il peut s'agir de : "Ctrl", "Alt", "Command", "MacCtrl".
  • second modificateur (optionnel). S'il est fourni, cela doit être "Shift".
  • touche (obligatoire). Ce peut etre l'une des touches :
    • lettres A-Z
    • chiffres 0-9
    • fonction F1-F12
    • Comma (Virgule), Period (Point), Home (Début), End (Fin), PageUp (Page précédente), PageDown (Page suivante), Space (Espace), Insert (Inser), Delete (Suppr), Up (Haut), Down (Bas), Left (Gauche), Right (Droite)

Touches médias

Une alternative est de spécifier le raccourci comme l'une des touches de médias suivantes :

  • "MediaNextTrack", "MediaPlayPause", "MediaPrevTrack", "MediaStop"

Exemple

Définissez un seul raccourci, en utilisant uniquement la valeur par défaut:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    },
    "description": "Send a 'toggle-feature' event"
  }
}

Définissez deux raccourcis, un avec une combinaison de touches spécifique à la plate-forme:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Alt+Shift+U",
      "linux": "Ctrl+Shift+U"
    },
    "description": "Send a 'toggle-feature' event"
  },
  "do-another-thing": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple (Oui) Non48 Non (Oui)
F1-F12 (Oui) Non53 Non (Oui)
_execute_sidebar_action Non Non54 Non Non
global (Oui) Non Non Non (Oui)
MediaNextTrack (Oui) Non Non Non (Oui)
MediaPlayPause (Oui) Non Non Non (Oui)
MediaPrevTrack (Oui) Non Non Non (Oui)
MediaStop (Oui) Non Non Non (Oui)

Étiquettes et contributeurs liés au document

Étiquettes : 
 Contributeurs à cette page : edrflt, loella16, hellosct1
 Dernière mise à jour par : edrflt,