Workspace.on('editor-menu') method

Workspace › on(‘editor-menu’)

Official

Triggered when the user opens the context menu on an editor.

Signature:

on(name: "editor-menu", callback: (menu: Menu, editor: Editor, info: MarkdownFileInfo | MarkdownView) => unknown, ctx?: unknown): EventRef

Parameters:

Parameter	Type	Description
name	"editor-menu"	Should be 'editor-menu'.
callback	(menu: Menu, editor: Editor, info: MarkdownFileInfo | MarkdownView) => unknown	The callback function.
ctx?	unknown	The context passed as this to the callback function.

Returns: EventRef — The event reference.

Example:

app.workspace.on('editor-menu', (menu, editor, info) => {
    console.log(menu, editor, info);
});