Plugin

Register a command globally. Registered commands will be available from the @{link https://help.obsidian.md/Plugins/Command+palette Command palette}. The command id and name will be automatically prefixed with this plugin’s id and name.

Parameters

command

Command

Returns

Command

addRibbonIcon()

addRibbonIcon(icon, title, callback): HTMLElement

Defined in: obsidian.d.ts:3125

Adds a ribbon icon to the left bar.

Parameters

icon

string

The icon name to be used. See addIcon

title

string

The title to be displayed in the tooltip.

callback

(evt) => any

The click callback.

Returns

HTMLElement

addSettingTab()

addSettingTab(settingTab): void

Defined in: obsidian.d.ts:3152

Parameters

settingTab

PluginSettingTab

Returns

void

See

https://docs.obsidian.md/Plugins/User+interface/Settings#Register+a+settings+tab

addStatusBarItem()

addStatusBarItem(): HTMLElement

Defined in: obsidian.d.ts:3133

Adds a status bar item to the bottom of the app. Not available on mobile.

Returns

HTMLElement

HTMLElement - element to modify.

See

https://docs.obsidian.md/Plugins/User+interface/Status+bar

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

Component.load

loadData()

loadData(): Promise<any>

Defined in: obsidian.d.ts:3208

Load settings data from disk. Data is stored in data.json in the plugin folder.

Returns

Promise<any>

See

https://docs.obsidian.md/Plugins/User+interface/Settings

onExternalSettingsChange()?

optional onExternalSettingsChange(): any

Defined in: obsidian.d.ts:3234

Called when the data.json file is modified on disk externally from Obsidian. This usually means that a Sync service or external program has modified the plugin settings.

Implement this method to reload plugin settings when they have changed externally.

Returns

any

onload()

onload(): void | Promise<void>

Defined in: obsidian.d.ts:3117

Returns

void | Promise<void>

Overrides

Component.onload

onunload()

onunload(): void

Defined in: obsidian.d.ts:882

Override this to unload your component

Returns

void

Inherited from

Component.onunload

onUserEnable()

onUserEnable(): void

Defined in: obsidian.d.ts:3223

Perform any initial setup code. The user has explicitly interacted with the plugin so its safe to engage with the user. If your plugin registers a custom view, you can open it here.

Returns

void

register()

register(cb): void

Defined in: obsidian.d.ts:897

Registers a callback to be called when unloading

Parameters

cb

() => any

Returns

void

Inherited from

Component.register

registerDomEvent()

Call Signature

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

Defined in: obsidian.d.ts:907

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof WindowEventMap

Parameters

el

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

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

Defined in: obsidian.d.ts:912

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof DocumentEventMap

Parameters

el

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

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

Defined in: obsidian.d.ts:917

Registers an DOM event to be detached when unloading

Type Parameters

• K extends keyof HTMLElementEventMap

Parameters

el

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerEditorExtension()

registerEditorExtension(extension): void

Defined in: obsidian.d.ts:3188

Registers a CodeMirror 6 extension. To reconfigure cm6 extensions for a plugin on the fly, an array should be passed in, and modified dynamically. Once this array is modified, calling Workspace.updateOptions will apply the changes.

Parameters

extension

Extension

must be a CodeMirror 6 Extension, or an array of Extensions.

Returns

void

registerEditorSuggest()

registerEditorSuggest(editorSuggest): void

Defined in: obsidian.d.ts:3201

Parameters

editorSuggest

EditorSuggest<any>

Returns

void

registerEvent()

registerEvent(eventRef): void

Defined in: obsidian.d.ts:902

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

Component.registerEvent

registerExtensions()

registerExtensions(extensions, viewType): void

Defined in: obsidian.d.ts:3165

Parameters

extensions

string[]

viewType

string

Returns

void

registerHoverLinkSource()

registerHoverLinkSource(id, info): void

Defined in: obsidian.d.ts:3161

Registers a view with the ‘Page preview’ core plugin as an emitter of the ‘hover-link’ event.

Parameters

id

string

info

HoverLinkSource

Returns

void

registerInterval()

registerInterval(id): number

Defined in: obsidian.d.ts:924

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

registerMarkdownCodeBlockProcessor()

registerMarkdownCodeBlockProcessor(language, handler, sortOrder?): MarkdownPostProcessor

Defined in: obsidian.d.ts:3179

Register a special post processor that handles fenced code given a language and a handler. This special post processor takes care of removing the <pre><code> and create a <div> that will be passed to the handler, and is expected to be filled with custom elements.

Parameters

language

string

handler

(source, el, ctx) => void | Promise<any>

sortOrder?

number

Returns

MarkdownPostProcessor

See

https://docs.obsidian.md/Plugins/Editor/Markdown+post+processing#Post-process+Markdown+code+blocks

registerMarkdownPostProcessor()

registerMarkdownPostProcessor(postProcessor, sortOrder?): MarkdownPostProcessor

Defined in: obsidian.d.ts:3171

Registers a post processor, to change how the document looks in reading mode.

Parameters

postProcessor

MarkdownPostProcessor

sortOrder?

number

Returns

MarkdownPostProcessor

See

https://docs.obsidian.md/Plugins/Editor/Markdown+post+processing

registerObsidianProtocolHandler()

registerObsidianProtocolHandler(action, handler): void

Defined in: obsidian.d.ts:3196

Parameters

action

string

the action string. For example, ‘open’ corresponds to obsidian://open.

handler

ObsidianProtocolHandler

the callback to trigger. A key-value pair that is decoded from the query will be passed in. For example, obsidian://open?key=value would generate {'action': 'open', 'key': 'value'}.