Spec-Zone.ru › Web Extensions

onCommand

Вызывается при выполнении команды с помощью связанной комбинации клавиш.

Обработчик получает имя команды. Это совпадает с именем, заданным для команды в ее записи manifest.json.

Синтаксис

browser.commands.onCommand.addListener(listener)
browser.commands.onCommand.removeListener(listener)
browser.commands.onCommand.hasListener(listener)

События имеют три функции:

addListener(callback)

Добавляет обработчик к этому событию.

removeListener(listener)

Прекращает прослушивание этого события. Аргумент listener — это обработчик, который нужно удалить.

hasListener(listener)

Проверяет, зарегистрирован ли listener для этого события. Возвращает true, если он прослушивает, и false, в противном случае.

Синтаксис addListener

Параметры

callback

Функция, которая будет вызываться при вводе пользователем комбинации клавиш для команды. Функции будут переданы следующие аргументы:

name

string. Имя команды. Это совпадает с именем, заданным для команды в ее записи manifest.json.

Совместимость с браузерами

Рабочий стол Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox для Android Opera Android Safari на iOS Samsung Internet
onCommand Да 79
48До версии 63 обработчик onCommand не обрабатывался как обработчик пользовательского действия.
? Да 14 ? ? Нет ? 15 ?

Примеры

Предположим запись в manifest.json:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    },
    "description": "Send a 'toggle-feature' event"
  }
}

Вы можете прослушать эту конкретную команду следующим образом:

browser.commands.onCommand.addListener((command) => {
  if (command === "toggle-feature") {
    console.log("toggling the feature!");
  }
});

Примеры расширений

  • commands

Примечание: Этот API основан на API chrome.commands Chromium.

© 2005–2023 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/onCommand

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API