commands.update()
Change the description or keyboard shortcut for the given command.
This is an asynchronous function that returns a Promise
.
Syntax
browser.commands.update(
details // object
);
Parameters
details
object
. An object with the following properties:-
name
string
. The name of the command to update. This must match the name of an existing command, as given for example in thename
property of thecommands.Command
object.description
Optionalstring
. A new description to set for the command.shortcut
Optionalstring
. A new shortcut to set for the command. This can be:- an empty string to clear the shortcut.
- a string matching the format of the
commands
manifest.json key to set a new shortcut key. If the string does not match this format, the function throws an error.
Return value
A Promise
that will be fulfilled with no arguments when the shortcut has been updated. The promise will be rejected with an error if the command could not be found.
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
update | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support60 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo supportNo |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
Updates the command named "my-command" with the given shortcut value, when the user clicks "update":
const commandName = 'my-command';
function updateShortcut() {
browser.commands.update({
name: commandName,
shortcut: document.querySelector('#shortcut').value
});
}
document.querySelector('#update').addEventListener('click', updateShortcut);