scriptoriumadmin/zotero
1
0
Fork 0
mirror of https://github.com/zotero/zotero.git synced 2026-08-28 05:25:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update JSDoc for menu manager API

Browse source
This commit is contained in:
windingwind 2025-08-13 16:32:22 +02:00 • committed by Dan Stillman
parent 834d3b3bb3
commit ca6dd437a5
1 changed files with 25 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
chrome/content/zotero/xpcom/pluginAPI/menuManager.js
View file

@ -72,6 +72,9 @@
const CUSTOM_MENU_CLASS = "zotero-custom-menu-item";
/**
* @namespace Zotero
*/
/**
* @typedef MenuData
@ -102,7 +105,6 @@
* @property {string} menuID - The unique ID of the menu
* @property {string} pluginID - The ID of the plugin registering the menu
* @property {string} target - The target for the menu
* @property {string[]} [l10nFiles] - The l10n files to load for the menu
* @property {MenuData[]} [menus] - The menu items to add to the menu
*/
@ -241,7 +243,7 @@
* Validate the menu data recursively
* @param {MenuData} menuData - The menu data to validate
* @param {string} [path] - The path to the menu data
* @returns {{obj?: MenuData, valid: boolean}} - The validated menu data and whether it is valid
* @returns {{obj: MenuData | undefined, valid: boolean}} - The validated menu data and whether it is valid
*/
_validateMenuData(menuData, path = "") {
// Validate the menu data itself
@ -770,16 +772,31 @@
}
class MenuManager {
_menuManager = new MenuManagerInternal();
/**
* Manages menu APIs.
*
* @memberof Zotero
*/
Zotero.MenuManager = {
_menuManager: new MenuManagerInternal(),
/**
* Register custom menu
* @param {MenuOptions} options
* @returns {string | false}
*/
registerMenu(options) {
return this._menuManager.register(options);
}
},
/**
* Unregister custom menu
* @param {string} paneID
* @returns {boolean}
*/
unregisterMenu(paneID) {
return this._menuManager.unregister(paneID);
}
},
updateMenuPopup(popupElem, targetType, args) {
let options = this._menuManager.getCustomMenuOptions(targetType);
@ -789,9 +806,6 @@
menus.push(...option.menus);
}
this._menuManager.updateMenuPopup(popupElem, menus, targetType, args);
}
}
Zotero.MenuManager = new MenuManager();
},
};
}