commands

Listen for the user executing commands that you have registered using the commands manifest.json key.

Types

commands.Command
Object representing a command. This contains the information specified for the command in the commands manifest.json key.

Functions

commands.getAll

Gets all registered commands for this extension.

commands.reset

Reset the given command's description and shortcut to the values given in the manifest key.

commands.update

Change the description or shortcut for the given command.

Events

commands.onCommand
Fired when a command is executed using its associated keyboard shortcut.

Browser compatibility

Report problems with this compatibility data on GitHub
webextensions-desktopwebextensions-mobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
Command
getAll
onCommand
reset
update

Legend

Full support
Full support
No support
No support
See implementation notes.

Example extensions

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.