EmbeddedEditorView

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

Extends

• Component

Extended by

• WidgetEditorView

Properties

_children

_children: Component[]

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

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

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

Whether the component and its children are loaded

Inherited from

Component._loaded

---

app

app: App

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

Reference to the app

---

containerEl

containerEl: HTMLElement

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

Container element for the embedded view

---

dirty

dirty: boolean

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

Whether the view is currently saving

---

editable

editable: boolean

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

Whether the editor may be edited

Remark

Fun fact, setting this to true and calling showEditor() for embedded MD views, allows them to be edited. Though the experience is a little buggy

---

editMode?

optional editMode: IFramedMarkdownEditor

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

Editor component of the view

---

editorEl

editorEl: HTMLElement

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

Container in which the editor is embedded

---

file

file: null | TFile

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

File to which the view is attached

---

hoverPopover

hoverPopover: null | HoverPopover

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

Hover element container

---

previewEl

previewEl: HTMLElement

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

Element containing the preview for the embedded markdown

---

previewMode

previewMode: MarkdownPreviewView

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

Preview component of the view

---

state

state: unknown

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

Current state of the editor

---

text

text: string

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

Text contents being embedded

---

useIframe

useIframe: boolean

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

Whether the view renders contents using an iFrame

Accessors

editor

Get Signature

get editor(): null | IFramedMarkdownEditor

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

Get the preview editor, if exists

Returns

null | IFramedMarkdownEditor

---

path

Get Signature

get path(): string

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

Get the path to the file, if any file registered

Returns

string

---

scroll

Get Signature

get scroll(): unknown

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

Get the scroll of the file renderer component

Returns

unknown

Methods

addChild()

addChild<T>(component): T

Defined in: obsidian.d.ts:887

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

---

destroyEditor()

destroyEditor(save?): void

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

Destroy edit component editor and save contents if specified

Parameters

save?

boolean

Returns

void

---

getMode()

getMode(): "source" | "preview"

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

Gets currently active mode (editMode returns ‘source’)

Returns

"source" | "preview"

---

load()

load(): void

Defined in: obsidian.d.ts:865

Load this component and its children

Returns

void

Inherited from

Component.load

---

onload()

onload(): void

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

On load of editor, show preview

Returns

void

Overrides

Component.onload

---

onMarkdownScroll()

onMarkdownScroll(): void

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

Trigger markdown scroll on workspace

Returns

void

---

onunload()

onunload(): void

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

On unload of editor, destroy editor and unset workspace activeEditor

Returns

void

Overrides

Component.onunload

---

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

---

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

---

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

---

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

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

Parameters

keymapEventHandler

KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

---

removeChild()

removeChild<T>(component): T

Defined in: obsidian.d.ts:892

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

component

T

Returns

T

Inherited from

Component.removeChild

---

requestSave()

requestSave(): void

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

Debounced save of contents

Returns

void

---

requestSaveFolds()

requestSaveFolds(): void

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

Debounced save of editor folds

Returns

void

---

save()

save(data, save?): void

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

Set file contents

Parameters

data

string

save?

boolean

Returns

void

---

set()

set(data, clear): void

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

Set the state of the editor

Parameters

data

string

clear

boolean

Returns

void

---

showEditor()

showEditor(): void

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

Reveal the editor if editable widget and applies saved state

Returns

void

---

showPreview()

showPreview(save?): void

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

Reveal preview mode and destroy editor, save if specified

Parameters

save?

boolean

Returns

void

---

showSearch()

showSearch(replace?): void

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

Reveal search component in file renderer component

Parameters

replace?

boolean

Returns

void

---

toggleMode()

toggleMode(): void

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

Toggle between edit and preview mode

Returns

void

---

unload()

unload(): void

Defined in: obsidian.d.ts:876

Unload this component and its children

Returns

void

Inherited from

Component.unload