Skip to main content

Class: abstract BaseMyopComponent<P, R>

Defined in: host/components/IMyopComponent.ts:80

Type Parameters

P = any

R extends RefTypes = RefTypes

Implements

Constructors

new BaseMyopComponent()

protected new BaseMyopComponent<P, R>(componentDefinition, container, options?): BaseMyopComponent<P, R>

Defined in: host/components/IMyopComponent.ts:87

Parameters

componentDefinition

IComponentDefinitionConfig

container

HTMLElement

options?

loaderOptions

Returns

BaseMyopComponent<P, R>

Properties

_markedForDisposed

_markedForDisposed: boolean = false

Defined in: host/components/IMyopComponent.ts:104


_whenInitiated

_whenInitiated: Promise<any>

Defined in: host/components/IMyopComponent.ts:208


_whenInitiatedReject()?

optional _whenInitiatedReject: (value?) => any

Defined in: host/components/IMyopComponent.ts:206

Parameters

value?

any

Returns

any


_whenInitiatedResolve()?

optional _whenInitiatedResolve: (value?) => any

Defined in: host/components/IMyopComponent.ts:205

Parameters

value?

any

Returns

any


componentDefinition

componentDefinition: IComponentDefinitionConfig

Defined in: host/components/IMyopComponent.ts:87

Implementation of

IMyopComponent.componentDefinition


container

container: HTMLElement

Defined in: host/components/IMyopComponent.ts:87

Implementation of

IMyopComponent.container


element?

optional element: HTMLElement

Defined in: host/components/IMyopComponent.ts:85

Implementation of

IMyopComponent.element


id

id: string = ''

Defined in: host/components/IMyopComponent.ts:81

Implementation of

IMyopComponent.id


isInitiated

isInitiated: boolean = false

Defined in: host/components/IMyopComponent.ts:203

Implementation of

IMyopComponent.isInitiated


messageHandlers

messageHandlers: Record<string, messageHandler<any>[]> = {}

Defined in: host/components/IMyopComponent.ts:83


props

props: P

Defined in: host/components/IMyopComponent.ts:319

Implementation of

IMyopComponent.props


refs

refs: R

Defined in: host/components/IMyopComponent.ts:320

Implementation of

IMyopComponent.refs

Accessors

markedForDisposed

Get Signature

get markedForDisposed(): boolean

Defined in: host/components/IMyopComponent.ts:106

Returns

boolean

Set Signature

set markedForDisposed(value): void

Defined in: host/components/IMyopComponent.ts:110

Parameters
value

boolean

Returns

void

Implementation of

IMyopComponent.markedForDisposed

Methods

bind()

bind<T>(messageType, handler): void

Defined in: host/components/IMyopComponent.ts:124

Type Parameters

T extends BaseMyopMessage

Parameters

messageType

string

handler

(message) => boolean

Returns

void

Implementation of

IMyopComponent.bind


bindWhen()

bindWhen<T>(messageType, predicate, handler): CleanupHandler

Defined in: host/components/IMyopComponent.ts:135

Type Parameters

T extends BaseMyopMessage

Parameters

messageType

string

predicate

(message) => boolean

handler

(message) => void

Returns

CleanupHandler


dispose()

dispose(): void

Defined in: host/components/IMyopComponent.ts:284

Returns

void

Implementation of

IMyopComponent.dispose


hide()

abstract hide(): void

Defined in: host/components/IMyopComponent.ts:117

Returns

void

Implementation of

IMyopComponent.hide


initiated()

initiated(): Promise<any>

Defined in: host/components/IMyopComponent.ts:213

Returns

Promise<any>

Implementation of

IMyopComponent.initiated


inspect()

abstract inspect(): CleanupHandler

Defined in: host/components/IMyopComponent.ts:121

Returns

CleanupHandler

Implementation of

IMyopComponent.inspect


onMessageReceived()

onMessageReceived(incomeMessage): boolean

Defined in: host/components/IMyopComponent.ts:165

Parameters

incomeMessage

BaseMyopMessage

Returns

boolean

Implementation of

IMyopComponent.onMessageReceived


send()

send(message): CleanupHandler

Defined in: host/components/IMyopComponent.ts:238

Parameters

message

BaseMyopMessage

Returns

CleanupHandler

Implementation of

IMyopComponent.send


setInitiated()

setInitiated(): void

Defined in: host/components/IMyopComponent.ts:196

Returns

void

Implementation of

IMyopComponent.setInitiated


show()

abstract show(): void

Defined in: host/components/IMyopComponent.ts:119

Returns

void

Implementation of

IMyopComponent.show