CommandPalettePluginInstance
Unofficial
Plugin instance for the command palette, providing the fuzzy command search modal.
Import:
import type { CommandPalettePluginInstance } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface CommandPalettePluginInstance extends InternalPluginInstance<CommandPalettePlugin>Extends: InternalPluginInstance<CommandPalettePlugin>
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) | |
| modal | CommandPaletteModal | The command palette fuzzy suggest modal. | |
| name | string | Human-readable display name of this plugin. (Inherited from InternalPluginInstance) | |
| options | CommandPaletteOptions | Configuration options for the command palette. | |
| plugin | CommandPalettePlugin | Reference to the command palette plugin registration. | |
| recentCommands | string[] | List of recently used command IDs. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| getCommands() | Command[] | Get the list of available commands for the palette. | |
| 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) | |
| onExternalSettingsChange() | Promise<void> | Handle external settings file changes and reload configuration. | |
| onOpen() | boolean | Called when the command palette is opened. | |
| 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) | |
| openCallback() | boolean | Callback invoked to open the command palette. | |
| saveSettings(plugin) | void | Save the command palette settings. |
Links to this page: