Skip to main content

Interface: IMyopComponent<P, R>

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

Type Parameters

P = any

R = any

Properties

componentDefinition

componentDefinition: IComponentDefinitionConfig

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


container

container: HTMLElement

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


dispose()

dispose: () => void

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

Returns

void


element?

optional element: HTMLElement

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


id

id: string

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


initiated()

initiated: () => Promise<any>

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

Returns

Promise<any>


isInitiated

isInitiated: boolean

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


markedForDisposed

markedForDisposed: boolean

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


onMessageReceived()

onMessageReceived: (msg) => boolean

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

Parameters

msg

BaseMyopMessage

Returns

boolean


parent?

optional parent: IMyopComponent

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


props

props: P

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


refs

refs: R

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


send()

send: (msg) => CleanupHandler

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

Parameters

msg

BaseMyopMessage

Returns

CleanupHandler


setInitiated()

setInitiated: () => void

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

Returns

void

Methods

bind()

Call Signature

bind(messageType, handler): void

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

Parameters
messageType

MyopMessageKey

handler

() => boolean

Returns

void

Call Signature

bind<T>(messageType, handler): void

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

Type Parameters

T extends BaseMyopMessage

Parameters
messageType

MyopMessageKey

handler

(message) => boolean

Returns

void


hide()

hide(): void

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

Returns

void


inspect()

inspect(): void

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

Returns

void


show()

show(): void

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

Returns

void