IFramedMarkdownEditor
Extends
Properties
_children
_children:
Component[]
Child Components attached to current component, will be unloaded on unloading parent component
Inherited from
MarkdownScrollableEditView._children
_events
_events:
EventRef[]
Events that are attached to the current component, will be detached on unloading parent component
Inherited from
MarkdownScrollableEditView._events
_loaded
_loaded:
boolean
Whether the component and its children are loaded
Inherited from
MarkdownScrollableEditView._loaded
app
app:
App
Reference to the app
Inherited from
MarkdownScrollableEditView.app
cleanup
cleanup:
null| () =>void
Function that cleans up the iframe and listeners
cleanupLivePreview
cleanupLivePreview:
null| () =>void
Callback to clear all elements
Inherited from
MarkdownScrollableEditView.cleanupLivePreview
clipboardManager
clipboardManager:
ClipBoardManager
Manager that handles pasting text, html and images into the editor
Inherited from
MarkdownScrollableEditView.clipboardManager
cm
cm:
EditorView
Codemirror editor instance
Inherited from
cmInit
cmInit:
boolean
Whether CodeMirror is initialized
Inherited from
MarkdownScrollableEditView.cmInit
containerEl
containerEl:
HTMLElement
Container element of the editor view
Inherited from
MarkdownScrollableEditView.containerEl
cssClasses
cssClasses: []
List of CSS classes applied to the editor
Inherited from
MarkdownScrollableEditView.cssClasses
cursorPopupEl
cursorPopupEl:
null|HTMLElement
Popup element for internal link
Inherited from
MarkdownScrollableEditView.cursorPopupEl
editor?
optionaleditor:Editor
Obsidian editor instance
Inherited from
MarkdownScrollableEditView.editor
editorEl
editorEl:
HTMLElement
Element in which the CodeMirror editor resides
Inherited from
MarkdownScrollableEditView.editorEl
editorSuggest
editorSuggest:
EditorSuggests
Editor suggester for autocompleting files, links, aliases, etc.
Inherited from
MarkdownScrollableEditView.editorSuggest
iframeEl
iframeEl:
null|HTMLIFrameElement
Element where the editor is embedded into
isScrolling
isScrolling:
boolean
Whether the editor is currently scrolling
Inherited from
MarkdownScrollableEditView.isScrolling
livePreviewPlugin
livePreviewPlugin:
Extension[]
The CodeMirror plugins that handle the rendering of, and interaction with Obsidian’s Markdown
Inherited from
MarkdownScrollableEditView.livePreviewPlugin
localExtensions
localExtensions:
Extension[]
Local (always active) extensions for the editor
Inherited from
MarkdownScrollableEditView.localExtensions
owner
owner:
MarkdownFileInfo
Controller of the editor view
Inherited from
MarkdownScrollableEditView.owner
scope
scope:
undefined|Scope
Scope for the search component, if exists
Inherited from
MarkdownScrollableEditView.scope
search
search:
EditorSearchComponent
Search component for the editor, provides highlight and search functionality
Inherited from
MarkdownScrollableEditView.search
sizerEl
sizerEl:
HTMLElement
Container for the editor, handles editor size
Inherited from
MarkdownScrollableEditView.sizerEl
sourceMode
sourceMode:
boolean
Whether live preview rendering is disabled
Inherited from
MarkdownScrollableEditView.sourceMode
tableCell
tableCell:
null|TableCellEditor
Reference to editor attached to table cell, if any
Inherited from
MarkdownScrollableEditView.tableCell
Accessors
activeCM
getactiveCM():EditorView
Currently active CM instance (table cell CM or main CM)
Returns
EditorView
Inherited from
MarkdownScrollableEditView.activeCM
file
getfile():null|TFile
Returns attached file of the owner instance
Returns
null | TFile
Inherited from
MarkdownScrollableEditView.file
path
getpath():string
Returns path of the attached file
Returns
string
Inherited from
MarkdownScrollableEditView.path
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
MarkdownScrollableEditView.addChild
applyFoldInfo()
applyFoldInfo(
info):void
Apply fold history to editor
Parameters
• info: FoldInfo
Returns
void
Inherited from
MarkdownScrollableEditView.applyFoldInfo
applyScroll()
applyScroll(
scroll):void
Set the scroll count of the editor scrollbar
Parameters
• scroll: number
Returns
void
Inherited from
MarkdownScrollableEditView.applyScroll
buildLocalExtensions()
buildLocalExtensions():
Extension[]
Constructs local (always active) extensions for the editor
Returns
Extension[]
Inherited from
MarkdownScrollableEditView.buildLocalExtensions
cleanupIframe()
cleanupIframe():
void
Executes cleanup function if exists
Returns
void
clear()
clear():
void
Cleanup live preview, remove and then re-add all editor extensions
Returns
void
Inherited from
MarkdownScrollableEditView.clear
destroy()
destroy():
void
Clean up live preview, remove all extensions, destroy editor
Returns
void
Inherited from
MarkdownScrollableEditView.destroy
destroyTableCell()
destroyTableCell(
cell?):void
Removes specified tablecell
Parameters
• cell?: TableCellEditor
Returns
void
Inherited from
MarkdownScrollableEditView.destroyTableCell
editTableCell()
editTableCell(
cell,new_cell):TableCellEditor
Edit a specified table cell, creating a table cell editor
Parameters
• cell: TableEditor
• new_cell: TableCell
Returns
Inherited from
MarkdownScrollableEditView.editTableCell
focus()
focus():
void
Focus the editor (and for mobile: render keyboard)
Returns
void
Inherited from
MarkdownScrollableEditView.focus
get()
get():
string
Get the current editor document as a string
Returns
string
Inherited from
MarkdownScrollableEditView.get
getDynamicExtensions()
getDynamicExtensions():
Extension[]
Constructs extensions for the editor based on user settings
Returns
Extension[]
Overrides
MarkdownScrollableEditView.getDynamicExtensions
getFoldInfo()
getFoldInfo():
null|FoldInfo
Get the current folds of the editor
Returns
null | FoldInfo
Inherited from
MarkdownScrollableEditView.getFoldInfo
getLocalExtensions()
getLocalExtensions():
unknown
Builds all local extensions and assigns to this.localExtensions
Returns
unknown
Inherited from
MarkdownScrollableEditView.getLocalExtensions
getScroll()
getScroll():
number
Get the current scroll count of the editor scrollbar
Returns
number
Inherited from
MarkdownScrollableEditView.getScroll
handleScroll()
handleScroll():
void
Invokes onMarkdownScroll on scroll
Returns
void
Inherited from
MarkdownScrollableEditView.handleScroll
hide()
hide():
void
Hides the editor (sets display: none)
Returns
void
Inherited from
MarkdownScrollableEditView.hide
load()
load():
void
Load this component and its children
Returns
void
Inherited from
MarkdownScrollableEditView.load
onContextMenu()
onContextMenu(
event,x):Promise<void>
Creates menu on right mouse click
Parameters
• event: PointerEvent
• x: boolean
Returns
Promise<void>
Inherited from
MarkdownScrollableEditView.onContextMenu
onCssChange()
onCssChange():
void
Clear editor cache and refreshes editor on app css change
Returns
void
Inherited from
MarkdownScrollableEditView.onCssChange
onEditorClick()
onEditorClick(
event,element?):void
Execute click functionality on token on mouse click
Parameters
• event: MouseEvent
• element?: HTMLElement
Returns
void
Inherited from
MarkdownScrollableEditView.onEditorClick
onEditorDragStart()
onEditorDragStart(
event):void
Execute drag functionality on drag start
Parameters
• event: DragEvent
Returns
void
Inherited from
MarkdownScrollableEditView.onEditorDragStart
onEditorLinkMouseover()
onEditorLinkMouseover(
event,target):void
Execute hover functionality on mouse over event
Parameters
• event: MouseEvent
• target: HTMLElement
Returns
void
Inherited from
MarkdownScrollableEditView.onEditorLinkMouseover
onIframeLoad()
onIframeLoad():
void
Loads the iframe element and prepare cleanup function
Returns
void
onload()
onload():
void
Override this to load your component
Returns
void
Inherited from
MarkdownScrollableEditView.onload
onMenu()
onMenu(
event):void
Execute context menu functionality on right mouse click
Parameters
• event: MouseEvent
Returns
void
Inherited from
MarkdownScrollableEditView.onMenu
onResize()
onResize():
void
Update editor size and bottom padding on resize
Returns
void
Inherited from
MarkdownScrollableEditView.onResize
onScroll()
onScroll():
void
Update editor suggest position and invokes handleScroll on scroll
Returns
void
Inherited from
MarkdownScrollableEditView.onScroll
onunload()
onunload():
void
Execute cleanup of the iframe
Returns
void
Overrides
MarkdownScrollableEditView.onunload
onUpdate()
onUpdate(
update,changed):void
Execute functionality on CM editor state update
Parameters
• update: ViewUpdate
• changed: boolean
Returns
void
Overrides
MarkdownScrollableEditView.onUpdate
onViewClick()
onViewClick(
event?):void
Close editor suggest and removes highlights on click
Parameters
• event?: MouseEvent
Returns
void
Inherited from
MarkdownScrollableEditView.onViewClick
register()
register(
cb):void
Registers a callback to be called when unloading
Parameters
• cb
Returns
void
Inherited from
MarkdownScrollableEditView.register
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
MarkdownScrollableEditView.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
MarkdownScrollableEditView.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
MarkdownScrollableEditView.registerDomEvent
registerEvent()
registerEvent(
eventRef):void
Registers an event to be detached when unloading
Parameters
• eventRef: EventRef
Returns
void
Inherited from
MarkdownScrollableEditView.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
MarkdownScrollableEditView.registerInterval
registerScopeEvent()
registerScopeEvent(
keymapEventHandler):void
Parameters
• keymapEventHandler: KeymapEventHandler
Returns
void
Inherited from
MarkdownScrollableEditView.registerScopeEvent
reinit()
reinit():
void
Reinitialize the editor inside new container
Returns
void
Inherited from
MarkdownScrollableEditView.reinit
removeChild()
removeChild<
T>(component):T
Removes a child component, unloading it
Type Parameters
• T extends Component
Parameters
• component: T
Returns
T
Inherited from
MarkdownScrollableEditView.removeChild
reparent()
reparent(
new_container):void
Move the editor into the new container
Parameters
• new_container: HTMLElement
Returns
void
Inherited from
MarkdownScrollableEditView.reparent
resetSyntaxHighlighting()
resetSyntaxHighlighting():
void
Bodge to reset the syntax highlighting
Returns
void
Inherited from
MarkdownScrollableEditView.resetSyntaxHighlighting
set()
set(
data,clear):void
Set the state of the editor
Parameters
• data: string
• clear: boolean
Returns
void
Inherited from
MarkdownScrollableEditView.set
setCssClass()
setCssClass(
classes):void
Add classes to the editor, functions as a toggle
Parameters
• classes: string[]
Returns
void
Inherited from
MarkdownScrollableEditView.setCssClass
show()
show():
void
Reveal the editor (sets display: block)
Returns
void
Inherited from
MarkdownScrollableEditView.show
showSearch()
showSearch(
replace):void
Reveal the search (and replace) component
Parameters
• replace: boolean
Returns
void
Inherited from
MarkdownScrollableEditView.showSearch
toggleFoldFrontmatter()
toggleFoldFrontmatter():
void
Enables/disables frontmatter folding
Returns
void
Inherited from
MarkdownScrollableEditView.toggleFoldFrontmatter
toggleSource()
toggleSource():
void
Toggle source mode for editor and dispatch effect
Returns
void
Inherited from
MarkdownScrollableEditView.toggleSource
triggerClickableToken()
triggerClickableToken(
token,new_leaf):void
Execute functionality of token (open external link, open internal link in leaf, …)
Parameters
• token: Token
• new_leaf: boolean
Returns
void
Inherited from
MarkdownScrollableEditView.triggerClickableToken
unload()
unload():
void
Unload this component and its children
Returns
void
Inherited from
MarkdownScrollableEditView.unload
updateBottomPadding()
updateBottomPadding(
height):void
Update the bottom padding of the CodeMirror contentdom
Parameters
• height: number
Returns
void
Inherited from
MarkdownScrollableEditView.updateBottomPadding
updateLinkPopup()
updateLinkPopup():
void
In mobile, creates a popover link on clickable token, if exists
Returns
void
Inherited from
MarkdownScrollableEditView.updateLinkPopup
updateOptions()
updateOptions():
void
Reconfigure/re-add all the dynamic extensions
Returns
void