Skip to content

SlashCommandPluginInstance

Unofficial

Plugin instance for slash commands, providing inline command suggestions when typing ”/”.

Import:

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

Signature:

export interface SlashCommandPluginInstance extends InternalPluginInstance<SlashCommandPlugin>

Extends: InternalPluginInstance<SlashCommandPlugin>

Properties

Property Type Description
defaultOn false 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)

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: