NoteComposerPluginInstance

Unofficial

Both Official Unofficial

Both Own Inherited

Plugin instance for note composer, providing note merging and splitting functionality.

Import:

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

Signature:

export interface NoteComposerPluginInstance extends InternalPluginInstance<NoteComposerPlugin>

Extends: InternalPluginInstance<NoteComposerPlugin>

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)
	options	NoteComposerPluginOptions	Configuration options for the note composer.
	pluginInstance	NoteComposerPlugin	Reference to the note composer plugin registration.

Methods

	Method	Returns	Description
	applyTemplate(content, fromTitle, newTitle)	Promise<string>	Apply a template to content, substituting title placeholders.
	extractHeading(file, editor)	void	Extract the content under a heading into a new note.
	getSelectionUnderHeading(file, editor, line)	HeadingInfo | null	Get the text selection range under a heading at the given line.
	init(app, plugin)	void	Initialize the plugin instance with app and plugin references. (Inherited from InternalPluginInstance)
	onDisable(app, plugin)	void	Called when the plugin is disabled. (Inherited from InternalPluginInstance)
	onEditorMenu(menu, editor, info)	void	Add note composer items to the editor context menu.
	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)	void	Add note composer items to a 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)

---

Links to this page:

• NoteComposerPlugin