InternalPlugin

Extends

• Component

Extended by

• MarkdownImporterPlugin
• NoteComposerPlugin
• BacklinkPlugin
• CommandPalettePlugin
• OutlinePlugin
• WorkspacesPlugin
• PublishPlugin
• PagePreviewPlugin
• DailyNotesPlugin
• EditorStatusPlugin
• SyncPlugin
• WordCountPlugin
• GlobalSearchPlugin
• GraphPlugin
• CanvasPlugin
• TemplatesPlugin
• SlashCommandPlugin
• FileExplorerPlugin
• AudioRecorderPlugin
• PropertiesPlugin
• BookmarksPlugin
• FileRecoveryPlugin
• SwitcherPlugin
• TagPanePlugin
• SlidesPlugin
• ZkPrefixerPlugin
• RandomNotePlugin
• OutgoingLinkPlugin

Type Parameters

• InternalPluginInstance

Properties

_children

_children: Component[]

Child Components attached to current component, will be unloaded on unloading parent component

Inherited from

Component._children

---

_events

_events: EventRef[]

Events that are attached to the current component, will be detached on unloading parent component

Inherited from

Component._events

---

_loaded

_loaded: boolean

Whether the component and its children are loaded

Inherited from

Component._loaded

---

addedButtonEls

addedButtonEls: HTMLDivElement[]

---

app

app: App

---

commands

commands: Command[]

---

enabled

enabled: boolean

---

hasStatusBarItem

hasStatusBarItem: boolean

---

instance

instance: InternalPluginInstance

---

lastSave

lastSave: number

---

manager

manager: InternalPlugins

---

mobileFileInfo

mobileFileInfo: MobileFileInfo[]

---

onConfigFileChange

onConfigFileChange: Debouncer<[], Promise<void>>

---

ribbonItems

ribbonItems: RibbonItem[]

---

statusBarEl

statusBarEl: null | HTMLDivElement

---

views

views: Record<string, ViewCreator>

Methods

addChild()

addChild<T>(component): T

Adds a child component, loading it if this component is loaded

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

Component.addChild

---

addSettingTab()

addSettingTab(settingTab): void

Parameters

• settingTab: PluginSettingTab

Returns

void

---

deleteData()

deleteData(): Promise<void>

Returns

Promise<void>

---

disable()

disable(isDisabledByUser?): void

Parameters

• isDisabledByUser?: boolean

Returns

void

---

enable()

enable(isEnabledByUser?): Promise<void>

Parameters

• isEnabledByUser?: boolean

Returns

Promise<void>

---

getModifiedTime()

getModifiedTime(): Promise<undefined | number>

Returns

Promise<undefined | number>

---

handleConfigFileChange()

handleConfigFileChange(): Promise<void>

Returns

Promise<void>

---

init()

init(): void

Returns

void

---

load()

load(): void

Load this component and its children

Returns

void

Inherited from

Component.load

---

loadData()

loadData(): Promise<null | object>

Returns

Promise<null | object>

---

onload()

onload(): void

Override this to load your component

Returns

void

Inherited from

Component.onload

---

onunload()

onunload(): void

Override this to unload your component

Returns

void

Inherited from

Component.onunload

---

register()

register(cb): void

Registers a callback to be called when unloading

Parameters

• cb

Returns

void

Inherited from

Component.register

---

registerDomEvent()

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof WindowEventMap

Parameters

• el: Window

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof DocumentEventMap

Parameters

• el: Document

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerDomEvent(el, type, callback, options)

registerDomEvent<K>(el, type, callback, options?): void

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

• el: HTMLElement

• type: K

• callback

• options?: boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

---

registerEvent()

registerEvent(eventRef): void

Registers an event to be detached when unloading

Parameters

• eventRef: EventRef

Returns

void

Inherited from

Component.registerEvent

---

registerGlobalCommand()

registerGlobalCommand(command): void

Parameters

• command: Command

Returns

void

---

registerInterval()

registerInterval(id): number

Registers an interval (from setInterval) to be cancelled when unloading Use setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API

Parameters

• id: number

Returns

number

Inherited from

Component.registerInterval

---

registerMobileFileInfo()

registerMobileFileInfo(renderCallback): void

Parameters

• renderCallback

Returns

void

---

registerRibbonItem()

registerRibbonItem(title, icon, callback): void

Parameters

• title: string

• icon: string

• callback

Returns

void

---

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Parameters

• keymapEventHandler: KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

---

registerStatusBarItem()

registerStatusBarItem(): void

Returns

void

---

registerViewType()

registerViewType(type, creator): void

Parameters

• type: string

• creator: ViewCreator

Returns

void

---

removeChild()

removeChild<T>(component): T

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

Component.removeChild

---

saveData()

saveData(data): Promise<void>

Parameters

• data: object

Returns

Promise<void>

---

unload()

unload(): void

Unload this component and its children

Returns

void

Inherited from

Component.unload