gecko-dev/browser/components/extensions/parent/ext-commands.js
Matt Mower 51bd35f1c1 Bug 1538451 - Add openShortcutSettings() to browser.commands extension API. r=robwu,desktop-theme-reviewers,dao
- Introduce browser.commands.openShortcutSettings() method that can be
  called by extensions to open the shortcuts view in AddonManager. The
  extension's own shortcuts card is focused and scrolled into view.
- Add mochitests to verify:
  - AddonManager tab is opened or reused if already open when
    openShortcutSettings() is called.
  - AddonManager view is correctly set to shortcuts when
    openShortcutSettings() is called. The extension's own shortcuts card
    can be found in the page and is focused.
  - openShortcutSettings() works even when commands is an empty object
    in the manifest.
  - openShortcutSettings() is not available when commands is not defined
    in the manifest.

Supersedes https://bugzilla.mozilla.org/attachment.cgi?id=9183595 which
appears to be abandoned.

Differential Revision: https://phabricator.services.mozilla.com/D217920
2025-02-03 17:19:03 +00:00

89 lines
2.6 KiB
JavaScript

/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
ChromeUtils.defineESModuleGetters(this, {
ExtensionShortcuts: "resource://gre/modules/ExtensionShortcuts.sys.mjs",
});
this.commands = class extends ExtensionAPIPersistent {
PERSISTENT_EVENTS = {
onCommand({ fire }) {
const { extension } = this;
const { tabManager } = extension;
let listener = (eventName, commandName) => {
let nativeTab = tabTracker.activeTab;
tabManager.addActiveTabPermission(nativeTab);
fire.async(commandName, tabManager.convert(nativeTab));
};
this.on("command", listener);
return {
unregister: () => this.off("command", listener),
convert(_fire) {
fire = _fire;
},
};
},
onChanged({ fire }) {
let listener = (eventName, changeInfo) => {
fire.async(changeInfo);
};
this.on("shortcutChanged", listener);
return {
unregister: () => this.off("shortcutChanged", listener),
convert(_fire) {
fire = _fire;
},
};
},
};
static onUninstall(extensionId) {
return ExtensionShortcuts.removeCommandsFromStorage(extensionId);
}
async onManifestEntry() {
let shortcuts = new ExtensionShortcuts({
extension: this.extension,
onCommand: name => this.emit("command", name),
onShortcutChanged: changeInfo => this.emit("shortcutChanged", changeInfo),
});
this.extension.shortcuts = shortcuts;
await shortcuts.loadCommands();
await shortcuts.register();
}
onShutdown() {
this.extension.shortcuts.unregister();
}
getAPI(context) {
return {
commands: {
getAll: () => this.extension.shortcuts.allCommands(),
update: args => this.extension.shortcuts.updateCommand(args),
reset: name => this.extension.shortcuts.resetCommand(name),
openShortcutSettings: () =>
this.extension.shortcuts.openShortcutSettings(),
onCommand: new EventManager({
context,
module: "commands",
event: "onCommand",
inputHandling: true,
extensionApi: this,
}).api(),
onChanged: new EventManager({
context,
module: "commands",
event: "onChanged",
extensionApi: this,
}).api(),
},
};
}
};