Class BaseWidget

Base class for all widgets, providing common functionality

Hierarchy (view full)

EventBus
- BaseWidget

Implements

IWidget

Index

Constructors

Properties

api config el iframe listeners uiPath

Methods

destroy emit getIframe getMessageListeners hide isOpen off on onMessageExtended once postCreate postDestroy postHide postShow preCreate preDestroy preHide preShow sendMessage show trigger

Constructors

constructor

new BaseWidget(config, el, api): BaseWidget
Parameters
- config: WidgetManagerConfig
- el: HTMLElement
- api: TecsafeWidgetManager
Returns BaseWidget
Overrides EventBus.constructor
- Defined in types/BaseWidget.ts:23

Properties

`Protected` `Readonly`api

api: TecsafeWidgetManager

`Protected` `Readonly`config

config: WidgetManagerConfig

`Protected`el

el: HTMLElement

`Protected`iframe

iframe: HTMLIFrameElement = null

The iframe element

`Protected`listeners

listeners: Map<string, MessageEventHandler<any>[]> = ...

`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:149

emit

emit<P>(message, payload): this
Emits a message to the iframe
Type Parameters
- P
Parameters
- message: MessageDefinition<P>
  The message definition
- payload: P
  The payload to send
Returns this
this
- Defined in types/BaseWidget.ts:202

getIframe

getIframe(): HTMLIFrameElement
Gets the iframe element

Returns HTMLIFrameElement
The iframe element or null if it doesn't exist currently
Implementation of IWidget.getIframe
- Defined in types/BaseWidget.ts:139

getMessageListeners

getMessageListeners(): string[]
Gets the list of message types that have listeners registered

Returns string[]
The list of message types
Implementation of IWidget.getMessageListeners
Inherited from EventBus.getMessageListeners
- Defined in util/EventBus.ts:99

hide

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

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

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

off

off<P>(message, handler): this
Stops listening to a message from the iframe
Type Parameters
- P
Parameters
- message: MessageDefinition<P>
  The message definition
- handler: MessageEventHandler<P>
  The handler to remove
Returns this
this
Overrides EventBus.off
- Defined in types/BaseWidget.ts:189

on

on<P>(message, handler): this
Listens to a message from the iframe
Type Parameters
- P
Parameters
- message: MessageDefinition<P>
  The message definition
- handler: MessageEventHandler<P>
  The handler to call when the message is received
Returns this
this
Overrides EventBus.on
- Defined in types/BaseWidget.ts:163

`Protected`onMessageExtended

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

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

once

once<P>(message, handler): this
Listens to a message from the iframe once
Type Parameters
- P
Parameters
- message: MessageDefinition<P>
  The message definition
- handler: MessageEventHandler<P>
  The handler to call when the message is received
Returns this
this
Overrides EventBus.once
- Defined in types/BaseWidget.ts:176

`Protected`postCreate

postCreate(): void
Lifecycle hook for extending classes

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

`Protected`postDestroy

postDestroy(): void
Lifecycle hook for extending classes

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

`Protected`postHide

postHide(): void
Lifecycle hook for extending classes

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

`Protected`postShow

postShow(): void
Lifecycle hook for extending classes

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

`Protected`preCreate

preCreate(): void
Lifecycle hook for extending classes

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

`Protected`preDestroy

preDestroy(): void
Lifecycle hook for extending classes

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

`Protected`preHide

preHide(): void
Lifecycle hook for extending classes

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

`Protected`preShow

preShow(): void
Lifecycle hook for extending classes

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

sendMessage

sendMessage(message): void
Sends a message to the iframe
Parameters
- message: OutMessageEnvelope
  The message to send
Returns void
void
Implementation of IWidget.sendMessage
- Defined in types/BaseWidget.ts:47

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

`Protected`trigger

trigger(type, envelope, sdk, widget): void
Triggers all listeners for a given message type
Parameters
- type: string
  The message type
- envelope: MessageEnvelope<any>
  The message envelope containing the payload
- sdk: ISDK
  The SDK instance
- widget: IWidget
  The widget instance
Returns void
Inherited from EventBus.trigger
- Defined in util/EventBus.ts:75