WidgetEditorView

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:15

Extends

EmbeddedEditorView

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

EmbeddedEditorView._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

EmbeddedEditorView._events

_loaded

_loaded: boolean

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

Whether the component and its children are loaded.

Inherited from

EmbeddedEditorView._loaded

after

after: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:19

Data after reference.

app

app: App

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:20

Reference to the app.

Inherited from

EmbeddedEditorView.app

before

before: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:24

Data before reference.

containerEl

containerEl: HTMLElement

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:25

Container element for the embedded view.

Inherited from

EmbeddedEditorView.containerEl

data

data: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:29

Full file contents.

dirty

dirty: boolean

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

Whether the view is currently saving.

Inherited from

EmbeddedEditorView.dirty

editable

editable: boolean

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:38

Whether the editor may be edited.

Inherited from

EmbeddedEditorView.editable

editMode?

optional editMode: IFramedMarkdownEditor

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:43

Editor component of the view.

Inherited from

EmbeddedEditorView.editMode

editorEl

editorEl: HTMLElement

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:48

Container in which the editor is embedded.

Inherited from

EmbeddedEditorView.editorEl

file

file: null | TFile

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:53

File to which the view is attached.

Inherited from

EmbeddedEditorView.file

fileBeingRenamed

fileBeingRenamed: null | TFile

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:34

File being currently renamed.

heading

heading: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:39

Current heading.

hoverPopover

hoverPopover: null | HoverPopover

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:58

Hover element container.

Inherited from

EmbeddedEditorView.hoverPopover

indent

indent: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:44

Indent.

inlineTitleEl

inlineTitleEl: HTMLElement

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:49

Inline title element.

lastSavedData

lastSavedData: null | string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:54

Full inline content string.

previewEl

previewEl: HTMLElement

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:63

Element containing the preview for the embedded markdown.

Inherited from

EmbeddedEditorView.previewEl

previewMode

previewMode: MarkdownPreviewView

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:68

Preview component of the view.

Inherited from

EmbeddedEditorView.previewMode

saveAgain

saveAgain: boolean

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:59

Whether embedding should be saved twice on save.

saving

saving: boolean

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:64

Whether the widget is currently saving.

state

state: unknown

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:73

Current state of the editor.

Inherited from

EmbeddedEditorView.state

subpath

subpath: string

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:69

Subpath reference of the path.

subpathNotFound

subpathNotFound: boolean

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:74

Whether the subpath was not found in the cache.

text

text: string

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:78

Text contents being embedded.

Inherited from

EmbeddedEditorView.text

useIframe

useIframe: boolean

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:83

Whether the view renders contents using an iFrame.

Inherited from

EmbeddedEditorView.useIframe

Accessors

editor

Get Signature

get editor(): null | IFramedMarkdownEditor

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:88

Get the preview editor, if exists.

Returns

null | IFramedMarkdownEditor

Inherited from

EmbeddedEditorView.editor

path

Get Signature

get path(): string

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:93

Get the path to the file, if any file registered.

Returns

string

Inherited from

EmbeddedEditorView.path

scroll

Get Signature

get scroll(): unknown

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:98

Get the scroll of the file renderer component.

Returns

unknown

Inherited from

EmbeddedEditorView.scroll

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

EmbeddedEditorView.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

EmbeddedEditorView.addChild

applyScope()

applyScope(scope): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:79

Push/pop current scope.

Parameters

scope

Scope

Returns

void

destroyEditor()

destroyEditor(save?): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:103

Destroy edit component editor and save contents if specified.

Parameters

save?

boolean

Returns

void

Inherited from

EmbeddedEditorView.destroyEditor

getFoldInfo()

getFoldInfo(): null | FoldInfo

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:84

Get the current folds of the editor.

Returns

null | FoldInfo

getMode()

getMode(): "source" | "preview"

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:108

Gets currently active mode (editMode returns ‘source’).

Returns

"source" | "preview"

Inherited from

EmbeddedEditorView.getMode

load()

Call Signature

load(): void

Defined in: obsidian.d.ts:889

Load this component and its children

Returns

void

Inherited from

EmbeddedEditorView.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

EmbeddedEditorView.load

loadContents()

loadContents(data, cache): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:89

Splice incoming data at according to subpath for correct reference, then update heading and render.

Parameters

data

string

cache

CachedMetadata

Returns

void

loadFile()

loadFile(): Promise<void>

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:94

Load file from cache based on stored path.

Returns

Promise<void>

loadFileInternal()

loadFileInternal(data, cache?): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:99

Load file and check if data is different from last saved data, then loads contents.

Parameters

data

string

cache?

CachedMetadata

Returns

void

onFileChanged()

onFileChanged(file, data, cache): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:104

Update representation on file finished updating.

Parameters

file

TFile

data

string

cache

CachedMetadata

Returns

void

onFileRename()

onFileRename(file, oldPath): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:109

Update representation on file rename.

Parameters

file

TAbstractFile

oldPath

string

Returns

void

onload()

onload(): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:114

On loading widget, register vault change and rename events.

Returns

void

Overrides

EmbeddedEditorView.onload

onMarkdownFold()

onMarkdownFold(): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:119

Save fold made in the editor to foldManager.

Returns

void

onMarkdownScroll()

onMarkdownScroll(): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:118

Trigger markdown scroll on workspace.

Returns

void

Inherited from

EmbeddedEditorView.onMarkdownScroll

onTitleChange()

onTitleChange(element): void

Defined in: src/obsidian/internals/WidgetEditorView.d.ts:124

On change of editor title element.

Parameters

element

HTMLElement

Returns

void

onTitleKeydown()

onTitleKeydown(event): void

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

On keypress on editor title element.

Parameters

event

KeyboardEvent

Returns

void

onTitlePaste()

onTitlePaste(element, event): void

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

On pasting on editor title element.

Parameters

element

HTMLElement

event

ClipboardEvent

Returns

void

onunload()

onunload(): void

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

On unloading widget, unload component and remove scope.

Returns

void

Overrides

EmbeddedEditorView.onunload

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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.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

EmbeddedEditorView.registerInterval

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

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

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

EmbeddedEditorView.registerScopeEvent

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

EmbeddedEditorView.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

EmbeddedEditorView.removeChild

requestSave()

requestSave(): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:128

Debounced save of contents.

Returns

void

Inherited from

EmbeddedEditorView.requestSave

requestSaveFolds()

requestSaveFolds(): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:133

Debounced save of editor folds.

Returns

void

Inherited from

EmbeddedEditorView.requestSaveFolds

save()

save(data, delayed?): Promise<void>

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

Save changes made in editable widget.

Parameters

data

string

delayed?

boolean

Returns

Promise<void>

Overrides

EmbeddedEditorView.save

saveTitle()

saveTitle(element): void

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

On blur widget, save title.

Parameters

element

HTMLElement

Returns

void

set()

set(data, clear): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:143

Set the state of the editor.

Parameters

data

string

clear

boolean

Returns

void

Inherited from

EmbeddedEditorView.set

showEditor()

showEditor(): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:148

Reveal the editor if editable widget and applies saved state.

Returns

void

Inherited from

EmbeddedEditorView.showEditor

showPreview()

showPreview(show?): void

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

Show preview of widget.

Parameters

show?

boolean

Returns

void

Overrides

EmbeddedEditorView.showPreview

showSearch()

showSearch(replace?): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:158

Reveal search component in file renderer component.

Parameters

replace?

boolean

Returns

void

Inherited from

EmbeddedEditorView.showSearch

toggleMode()

toggleMode(): void

Defined in: src/obsidian/internals/EmbeddedEditorView.d.ts:163

Toggle between edit and preview mode.

Returns

void

Inherited from

EmbeddedEditorView.toggleMode

unload()

Call Signature

unload(): void

Defined in: obsidian.d.ts:900

Unload this component and its children

Returns

void

Inherited from

EmbeddedEditorView.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

EmbeddedEditorView.unload