BacklinkPluginInstance

Unofficial

Both Official Unofficial

Both Own Inherited

Plugin instance for backlinks, managing backlink view lifecycle and file event handling.

Import:

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

Signature:

export interface BacklinkPluginInstance extends InternalPluginInstance<BacklinkPlugin>

Extends: InternalPluginInstance<BacklinkPlugin>

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)
	file?	null | TFile	The currently tracked file for backlinks.
	id	string	Unique identifier for this plugin. (Inherited from InternalPluginInstance)
	name	string	Human-readable display name of this plugin. (Inherited from InternalPluginInstance)
	options	BacklinkPluginInstanceOptions	Configuration options for the backlink plugin.
	plugin	BacklinkPlugin	Reference to the backlink plugin registration.

Methods

	Method	Returns	Description
	init(app, plugin)	void	Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance)
	initLeaf()	void	Initialize the backlink view leaf.
	onDisable(app, plugin)	void	Called when the plugin is disabled. (Inherited from InternalPluginInstance)
	onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled.
	onEnable(app, plugin)	Promise<void>	Called when the plugin is enabled. (Inherited from InternalPluginInstance)
	onExternalSettingsChange()	Promise<void>	Handle external settings file changes and reload configuration.
	onFileMenu(menu, file, source, leaf?)	void	Add backlink-related items to a file context menu.
	onFileOpen(file)	void	Handle a file being opened and update backlink tracking.
	onUserDisable(app)	void	Called when the user disables the plugin.
	onUserEnable()	void	Called when the user enables the plugin.
	onUserEnable(app)	void	Called when the user manually enables the plugin. (Inherited from InternalPluginInstance)
	openBacklinksForActiveFile(skipSplit)	boolean | undefined	Open the backlinks pane for the currently active file.
	toggleBacklinksInDocument(skip)	boolean | undefined	Toggle the inline backlinks display within the document view.
	updateBacklinks()	void	Refresh the backlink results for the current file.

---

Links to this page:

• BacklinkPlugin