SwitcherPluginInstance
Unofficial
Plugin instance for the quick switcher, providing fuzzy file search and navigation.
Import:
import type { SwitcherPluginInstance } from '@obsidian-typings/obsidian-catalyst-latest';Signature:
export interface SwitcherPluginInstance extends InternalPluginInstance<SwitcherPlugin>Extends: InternalPluginInstance<SwitcherPlugin>
Properties
| Property | Type | Description | |
|---|---|---|---|
| activeModal | Modal | null | The currently open quick-switcher modal, or null if none is open. | |
| 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 | unknown | The plugin's options. | |
| plugin | SwitcherPlugin | Reference to the switcher plugin registration. | |
| QuickSwitcherModal | unknown | The quick-switcher modal constructor. |
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) | |
| onExternalSettingsChange() | Promise<void> | Handles a settings change made externally (e.g. by Sync). | |
| onOpen() | Promise<void> | Opens the quick switcher. | |
| 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: