MarkdownRenderer

MarkdownRenderer class

Signature:

export abstract class MarkdownRenderer extends MarkdownRenderChild implements MarkdownPreviewEvents, HoverParent 

Extends: MarkdownRenderChild

Implements: MarkdownPreviewEvents, HoverParent

Constructors

ConstructorModifiersDescription
(constructor)(containerEl)

Constructs a new instance of the MarkdownRenderChild class

(Inherited from MarkdownRenderChild)

Properties

PropertyModifiersTypeDescription
appApp
containerElHTMLElement

(Inherited from MarkdownRenderChild)

file

abstract

readonly

TFile
hoverPopoverHoverPopover

Methods

MethodModifiersDescription
addChild(component)

Adds a child component, loading it if this component is loaded

(Inherited from Component)

load()

Load this component and its children

(Inherited from Component)

onload()

Override this to load your component

(Inherited from Component)

onunload()

Override this to unload your component

(Inherited from Component)

register(cb)

Registers a callback to be called when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerDomEvent(el, type, callback, options)

Registers an DOM event to be detached when unloading

(Inherited from Component)

registerEvent(eventRef)

Registers an event to be detached when unloading

(Inherited from Component)

registerInterval(id)

Registers an interval (from setInterval) to be cancelled when unloading Use instead of to avoid TypeScript confusing between NodeJS vs Browser API

(Inherited from Component)

removeChild(component)

Removes a child component, unloading it

(Inherited from Component)

render(app, markdown, el, sourcePath, component)staticRenders Markdown string to an HTML element.
renderMarkdown(markdown, el, sourcePath, component)staticRenders Markdown string to an HTML element.
unload()

Unload this component and its children

(Inherited from Component)