Skip to content

WordCountPluginInstance

Unofficial

Plugin instance for word count, displaying word and character counts in the status bar.

Import:

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

Signature:

export interface WordCountPluginInstance extends InternalPluginInstance<WordCountPlugin>

Extends: InternalPluginInstance<WordCountPlugin>

Properties

PropertyTypeDescription
appAppReference to the app.
defaultOntrueWhether this plugin is enabled by default.
descriptionstringHuman-readable description of this plugin.
(Inherited from InternalPluginInstance)
idstringUnique identifier for this plugin.
(Inherited from InternalPluginInstance)
namestringHuman-readable display name of this plugin.
(Inherited from InternalPluginInstance)
pluginWordCountPluginReference to the word count plugin registration.

Methods

MethodReturnsDescription
init(app, plugin)voidInitialize the plugin instance with app and plugin references.
(Inherited from InternalPluginInstance)
onDisable(app, plugin)voidCalled when the plugin is disabled.
(Inherited from InternalPluginInstance)
onEnable(app, plugin)Promise<void>Called when the plugin is enabled.
(Inherited from InternalPluginInstance)
onUserDisable(app)voidCalled when the user manually disables the plugin.
(Inherited from InternalPluginInstance)
onUserEnable(app)voidCalled when the user manually enables the plugin.
(Inherited from InternalPluginInstance)

Links to this page: