Workspace.on('file-menu') method

Workspace › on(‘file-menu’)

Official

Triggered when the user opens the context menu on a file.

Signature:

on(name: "file-menu", callback: (menu: Menu, file: TAbstractFile, source: string, leaf?: WorkspaceLeaf | undefined) => unknown, ctx?: unknown): EventRef

Parameters:

Parameter	Type	Description
name	"file-menu"	Should be 'file-menu'.
callback	(menu: Menu, file: TAbstractFile, source: string, leaf?: WorkspaceLeaf | undefined) => unknown	The callback function.
ctx?	unknown	The context passed as this to the callback function.

Returns: EventRef — The event reference.

Example:

app.workspace.on('file-menu', (menu, file, source, leaf) => {
    console.log(menu, file, source, leaf);
});