Skip to content

EditorStatusPluginInstance

Unofficial

Plugin instance for editor status, displaying editor information in the status bar.

Import:

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

Signature:

export interface EditorStatusPluginInstance extends InternalPluginInstance<EditorStatusPlugin>

Extends: InternalPluginInstance<EditorStatusPlugin>

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)
hiddenFromList true Whether this plugin is hidden from the plugin list in settings.
id string Unique identifier for this plugin.
(Inherited from InternalPluginInstance)
name string Human-readable display name of this plugin.
(Inherited from InternalPluginInstance)
plugin EditorStatusPlugin Reference to the editor status plugin registration.

Methods

Method Returns Description
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)
onEnable(app, plugin) Promise<void> Called when the plugin is enabled.
(Inherited from InternalPluginInstance)
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: