Skip to content

InternalPlugins

Extends

Properties

_

_: Record<string, EventsEntry[]>

Inherited from

Events._


app

app: App

Reference to App


config

config: InternalPluginsConfigRecord

Mapping of whether an internal plugin is enabled


plugins

plugins: object

Plugin configs for internal plugins

audio-recorder

audio-recorder: AudioRecorderPlugin

backlink: BacklinkPlugin

bookmarks

bookmarks: BookmarksPlugin

canvas

canvas: CanvasPlugin

command-palette

command-palette: CommandPalettePlugin

daily-notes

daily-notes: DailyNotesPlugin

editor-status

editor-status: EditorStatusPlugin

file-explorer

file-explorer: FileExplorerPlugin

file-recovery

file-recovery: FileRecoveryPlugin

global-search: GlobalSearchPlugin

graph

graph: GraphPlugin

markdown-importer

markdown-importer: MarkdownImporterPlugin

note-composer

note-composer: NoteComposerPlugin

outgoing-link: OutgoingLinkPlugin

outline

outline: OutlinePlugin

page-preview

page-preview: PagePreviewPlugin

properties

properties: PropertiesPlugin

publish

publish: PublishPlugin

random-note

random-note: RandomNotePlugin

slash-command

slash-command: SlashCommandPlugin

slides

slides: SlidesPlugin

switcher

switcher: SwitcherPlugin

sync

sync: SyncPlugin

tag-pane

tag-pane: TagPanePlugin

templates

templates: TemplatesPlugin

word-count

word-count: WordCountPlugin

workspaces

workspaces: WorkspacesPlugin

zk-prefixer

zk-prefixer: ZkPrefixerPlugin

Methods

getEnabledPluginById()

getEnabledPluginById<ID>(id): null | InternalPluginNameInstancesMapping[ID]

Get an enabled internal plugin by ID

Type Parameters

ID extends InternalPluginNameType

Parameters

id: ID

ID of the plugin to get

Returns

null | InternalPluginNameInstancesMapping[ID]


getEnabledPlugins()

getEnabledPlugins(): InternalPlugin<unknown>[]

Get all enabled internal plugins

Returns

InternalPlugin<unknown>[]


getPluginById()

getPluginById<ID>(id): null | InternalPluginNamePluginsMapping[ID]

Get an internal plugin by ID

Type Parameters

ID extends InternalPluginNameType

Parameters

id: ID

ID of the plugin to get

Returns

null | InternalPluginNamePluginsMapping[ID]


off()

off(name, callback): void

Parameters

name: string

callback

Returns

void

Inherited from

Events.off


offref()

offref(ref): void

Parameters

ref: EventRef

Returns

void

Inherited from

Events.offref


on()

on(name, callback, ctx?): EventRef

Parameters

name: string

callback

ctx?: any

Returns

EventRef

Inherited from

Events.on


trigger()

trigger(name, …data): void

Parameters

name: string

• …data: unknown[]

Returns

void

Inherited from

Events.trigger


tryTrigger()

tryTrigger(evt, args): void

Parameters

evt: EventRef

args: unknown[]

Returns

void

Inherited from

Events.tryTrigger