MarkdownScrollableEditView

Unofficial

Both Official Unofficial

Both Own Inherited

Extended markdown editor view with scrolling, search, and CSS class management.

Import:

import type { MarkdownScrollableEditView } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface MarkdownScrollableEditView extends MarkdownBaseView

Extends: MarkdownBaseView

Constructor

new MarkdownScrollableEditView()

Constructor.

To extract the constructor type, use ExtractConstructor<Component>.

Properties

	Property	Type	Description
	_children	Component[]	Child Components attached to current component, will be unloaded on unloading parent component. (Inherited from MarkdownBaseView)
	_events	EventRef[]	Events that are attached to the current component, will be detached on unloading parent component. (Inherited from MarkdownBaseView)
	_loaded	boolean	Whether the component and its children are loaded. (Inherited from MarkdownBaseView)
	app	App	Reference to the app. (Inherited from MarkdownBaseView)
	cleanupLivePreview	(() => void) | null	Callback to clear all elements. (Inherited from MarkdownBaseView)
	clipboardManager	ClipboardManager	Manager that handles pasting text, html and images into the editor. (Inherited from MarkdownBaseView)
	cm	EditorView	Codemirror editor instance. (Inherited from MarkdownBaseView)
	cmInit	boolean	Whether CodeMirror is initialized. (Inherited from MarkdownBaseView)
	containerEl	HTMLElement	Container element of the editor view. (Inherited from MarkdownBaseView)
	cssClasses	[]	List of CSS classes applied to the editor.
	cursorPopupEl	HTMLElement | null	Popup element for internal link. (Inherited from MarkdownBaseView)
	editor?	Editor	Obsidian editor instance. (Inherited from MarkdownBaseView)
	editorEl	HTMLElement	Element in which the CodeMirror editor resides. (Inherited from MarkdownBaseView)
	editorSuggest	EditorSuggests	Editor suggester for autocompleting files, links, aliases, etc. (Inherited from MarkdownBaseView)
	isScrolling	boolean	Whether the editor is currently scrolling.
	livePreviewPlugin	Extension[]	The CodeMirror plugins that handle the rendering of, and interaction with Obsidian's Markdown. (Inherited from MarkdownBaseView)
	localExtensions	Extension[]	Local (always active) extensions for the editor. (Inherited from MarkdownBaseView)
	owner	MarkdownFileInfo	Controller of the editor view. (Inherited from MarkdownBaseView)
	scope	Scope | undefined	obsidian#Scope for the search component, if exists.
	search	EditorSearchComponent	Search component for the editor, provides highlight and search functionality.
	sizerEl	HTMLElement	Container for the editor, handles editor size.
	sourceMode	boolean	Whether live preview rendering is disabled. (Inherited from MarkdownBaseView)
	tableCell	null | TableCellEditor	Reference to editor attached to table cell, if any. (Inherited from MarkdownBaseView)

Methods

	Method	Returns	Description
	addChild(component)	T	Adds a child component, loading it if this component is loaded. (Inherited from MarkdownBaseView)
	applyFoldInfo(info)	void	Apply fold history to editor. (Inherited from MarkdownBaseView)
	applyScroll(scroll)	void	Set the scroll count of the editor scrollbar.
	buildLocalExtensions()	Extension[]	Constructs local (always active) extensions for the editor.
	clear()	void	Cleanup live preview, remove and then re-add all editor extensions. (Inherited from MarkdownBaseView)
	destroy()	void	Clean up live preview, remove all extensions, destroy editor. (Inherited from MarkdownBaseView)
	destroyTableCell(cell?)	void	Removes specified tablecell. (Inherited from MarkdownBaseView)
	editTableCell(cell, newCell)	TableCellEditor	Edit a specified table cell, creating a table cell editor. (Inherited from MarkdownBaseView)
	focus()	void	Focus the editor (and for mobile: render keyboard).
	get()	string	Get the current editor document as a string. (Inherited from MarkdownBaseView)
	getDynamicExtensions()	Extension[]	Constructs extensions for the editor based on user settings.
	getFoldInfo()	FoldInfo | null	Get the current folds of the editor. (Inherited from MarkdownBaseView)
	getLocalExtensions()	unknown	Builds all local extensions and assigns to this.localExtensions. (Inherited from MarkdownBaseView)
	getScroll()	number	Get the current scroll count of the editor scrollbar.
	handleScroll()	void	Invokes onMarkdownScroll on scroll.
	hide()	void	Hides the editor (sets display: none).
	load()	void	Load this component and its children. (Inherited from MarkdownBaseView)
	onContextMenu(event, x)	Promise<void>	Creates menu on right mouse click. (Inherited from MarkdownBaseView)
	onCssChange()	void	Clear editor cache and refreshes editor on app css change.
	onEditorClick(event, element?)	void	Execute click functionality on token on mouse click. (Inherited from MarkdownBaseView)
	onEditorDragStart(event)	void	Execute drag functionality on drag start. (Inherited from MarkdownBaseView)
	onEditorLinkMouseover(event, target)	void	Execute hover functionality on mouse over event. (Inherited from MarkdownBaseView)
	onload()	void	Override this to load your component. (Inherited from MarkdownBaseView)
	onMenu(event)	void	Execute context menu functionality on right mouse click. (Inherited from MarkdownBaseView)
	onResize()	void	Update editor size and bottom padding on resize.
	onScroll()	void	Update editor suggest position and invokes handleScroll on scroll.
	onunload()	void	Override this to unload your component (Inherited from MarkdownBaseView)
	onUpdate(update, changed)	void	Execute functionality on CM editor state update.
	onViewClick(event?)	void	Close editor suggest and removes highlights on click.
	register(cb)	void	Registers a callback to be called when unloading. (Inherited from MarkdownBaseView)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading. (Inherited from MarkdownBaseView)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from MarkdownBaseView)
	registerDomEvent(el, type, callback, options?)	void	Registers a DOM event to be detached when unloading (Inherited from MarkdownBaseView)
	registerEvent(eventRef)	void	Registers an event to be detached when unloading. (Inherited from MarkdownBaseView)
	registerInterval(id)	number	Registers an interval (from setInterval) to be cancelled when unloading. Use window.setInterval instead of setInterval to avoid TypeScript confusing between NodeJS vs Browser API (Inherited from MarkdownBaseView)
	registerScopeEvent(keymapEventHandler)	void	Register a scope keymap event handler to be removed on unload. (Inherited from MarkdownBaseView)
	reinit()	void	Reinitialize the editor inside new container. (Inherited from MarkdownBaseView)
	removeChild(component)	T	Removes a child component, unloading it. (Inherited from MarkdownBaseView)
	reparent(newContainer)	void	Move the editor into the new container. (Inherited from MarkdownBaseView)
	resetSyntaxHighlighting()	void	Bodge to reset the syntax highlighting. (Inherited from MarkdownBaseView)
	saveHistory()	void	Save history of file and data (for caching, for faster reopening of same file in editor). (Inherited from MarkdownBaseView)
	set(data, clear)	void	Set the state of the editor. (Inherited from MarkdownBaseView)
	setCssClass(classes)	void	Add classes to the editor, functions as a toggle.
	show()	void	Reveal the editor (sets display: block).
	showSearch(replace)	void	Reveal the search (and replace) component.
	toggleFoldFrontmatter()	void	Enables/disables frontmatter folding. (Inherited from MarkdownBaseView)
	toggleSource()	void	Toggle source mode for editor and dispatch effect. (Inherited from MarkdownBaseView)
	triggerClickableToken(token, newLeaf)	void	Execute functionality of token (open external link, open internal link in leaf, ...). (Inherited from MarkdownBaseView)
	unload()	void	Override this to unload your component. (Inherited from MarkdownBaseView)
	updateBottomPadding(height)	void	Update the bottom padding of the CodeMirror contentdom.
	updateEvent()	(update: ViewUpdate) => void	Callback for onUpdate functionality added as an extension. (Inherited from MarkdownBaseView)
	updateLinkPopup()	void	In mobile, creates a popover link on clickable token, if exists. (Inherited from MarkdownBaseView)
	updateOptions()	void	Reconfigure/re-add all the dynamic extensions. (Inherited from MarkdownBaseView)

---

Links to this page:

• Editor
• IFramedMarkdownEditor