WidgetEditorView
Extends
Properties
_children
_children:
Component[]
Child Components attached to current component, will be unloaded on unloading parent component
Inherited from
_events
_events:
EventRef[]
Events that are attached to the current component, will be detached on unloading parent component
Inherited from
_loaded
_loaded:
boolean
Whether the component and its children are loaded
Inherited from
after
after:
string
Data after reference
app
app:
App
Reference to the app
Inherited from
before
before:
string
Data before reference
containerEl
containerEl:
HTMLElement
Container element for the embedded view
Inherited from
EmbeddedEditorView.containerEl
data
data:
string
Full file contents
dirty
dirty:
boolean
Whether the view is currently saving
Inherited from
editable
editable:
boolean
Whether the editor may be edited
Inherited from
editMode?
optionaleditMode:IFramedMarkdownEditor
Editor component of the view
Inherited from
editorEl
editorEl:
HTMLElement
Container in which the editor is embedded
Inherited from
file
file:
null|TFile
File to which the view is attached
Inherited from
fileBeingRenamed
fileBeingRenamed:
null|TFile
File being currently renamed
heading
heading:
string
Current heading
hoverPopover
hoverPopover:
null|HoverPopover
Hover element container
Inherited from
EmbeddedEditorView.hoverPopover
indent
indent:
string
Indent
inlineTitleEl
inlineTitleEl:
HTMLElement
Inline title element
lastSavedData
lastSavedData:
null|string
Full inline content string
previewEl
previewEl:
HTMLElement
Element containing the preview for the embedded markdown
Inherited from
previewMode
previewMode:
MarkdownPreviewView
Preview component of the view
Inherited from
EmbeddedEditorView.previewMode
saveAgain
saveAgain:
boolean
Whether embedding should be saved twice on save
saving
saving:
boolean
Whether the widget is currently saving
state
state:
unknown
Current state of the editor
Inherited from
subpath
subpath:
string
Subpath reference of the path
subpathNotFound
subpathNotFound:
boolean
Whether the subpath was not found in the cache
text
text:
string
Text contents being embedded
Inherited from
useIframe
useIframe:
boolean
Whether the view renders contents using an iFrame
Inherited from
Accessors
editor
geteditor():null|IFramedMarkdownEditor
Get the preview editor, if exists
Returns
null | IFramedMarkdownEditor
Inherited from
path
getpath():string
Get the path to the file, if any file registered
Returns
string
Inherited from
scroll
getscroll():unknown
Get the scroll of the file renderer component
Returns
unknown
Inherited from
Methods
addChild()
addChild<
T>(component):T
Adds a child component, loading it if this component is loaded
Type Parameters
• T extends Component
Parameters
• component: T
Returns
T
Inherited from
applyScope()
applyScope(
scope):void
Push/pop current scope
Parameters
• scope: Scope
Returns
void
destroyEditor()
destroyEditor(
save?):void
Destroy edit component editor and save contents if specified
Parameters
• save?: boolean
Returns
void
Inherited from
EmbeddedEditorView.destroyEditor
getFoldInfo()
getFoldInfo():
null|FoldInfo
Get the current folds of the editor
Returns
null | FoldInfo
getMode()
getMode():
"source"|"preview"
Gets currently active mode (editMode returns ‘source’)
Returns
"source" | "preview"
Inherited from
load()
load():
void
Load this component and its children
Returns
void
Inherited from
loadContents()
loadContents(
data,cache):void
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>
Load file from cache based on stored path
Returns
Promise<void>
loadFileInternal()
loadFileInternal(
data,cache?):void
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
Update representation on file finished updating
Parameters
• file: TFile
• data: string
• cache: CachedMetadata
Returns
void
onFileRename()
onFileRename(
file,oldPath):void
Update representation on file rename
Parameters
• file: TAbstractFile
• oldPath: string
Returns
void
onload()
onload():
void
On loading widget, register vault change and rename events
Returns
void
Overrides
onMarkdownFold()
onMarkdownFold():
void
Save fold made in the editor to foldManager
Returns
void
onMarkdownScroll()
onMarkdownScroll():
void
Trigger markdown scroll on workspace
Returns
void
Inherited from
EmbeddedEditorView.onMarkdownScroll
onunload()
onunload():
void
On unloading widget, unload component and remove scope
Returns
void
Overrides
register()
register(
cb):void
Registers a callback to be called when unloading
Parameters
• cb
Returns
void
Inherited from
registerDomEvent()
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof WindowEventMap
Parameters
• el: Window
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
EmbeddedEditorView.registerDomEvent
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof DocumentEventMap
Parameters
• el: Document
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
EmbeddedEditorView.registerDomEvent
registerDomEvent(el, type, callback, options)
registerDomEvent<
K>(el,type,callback,options?):void
Registers an DOM event to be detached when unloading
Type Parameters
• K extends keyof HTMLElementEventMap
Parameters
• el: HTMLElement
• type: K
• callback
• options?: boolean | AddEventListenerOptions
Returns
void
Inherited from
EmbeddedEditorView.registerDomEvent
registerEvent()
registerEvent(
eventRef):void
Registers an event to be detached when unloading
Parameters
• eventRef: EventRef
Returns
void
Inherited from
EmbeddedEditorView.registerEvent
registerInterval()
registerInterval(
id):number
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
registerScopeEvent()
registerScopeEvent(
keymapEventHandler):void
Parameters
• keymapEventHandler: KeymapEventHandler
Returns
void
Inherited from
EmbeddedEditorView.registerScopeEvent
removeChild()
removeChild<
T>(component):T
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
• component: T
Returns
T
Inherited from
EmbeddedEditorView.removeChild
requestSave()
requestSave():
void
Debounced save of contents
Returns
void
Inherited from
EmbeddedEditorView.requestSave
requestSaveFolds()
requestSaveFolds():
void
Debounced save of editor folds
Returns
void
Inherited from
EmbeddedEditorView.requestSaveFolds
save()
save(
data,delayed?):Promise<void>
Save changes made in editable widget
Parameters
• data: string
• delayed?: boolean
Returns
Promise<void>
Overrides
saveTitle()
saveTitle(
element):void
On blur widget, save title
Parameters
• element: HTMLElement
Returns
void
set()
set(
data,clear):void
Set the state of the editor
Parameters
• data: string
• clear: boolean
Returns
void
Inherited from
showEditor()
showEditor():
void
Reveal the editor if editable widget and applies saved state
Returns
void
Inherited from
showPreview()
showPreview(
show?):void
Show preview of widget
Parameters
• show?: boolean
Returns
void
Overrides
EmbeddedEditorView.showPreview
showSearch()
showSearch(
replace?):void
Reveal search component in file renderer component
Parameters
• replace?: boolean
Returns
void
Inherited from
toggleMode()
toggleMode():
void
Toggle between edit and preview mode
Returns
void
Inherited from
unload()
unload():
void
Unload this component and its children
Returns
void