mirror of
https://github.com/laurent22/joplin.git
synced 2024-12-21 09:38:01 +02:00
62 lines
2.6 KiB
TypeScript
62 lines
2.6 KiB
TypeScript
/* eslint-disable multiline-comment-style */
|
|
|
|
import KeymapService from '../../KeymapService';
|
|
import { CreateMenuItemOptions, MenuItemLocation } from './types';
|
|
import MenuItemController from '../MenuItemController';
|
|
import Plugin from '../Plugin';
|
|
import createViewHandle from '../utils/createViewHandle';
|
|
|
|
/**
|
|
* Allows creating and managing menu items.
|
|
*
|
|
* [View the demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/register_command)
|
|
*
|
|
* <span class="platform-desktop">desktop</span>
|
|
*/
|
|
export default class JoplinViewsMenuItems {
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
private store: any;
|
|
private plugin: Plugin;
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
public constructor(plugin: Plugin, store: any) {
|
|
this.store = store;
|
|
this.plugin = plugin;
|
|
}
|
|
|
|
/**
|
|
* Creates a new menu item and associate it with the given command. You can specify under which menu the item should appear using the `location` parameter.
|
|
*/
|
|
public async create(id: string, commandName: string, location: MenuItemLocation = MenuItemLocation.Tools, options: CreateMenuItemOptions = null) {
|
|
if (typeof location !== 'string') {
|
|
this.plugin.deprecationNotice('1.5', 'Creating a view without an ID is deprecated. To fix it, change your call to `joplin.views.menuItem.create("my-unique-id", ...)`', true);
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
options = location as any;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
location = commandName as any || MenuItemLocation.Tools;
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Old code before rule was applied
|
|
commandName = id as any;
|
|
id = `${this.plugin.viewCount}`;
|
|
}
|
|
|
|
const handle = createViewHandle(this.plugin, id);
|
|
const controller = new MenuItemController(handle, this.plugin.id, this.store, commandName, location);
|
|
this.plugin.addViewController(controller);
|
|
|
|
// Register the command with the keymap service - not that if no
|
|
// accelerator is provided, we still register the command, so that
|
|
// it appears in the keymap editor, which will allow the user to
|
|
// set a custom shortcut.
|
|
//
|
|
// https://discourse.joplinapp.org/t/plugin-note-tabs/12752/39
|
|
|
|
if (options && options.accelerator) {
|
|
KeymapService.instance().registerCommandAccelerator(commandName, options.accelerator);
|
|
} else {
|
|
KeymapService.instance().registerCommandAccelerator(commandName, null);
|
|
}
|
|
}
|
|
|
|
}
|