Class BaseWidget

Base class for all widgets, providing common functionality

Hierarchy (view full)

BaseWidget

Index

Constructors

Properties

api config el iframe uiPath

Methods

destroy getIframe hide isOpen onMessageExtended postCreate postDestroy postHide postShow preCreate preDestroy preHide preShow sendMessage show

Constructors

constructor

new BaseWidget(config, el, api): BaseWidget
Parameters
- config: OfcpConfig
- el: HTMLElement
- api: TecsafeApi
Returns BaseWidget
- Defined in types/BaseWidget.ts:22

Properties

`Protected` `Readonly`api

api: TecsafeApi

`Protected` `Readonly`config

config: OfcpConfig

`Protected`el

el: HTMLElement

`Protected`iframe

iframe: HTMLIFrameElement = null

The iframe element

`Protected` `Readonly`uiPath

uiPath: string = 'iframe'

The path to the iframe which will be appended to the uiBaseURL to get the full URL

Methods

destroy

destroy(): void
Destroys the widget

Returns void
void

See
BaseWidget.preDestroy BaseWidget.postDestroy
- Defined in types/BaseWidget.ts:203

getIframe

getIframe(): HTMLIFrameElement
Gets the iframe element

Returns HTMLIFrameElement
The iframe element or null if it doesn't exist currently
- Defined in types/BaseWidget.ts:194

hide

hide(): void
Hides the widget, without destroying it

Returns void
void
- Defined in types/BaseWidget.ts:215

isOpen

isOpen(): boolean
Returns whether the widget is open or not

Returns boolean
True if the widget is open, false otherwise
- Defined in types/BaseWidget.ts:185

`Protected`onMessageExtended

onMessageExtended(event): Promise<boolean>
Lifecycle hooks for extending classes
Parameters
- event: MessageEvent<any>
  The message event
Returns Promise<boolean>
Promise Whether the message was handled

See
BaseWidget.onMessage
- Defined in types/BaseWidget.ts:228

`Protected`postCreate

postCreate(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
- Defined in types/BaseWidget.ts:254

`Protected`postDestroy

postDestroy(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.destroy
- Defined in types/BaseWidget.ts:266

`Protected`postHide

postHide(): void
Lifecycle hook for extending classes

Returns void
- Defined in types/BaseWidget.ts:276

`Protected`postShow

postShow(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
- Defined in types/BaseWidget.ts:242

`Protected`preCreate

preCreate(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
- Defined in types/BaseWidget.ts:248

`Protected`preDestroy

preDestroy(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.destroy
- Defined in types/BaseWidget.ts:260

`Protected`preHide

preHide(): void
Lifecycle hook for extending classes

Returns void
- Defined in types/BaseWidget.ts:271

`Protected`preShow

preShow(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
- Defined in types/BaseWidget.ts:236

sendMessage

sendMessage(message): void
Sends a message to the iframe
Parameters
- message: Message
  The message to send
Returns void
void
- Defined in types/BaseWidget.ts:45

show

show(): void
Shows the widget, creating it if necessary

Returns void
void

See
BaseWidget.preShow BaseWidget.preCreate BaseWidget.postCreate BaseWidget.postShow
- Defined in types/BaseWidget.ts:158