FileExplorerPluginInstance

Unofficial

Both Official Unofficial

Both Own Inherited

Plugin instance for the file explorer, managing the file tree sidebar view.

Import:

import type { FileExplorerPluginInstance } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface FileExplorerPluginInstance extends InternalPluginInstance<FileExplorerPlugin>

Extends: InternalPluginInstance<FileExplorerPlugin>

Properties

	Property	Type	Description
	app	App	Reference to the app.
	defaultOn	true	Whether this plugin is enabled by default.
	description	string	Human-readable description of this plugin. (Inherited from InternalPluginInstance)
	id	string	Unique identifier for this plugin. (Inherited from InternalPluginInstance)
	name	string	Human-readable display name of this plugin. (Inherited from InternalPluginInstance)
	plugin	FileExplorerPlugin	Reference to the file explorer plugin registration.

Methods

	Method	Returns	Description
	init(app, plugin)	void	Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance)
	initLeaf()	void	Ensures the file explorer leaf exists in the left sidebar.
	onDisable(app, plugin)	void	Called when the plugin is disabled. (Inherited from InternalPluginInstance)
	onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled. (Inherited from InternalPluginInstance)
	onFileMenu(menu, file, source)	void	Adds file-explorer items to the file context menu.
	onUserDisable(app)	void	Called when the user manually disables the plugin. (Inherited from InternalPluginInstance)
	onUserEnable(app)	void	Called when the user manually enables the plugin. (Inherited from InternalPluginInstance)
	revealInFolder(item)	void	Reveals a file or folder in the file explorer view, opens the view if it is not already. open/visible.

---

Links to this page:

• FileExplorerPlugin