Skip to content

FileExplorerRootMenuHandlerParams

Parameters for a FileExplorerRootMenuHandler.

The shape is part of the wire format between copies of this library: fields are only ever added.

Import:

import type { FileExplorerRootMenuHandlerParams } from '@mnaoumov/obsidian-lib/components/file-explorer-root-menu-component';

Signature:

export interface FileExplorerRootMenuHandlerParams

Properties

PropertyTypeDescription
menuMenuThe menu, about to be shown: the root's folder menu, after every file-menu handler has run, or on the vault name the vault menu Obsidian builds there. A menu still empty after every handler is not shown.
mouseEventMouseEventThe right-click or long-press that opened the menu.
rootFolderTFolderThe vault root.
spotFileExplorerRootMenuSpotWhich spot the menu was opened from.

Links to this page: