InternalPluginInstance<InternalPlugin>

Unofficial

Both Official Unofficial

Both Own Inherited

Base interface for an internal plugin instance, providing lifecycle hooks and metadata.

Import:

import type { InternalPluginInstance } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface InternalPluginInstance<InternalPlugin>

Properties

	Property	Type	Description
	description	string	Human-readable description of this plugin.
	id	string	Unique identifier for this plugin.
	name	string	Human-readable display name of this plugin.

Methods

	Method	Returns	Description
	init(app, plugin)	void	Initialize the plugin instance with app and plugin references.
	onDisable(app, plugin)	void	Called when the plugin is disabled.
	onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled.
	onUserDisable(app)	void	Called when the user manually disables the plugin.
	onUserEnable(app)	void	Called when the user manually enables the plugin.

---

Links to this page:

• AudioRecorderPluginInstance
• BacklinkPluginInstance
• BasesPluginInstance
• BookmarksPluginInstance
• CanvasPluginInstance
• CommandPalettePluginInstance
• DailyNotesPluginInstance
• EditorStatusPluginInstance
• FileExplorerPluginInstance
• FileRecoveryPluginInstance
• FootnotesPluginInstance
• GlobalSearchPluginInstance
• GraphPluginInstance
• InternalPlugin
• MarkdownImporterPluginInstance
• NoteComposerPluginInstance
• OutgoingLinkPluginInstance
• OutlinePluginInstance
• PagePreviewPluginInstance
• PropertiesPluginInstance
• PublishPluginInstance
• RandomNotePluginInstance
• SlashCommandPluginInstance
• SlidesPluginInstance
• SwitcherPluginInstance
• SyncPluginInstance
• TagPanePluginInstance
• TemplatesPluginInstance
• WebviewerPluginInstance
• WordCountPluginInstance
• WorkspacesPluginInstance
• ZkPrefixerPluginInstance