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
commandsmanifest.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
Update compatibility data on GitHub
| Desktop | Mobile | ||||
|---|---|---|---|---|---|
Command | Chrome Full support Yes | Edge No support No | Firefox Full support 48 | Opera Full support Yes | Firefox Android No support No |
getAll | Chrome Full support Yes | Edge No support No | Firefox Full support 48 | Opera Full support Yes | Firefox Android No support No |
onCommand | Chrome Full support Yes | Edge No support No | Firefox
Full support
48
| Opera Full support Yes | Firefox Android No support No |
reset | Chrome No support No | Edge No support No | Firefox Full support 60 | Opera No support No | Firefox Android No support No |
update | Chrome No support No | Edge No support No | Firefox Full support 60 | Opera No support No | Firefox Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
- 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.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.