Component

Extended by

• HoverPopover
• MarkdownPreviewEvents
• MarkdownRenderChild
• Menu
• Plugin
• View
• CustomCSS
• MetadataEditor
• MetadataEditorProperty
• MarkdownBaseView
• EmbeddedEditorView
• InternalPlugin
• CanvasIndex

Constructors

new Component()

new Component(): Component

Returns

Component

Properties

_children

_children: Component[]

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

---

_events

_events: EventRef[]

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

---

_loaded

_loaded: boolean

Whether the component and its children are loaded

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

---

load()

load(): void

Load this component and its children

Returns

void

---

onload()

onload(): void

Override this to load your component

Returns

void

---

onunload()

onunload(): void

Override this to unload your component

Returns

void

---

register()

register(cb): void

Registers a callback to be called when unloading

Parameters

• cb

Returns

void

---

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

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

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

---

registerEvent()

registerEvent(eventRef): void

Registers an event to be detached when unloading

Parameters

• eventRef: EventRef

Returns

void

---

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

---

registerScopeEvent()

registerScopeEvent(keymapEventHandler): void

Parameters

• keymapEventHandler: KeymapEventHandler

Returns

void

---

removeChild()

removeChild<T>(component): T

Removes a child component, unloading it

Type Parameters

• T extends Component

Parameters

• component: T

Returns

T

---

unload()

unload(): void

Unload this component and its children

Returns

void