MarkdownRenderChild

Class: MarkdownRenderChild

Base lifecycle helper used throughout the public API.

Components can own child components and cleanup callbacks so complex views and plugins can tear themselves down predictably.

Extends

Component

Constructors

Constructor

new MarkdownRenderChild(containerEl): MarkdownRenderChild

Defined in: markdown.ts:26

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<Record<string, any>>[] = []

Defined in: view.svelte.ts:32

Inherited from

Component.children

loaded

loaded: boolean = false

Defined in: view.svelte.ts:34

Inherited from

Component.loaded

Accessors

containerEl

Get Signature

get containerEl(): HTMLElement

Defined in: view.svelte.ts:38

Returns

HTMLElement

Set Signature

set containerEl(el): void

Defined in: view.svelte.ts:42

Parameters

el

HTMLElement

Returns

void

Inherited from

Component.containerEl

Methods

addChild()

addChild<T>(component): T

Defined in: view.svelte.ts:162

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

Type Parameters

T

T extends Component<Record<string, any>>

Parameters

component

T

Returns

T

Inherited from

Component.addChild

dispatch()

dispatch<T>(eventName, …args): boolean

Defined in: events.ts:105

Type Parameters

T

T extends string

Parameters

eventName

T

args

…any[]

Returns

boolean

Inherited from

Component.dispatch

emit()

emit<T>(eventName, …args): boolean

Defined in: events.ts:98

Type Parameters

T

T extends string

Parameters

eventName

T

args

…any[]

Returns

boolean

Inherited from

Component.emit

load()

load(): void

Defined in: view.svelte.ts:51

Load this component and its children

Returns

void

Inherited from

Component.load

off()

off<T>(eventName, listener, context?, once?): void

Defined in: events.ts:78

Type Parameters

T

T extends string

Parameters

eventName

T

listener

(…args) => void

context?

any

once?

boolean

Returns

void

Inherited from

Component.off

offref()

offref<T>(ref): void

Defined in: events.ts:87

Type Parameters

T

T extends string

Parameters

ref

EventRef<Record<string, any>, T>

Returns

void

Inherited from

Component.offref

on()

on<T>(eventName, listener, context?): EventRef<Record<string, any>, T, any>

Defined in: events.ts:48

Type Parameters

T

T extends string

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<Record<string, any>, T, any>

Inherited from

Component.on

once()

once<T>(eventName, listener, context?): EventRef<Record<string, any>, T, any>

Defined in: events.ts:63

Type Parameters

T

T extends string

Parameters

eventName

T

listener

(…args) => void

context?

any

Returns

EventRef<Record<string, any>, T, any>

Inherited from

Component.once

onload()

abstract onload(): void | Promise<void>

Defined in: view.svelte.ts:65

Override this to load your component

Returns

void | Promise<void>

Inherited from

Component.onload

onunload()

abstract onunload(): void

Defined in: view.svelte.ts:122

Override this to unload your component

Returns

void

Inherited from

Component.onunload

register()

register(cb): void

Defined in: view.svelte.ts:189

Registers a callback to be called when unloading

Parameters

cb

() => any

Returns

void

Inherited from

Component.register

registerDomEvent()

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:208

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof HTMLElementEventMap

Parameters

el

HTMLElement

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:214

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof DocumentEventMap

Parameters

el

Document

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

Call Signature

registerDomEvent<K>(el, type, callback, options?): void

Defined in: view.svelte.ts:220

Registers an DOM event to be detached when unloading

Type Parameters

K

K extends keyof WindowEventMap

Parameters

el

Window

type

K

callback

(this, ev) => any

options?

boolean | AddEventListenerOptions

Returns

void

Inherited from

Component.registerDomEvent

registerEvent()

registerEvent<T, K>(eventRef): void

Defined in: view.svelte.ts:193

Type Parameters

T

T extends ValidEventTypes

K

K extends string | symbol

Parameters

eventRef

EventRef<T, K, any>

Returns

void

Inherited from

Component.registerEvent

registerInterval()

registerInterval(id): void

Defined in: view.svelte.ts:199

Parameters

id

Timeout

Returns

void

Inherited from

Component.registerInterval

removeChild()

removeChild<T>(component): T

Defined in: view.svelte.ts:176

Removes a child component, unloading it

Type Parameters

T

T extends Component<Record<string, any>>

Parameters

component

T

Returns

T

Inherited from

Component.removeChild

trigger()

trigger<T>(eventName, …args): boolean

Defined in: events.ts:91

Type Parameters

T

T extends string

Parameters

eventName

T

args

…any[]

Returns

boolean

Inherited from

Component.trigger

tryTrigger()

tryTrigger<T>(evt, …args): void

Defined in: events.ts:112

Type Parameters

T

T extends string

Parameters

evt

EventRef<Record<string, any>, T>

args

…any[]

Returns

void

Inherited from

Component.tryTrigger

unload()

unload(): void

Defined in: view.svelte.ts:92

Unload this component and its children

Returns

void

Inherited from

Component.unload