Class: abstract BaseMyopComponent<P, R>

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

Extended by

• MyopExtractedWebComponent

Type Parameters

• P = any

• R extends RefTypes = RefTypes

Implements

• IMyopComponent<P>

Constructors

new BaseMyopComponent()

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

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

Parameters

componentDefinition

IComponentDefinitionConfig

container

HTMLElement

options?

loaderOptions

Returns

BaseMyopComponent<P, R>

Properties

_markedForDisposed

_markedForDisposed: boolean = false

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

---

_whenInitiated

_whenInitiated: Promise<any>

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

---

_whenInitiatedReject()?

optional _whenInitiatedReject: (value?) => any

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

Parameters

value?

any

Returns

any

---

_whenInitiatedResolve()?

optional _whenInitiatedResolve: (value?) => any

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

Parameters

value?

any

Returns

any

---

componentDefinition

componentDefinition: IComponentDefinitionConfig

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

Implementation of

IMyopComponent.componentDefinition

---

container

container: HTMLElement

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

Implementation of

IMyopComponent.container

---

element?

optional element: HTMLElement

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

Implementation of

IMyopComponent.element

---

id

id: string = ''

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

Implementation of

IMyopComponent.id

---

isInitiated

isInitiated: boolean = false

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

Implementation of

IMyopComponent.isInitiated

---

messageHandlers

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

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

---

props

props: P

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

Implementation of

IMyopComponent.props

---

refs

refs: R

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

Implementation of

IMyopComponent.refs

Accessors

markedForDisposed

Get Signature

get markedForDisposed(): boolean

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

Returns

boolean

Set Signature

set markedForDisposed(value): void

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

Parameters

value

boolean

Returns

void

Implementation of

IMyopComponent.markedForDisposed

---

uiTags

Get Signature

get uiTags(): string[]

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

Runtime tags: only tags named ui:... (e.g. ui:beta). [] when there are none.

Returns

string[]

Runtime tags: only tags named ui:... (e.g. ui:beta). [] when there are none.

Implementation of

IMyopComponent.uiTags

Methods

bind()

bind<T>(messageType, handler): void

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

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:210

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:371

Returns

void

Implementation of

IMyopComponent.dispose

---

hide()

abstract hide(): void

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

Returns

void

Implementation of

IMyopComponent.hide

---

initiated()

initiated(): Promise<any>

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

Returns

Promise<any>

Implementation of

IMyopComponent.initiated

---

inspect()

abstract inspect(): CleanupHandler

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

Returns

CleanupHandler

Implementation of

IMyopComponent.inspect

---

onMessageReceived()

onMessageReceived(incomeMessage): boolean

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

Parameters

incomeMessage

BaseMyopMessage

Returns

boolean

Implementation of

IMyopComponent.onMessageReceived

---

send()

send(message): CleanupHandler

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

Parameters

message

BaseMyopMessage

Returns

CleanupHandler

Implementation of

IMyopComponent.send

---

setInitiated()

setInitiated(): void

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

Returns

void

Implementation of

IMyopComponent.setInitiated

---

show()

abstract show(): void

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

Returns

void

Implementation of

IMyopComponent.show