web_extensions / latest / api / commands / command.html /

Command

Information about a command. This contains the information specified for the command in the commands manifest.json key.

An array of these objects is returned from commands.getAll().

Type

Values of this type are objects. They contain the following properties:

name Optional

string. Name of this command. This will be passed into the commands.onCommand event listener.

description Optional

string. Description of this command. This is primarily used to explain to the user what this command does.

shortcut Optional

string. Key(s) used to execute this command, specified as a string like "Ctrl+Shift+Y".

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
Command
Yes
79
48
?
Yes
14
?
?
No
?
15
?
name
Yes
79
48
?
Yes
14
?
?
No
?
?
?
tab
86
86
No
?
72
?
?
?
No
?
?
?

Note: This API is based on Chromium's chrome.commands API.

© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/commands/Command