MarkdownRenderChild

Extends

• Component

Extended by

• MarkdownRenderer

Constructors

new MarkdownRenderChild()

new MarkdownRenderChild(containerEl): MarkdownRenderChild

Parameters

• containerEl: HTMLElement

This HTMLElement will be used to test whether this component is still alive. It should be a child of the Markdown preview sections, and when it’s no longer attached (for example, when it is replaced with a new version because the user edited the Markdown source code), this component will be unloaded.

Returns

MarkdownRenderChild

Overrides

Component.constructor

Properties

_children

_children: Component[]

Child Components attached to current component, will be unloaded on unloading parent component

Inherited from

Component._children

---

_events

_events: EventRef[]

Events that are attached to the current component, will be detached on unloading parent component

Inherited from

Component._events

---

_loaded

_loaded: boolean

Whether the component and its children are loaded

Inherited from

Component._loaded

---

containerEl

containerEl: HTMLElement

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

Component.addChild

---

load()

load(): void

Load this component and its children

Returns

void

Inherited from

Component.load

---

onload()

onload(): void

Override this to load your component

Returns

void

Inherited from

Component.onload

---

onunload()

onunload(): void

Override this to unload your component

Returns

void

Inherited from

Component.onunload

---

register()

register(cb): void

Registers a callback to be called when unloading

Parameters

• cb

Returns

void

Inherited from

Component.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

Component.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

Component.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

Component.registerDomEvent

---

registerEvent()

registerEvent(eventRef): void

Registers an event to be detached when unloading

Parameters

• eventRef: EventRef

Returns

void

Inherited from

Component.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

Component.registerInterval

---

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Parameters

• keymapEventHandler: KeymapEventHandler

Returns

void

Inherited from

Component.registerScopeEvent

---

removeChild()

removeChild<T>(component): T

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

Inherited from

Component.removeChild

---

unload()

unload(): void

Unload this component and its children

Returns

void

Inherited from

Component.unload