commands.update()

更改给定命令的描述或键盘快捷方式。

语法

js
browser.commands.update(
  details // object
);

参数

details

object。一个具有以下属性的对象。

name

string。要更新的命令的名称。此名称必须与现有命令的名称匹配,例如在 commands.Command 对象的 name 属性中指定的名称。

description 可选

string。要为命令设置的新描述。

shortcut 可选

string。要为命令设置的新快捷方式。这可以是

  • 一个空字符串,用于清除快捷方式。
  • 一个匹配 commands manifest.json 键 格式的字符串,用于设置新的快捷方式键。如果字符串不匹配此格式,则函数将抛出错误。

    注意: 从 Firefox 135 开始,扩展可以使用此方法来分配 F13F19 键,除了 commands 支持的键之外。

返回值

一个 Promise,当快捷方式已更新时,该 Promise 将会完成,不带任何参数。如果找不到命令,Promise 将会以错误被拒绝。

示例

当用户单击“update”时,使用给定的快捷方式值更新名为“my-command”的命令。

js
const commandName = "my-command";

function updateShortcut() {
  browser.commands.update({
    name: commandName,
    shortcut: document.querySelector("#shortcut").value,
  });
}

document.querySelector("#update").addEventListener("click", updateShortcut);

扩展程序示例

浏览器兼容性