MarkdownBaseView

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:26

Extends

Component

Extended by

Properties

_children

_children: Component[]

Defined in: src/obsidian/augmentations/Components/Component.d.ts:13

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

Inherited from

Component._children

_events

_events: EventRef[]

Defined in: src/obsidian/augmentations/Components/Component.d.ts:20

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

Inherited from

Component._events

_loaded

_loaded: boolean

Defined in: src/obsidian/augmentations/Components/Component.d.ts:27

Whether the component and its children are loaded.

Inherited from

Component._loaded

app

app: App

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:30

Reference to the app.

cleanupLivePreview

cleanupLivePreview: null | () => void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:35

Callback to clear all elements.

clipboardManager

clipboardManager: ClipboardManager

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:40

Manager that handles pasting text, html and images into the editor.

cm

cm: EditorView

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:45

Codemirror editor instance.

cmInit

cmInit: boolean

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:50

Whether CodeMirror is initialized.

containerEl

containerEl: HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:55

Container element of the editor view.

cursorPopupEl

cursorPopupEl: null | HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:60

Popup element for internal link.

editor?

optional editor: Editor

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:67

Obsidian editor instance.

editorEl

editorEl: HTMLElement

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:72

Element in which the CodeMirror editor resides.

editorSuggest

editorSuggest: EditorSuggests

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:77

Editor suggester for autocompleting files, links, aliases, etc.

livePreviewPlugin

livePreviewPlugin: Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:82

The CodeMirror plugins that handle the rendering of, and interaction with Obsidian’s Markdown.

localExtensions

localExtensions: Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:87

Local (always active) extensions for the editor.

owner

owner: MarkdownFileInfo

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:92

Controller of the editor view.

sourceMode

sourceMode: boolean

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:97

Whether live preview rendering is disabled.

tableCell

tableCell: null | TableCellEditor

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:102

Reference to editor attached to table cell, if any.

Accessors

activeCM

Get Signature

get activeCM(): EditorView

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:107

Currently active CM instance (table cell CM or main CM).

Returns

EditorView

file

Get Signature

get file(): null | TFile

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:112

Returns attached file of the owner instance.

Returns

null | TFile

path

Get Signature

get path(): string

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:117

Returns path of the attached file.

Returns

string

Methods

addChild()

Call Signature

addChild<T>(component): T

Defined in: obsidian.d.ts:911

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

Type Parameters

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

Component.addChild

Call Signature

addChild<T>(component): T

Defined in: src/obsidian/augmentations/Components/Component.d.ts:41

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

Type Parameters

T

T extends Component

The type of the component to add.

Parameters

component

T

The component to add.

Returns

T

The added component.

Example

component.addChild(childComponent);

Inherited from

Component.addChild

applyFoldInfo()

applyFoldInfo(info): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:122

Apply fold history to editor.

Parameters

info

FoldInfo

Returns

void

buildLocalExtensions()

buildLocalExtensions(): Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:129

Constructs local (always active) extensions for the editor.

Returns

Extension[]

clear()

clear(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:134

Cleanup live preview, remove and then re-add all editor extensions.

Returns

void

destroy()

destroy(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:139

Clean up live preview, remove all extensions, destroy editor.

Returns

void

destroyTableCell()

destroyTableCell(cell?): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:144

Removes specified tablecell.

Parameters

cell?

TableCellEditor

Returns

void

editTableCell()

editTableCell(cell, new_cell): TableCellEditor

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:149

Edit a specified table cell, creating a table cell editor.

Parameters

get()

get(): string

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:154

Get the current editor document as a string.

Returns

string

getDynamicExtensions()

getDynamicExtensions(): Extension[]

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:161

Constructs extensions for the editor based on user settings.

Returns

Extension[]

load()

Call Signature

load(): void

Defined in: obsidian.d.ts:889

Load this component and its children

Returns

void

Inherited from

Component.load

Call Signature

load(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:48

Load this component and its children.

Returns

void

Inherited from

Component.load

onContextMenu()

onContextMenu(event, x): Promise<void>

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:178

Creates menu on right mouse click.

Parameters

event

PointerEvent

x

boolean

Returns

Promise<void>

onEditorClick()

onEditorClick(event, element?): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:183

Execute click functionality on token on mouse click.

Parameters

event

MouseEvent

element?

HTMLElement

Returns

void

onEditorDragStart()

onEditorDragStart(event): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:190

Execute drag functionality on drag start.

Parameters

event

DragEvent

Returns

void

onEditorLinkMouseover()

onEditorLinkMouseover(event, target): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:195

Execute hover functionality on mouse over event.

Parameters

event

MouseEvent

target

HTMLElement

Returns

void

onload()

Call Signature

onload(): void

Defined in: obsidian.d.ts:895

Override this to load your component

Returns

void

Inherited from

Component.onload

Call Signature

onload(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:64

Override this to load your component.

Returns

void

Example

class MyComponent extends Component {
  public override onload(): void {
    console.log('MyComponent loaded');
  }
}

Inherited from

Component.onload

onMenu()

onMenu(event): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:202

Execute context menu functionality on right mouse click.

Parameters

event

MouseEvent

Returns

void

onResize()

onResize(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:207

Reposition suggest and scroll position on resize.

Returns

void

onunload()

onunload(): void

Defined in: obsidian.d.ts:906

Override this to unload your component

Returns

void

Inherited from

Component.onunload

onUpdate()

onUpdate(update, changed): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:212

Execute functionality on CM editor state update.

Parameters

update

ViewUpdate

changed

boolean

Returns

void

register()

Call Signature

register(cb): void

Defined in: obsidian.d.ts:921

Registers a callback to be called when unloading

Parameters

cb

() => any

Returns

void

Inherited from

Component.register

Call Signature

register(cb): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:78

Registers a callback to be called when unloading.

Parameters

cb

() => any

The callback to be called when unloading.

Returns

void

Example

component.register(() => {
  console.log('MyComponent unloaded');
});

Inherited from

Component.register

registerDomEvent()

Call Signature

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

Defined in: obsidian.d.ts:931

Registers an DOM event to be detached when unloading

Type Parameters

K

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:936

Registers an DOM event to be detached when unloading

Type Parameters

K

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:941

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof HTMLElementEventMap

Parameters

el

HTMLElement

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: src/obsidian/augmentations/Components/Component.d.ts:96

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof DocumentEventMap

The type of the event to register.

Parameters

el

Document

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document, 'click', () => {
  console.log('Document clicked');
});

Inherited from

Component.registerDomEvent

Call Signature

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

Defined in: src/obsidian/augmentations/Components/Component.d.ts:119

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof HTMLElementEventMap

The type of the event to register.

Parameters

el

HTMLElement

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(document.body, 'click', () => {
  console.log('Body clicked');
});

Inherited from

Component.registerDomEvent

Call Signature

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

Defined in: src/obsidian/augmentations/Components/Component.d.ts:142

Registers an DOM event to be detached when unloading.

Type Parameters

K

K extends keyof WindowEventMap

The type of the event to register.

Parameters

el

Window

The element to register the event on.

type

K

The type of the event to register.

callback

(this, ev) => any

The callback to be called when the event is triggered.

options?

The options for the event.

boolean | AddEventListenerOptions

Returns

void

Example

component.registerDomEvent(window, 'click', () => {
  console.log('Window clicked');
});

Inherited from

Component.registerDomEvent

registerEvent()

Call Signature

registerEvent(eventRef): void

Defined in: obsidian.d.ts:926

Registers an event to be detached when unloading

Parameters

eventRef

EventRef

Returns

void

Inherited from

Component.registerEvent

Call Signature

registerEvent(eventRef): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:159

Registers an event to be detached when unloading.

Parameters

eventRef

EventRef

The event to be registered.

Returns

void

Example

component.registerEvent(eventRef);

Inherited from

Component.registerEvent

registerInterval()

Call Signature

registerInterval(id): number

Defined in: obsidian.d.ts:948

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

Call Signature

registerInterval(id): number

Defined in: src/obsidian/augmentations/Components/Component.d.ts:175

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

The id of the interval to register.

Returns

number

The id of the interval.

Example

component.registerInterval(window.setInterval(() => {
  console.log('Interval');
}, 1000));

Inherited from

Component.registerInterval

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:181

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

reinit()

reinit(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:217

Reinitialize the editor inside new container.

Returns

void

removeChild()

Call Signature

removeChild<T>(component): T

Defined in: obsidian.d.ts:916

Removes a child component, unloading it

Type Parameters

T

T extends Component

Parameters

component

T

Returns

T

Inherited from

Component.removeChild

Call Signature

removeChild<T>(component): T

Defined in: src/obsidian/augmentations/Components/Component.d.ts:195

Removes a child component, unloading it.

Type Parameters

T

T extends Component

The type of the component to remove.

Parameters

component

T

The component to remove.

Returns

T

The removed component.

Example

component.removeChild(childComponent);

Inherited from

Component.removeChild

reparent()

reparent(new_container): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:222

Move the editor into the new container.

Parameters

new_container

HTMLElement

Returns

void

resetSyntaxHighlighting()

resetSyntaxHighlighting(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:229

Bodge to reset the syntax highlighting.

Returns

void

saveHistory()

saveHistory(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:234

Save history of file and data (for caching, for faster reopening of same file in editor).

Returns

void

set()

set(data, clear): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:239

Set the state of the editor.

Parameters

data

string

clear

boolean

Returns

void

toggleFoldFrontmatter()

toggleFoldFrontmatter(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:244

Enables/disables frontmatter folding.

Returns

void

toggleSource()

toggleSource(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:249

Toggle source mode for editor and dispatch effect.

Returns

void

triggerClickableToken()

triggerClickableToken(token, new_leaf): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:254

Execute functionality of token (open external link, open internal link in leaf, …).

Parameters

token

Token

new_leaf

boolean

Returns

void

unload()

Call Signature

unload(): void

Defined in: obsidian.d.ts:900

Unload this component and its children

Returns

void

Inherited from

Component.unload

Call Signature

unload(): void

Defined in: src/obsidian/augmentations/Components/Component.d.ts:211

Override this to unload your component.

Returns

void

Example

class MyComponent extends Component {
  public override onunload(): void {
    console.log('MyComponent unloaded');
  }
}

Inherited from

Component.unload

updateEvent()

updateEvent(): (update) => void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:259

Callback for onUpdate functionality added as an extension.

Returns

(update): void

Parameters

update

ViewUpdate

Returns

void

updateLinkPopup()

updateLinkPopup(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:264

In mobile, creates a popover link on clickable token, if exists.

Returns

void

updateOptions()

updateOptions(): void

Defined in: src/obsidian/internals/MarkdownBaseView.d.ts:269

Reconfigure/re-add all the dynamic extensions.

Returns

void