Class AppWidget

The WidgetManager does handle creation and destruction of this widget under the hood. A widget that takes up the full screen, and is used to display different parts of the app.

Index

Constructors

constructor

Properties

api config el iframe listeners uiPath url

Constructors

constructor

new AppWidget(config, el, api): AppWidget
Creates a new BaseWidget, not recommended to use directly, use the widget manager instead
Parameters
- config: WidgetManagerConfig
  The widget manager configuration
- el: HTMLElement
  The element to attach the widget to
- api: TecsafeWidgetManager
  The widget manager API
Returns AppWidget
See
TecsafeWidgetManager.createCustomPageWidget
Inherited from BaseWidget.constructor
- Defined in types/BaseWidget.ts:30

Properties

`Protected` `Readonly`api

api: TecsafeWidgetManager

The widget manager API

`Protected` `Readonly`config

config: WidgetManagerConfig

The widget manager configuration

`Protected`el

el: HTMLElement

The element to attach the widget to

`Protected`iframe

iframe: HTMLIFrameElement = null

The iframe element

`Protected`listeners

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

`Protected` `Readonly`uiPath

uiPath: "" = ''

Not required for AppWidget, as it uses url instead of uiPath

See

AppWidget.url

`Protected`url

url: string

The app widget allows any origin defined in the config, so it does not have a uiPath

See

AppWidget.setUrl AppWidget.getUrl

Methods

destroy

destroy(): void
Destroys the widget

Returns void
void
See
- BaseWidget.preDestroy
- BaseWidget.postDestroy
Inherited from BaseWidget.destroy
- Defined in types/BaseWidget.ts:156

emit

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

getIframe

getIframe(): HTMLIFrameElement
Gets the iframe element

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

getMessageListeners

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

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

getUrl

getUrl(): string
Gets the url of the widget

Returns string
The url of the widget

See
AppWidget.setUrl AppWidget.url
- Defined in widget/AppWidget.ts:43

`Protected`handlePageLoad

handlePageLoad(): void
If the iframe loads a new page, stores the url in the get parameters of the parent page. This ensures if a user refreshes the page, they will be taken back to the same place.

Returns void
- Defined in widget/AppWidget.ts:75

hide

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

Returns void
void
Inherited from BaseWidget.hide
- Defined in types/BaseWidget.ts:224

isOpen

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

Returns boolean
True if the widget is open, false otherwise
Implementation of IAppWidget.isOpen
Inherited from BaseWidget.isOpen
- Defined in types/BaseWidget.ts:137

off

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

on

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

`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
Inherited from BaseWidget.onMessageExtended
- Defined in types/BaseWidget.ts:237

once

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

`Protected`postCreate

postCreate(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
Overrides BaseWidget.postCreate
- Defined in widget/AppWidget.ts:60

`Protected`postDestroy

postDestroy(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.destroy
Overrides BaseWidget.postDestroy
- Defined in widget/AppWidget.ts:117

`Protected`postHide

postHide(): void
Lifecycle hook for extending classes

Returns void
Overrides BaseWidget.postHide
- Defined in widget/AppWidget.ts:125

`Protected`postShow

postShow(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
Overrides BaseWidget.postShow
- Defined in widget/AppWidget.ts:92

`Protected`preCreate

preCreate(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
Overrides BaseWidget.preCreate
- Defined in widget/AppWidget.ts:50

`Protected`preDestroy

preDestroy(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.destroy
Inherited from BaseWidget.preDestroy
- Defined in types/BaseWidget.ts:271

`Protected`preHide

preHide(): void
Lifecycle hook for extending classes

Returns void
Inherited from BaseWidget.preHide
- Defined in types/BaseWidget.ts:282

`Protected`preShow

preShow(): void
Lifecycle hook for extending classes

Returns void
See
BaseWidget.show
Inherited from BaseWidget.preShow
- Defined in types/BaseWidget.ts:247

`Protected`resetParentPage

resetParentPage(): void
Resets the parent page to its original state after the widget is hidden or destroyed

Returns void
- Defined in widget/AppWidget.ts:107

sendMessage

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

setUrl

setUrl(url): void
Sets the url of the widget
Parameters
- url: string
  The url of the widget
Returns void
Throws
If the url is not allowed by the config

See
AppWidget.url AppWidget.getUrl
- Defined in widget/AppWidget.ts:26

show

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

Returns void
void

See
BaseWidget.preShow BaseWidget.preCreate BaseWidget.postCreate BaseWidget.postShow
Inherited from BaseWidget.show
- Defined in types/BaseWidget.ts:110

`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 BaseWidget.trigger
- Defined in util/EventBus.ts:74

Class AppWidget

See

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AppWidget

See

Properties

Protected Readonlyapi

Protected Readonlyconfig

Protectedel

Protectediframe

Protectedlisteners

Protected ReadonlyuiPath

See

Protectedurl

See

Methods

destroy

Returns void

See

emit

Type Parameters

Parameters

Returns this

getIframe

Returns HTMLIFrameElement

getMessageListeners

Returns string[]

getUrl

Returns string

See

ProtectedhandlePageLoad

Returns void

hide

Returns void

isOpen

Returns boolean

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

ProtectedonMessageExtended

Parameters

Returns Promise<boolean>

See

once

Type Parameters

Parameters

Returns this

ProtectedpostCreate

Returns void

See

ProtectedpostDestroy

Returns void

See

ProtectedpostHide

Returns void

ProtectedpostShow

Returns void

See

ProtectedpreCreate

Returns void

See

ProtectedpreDestroy

Returns void

See

ProtectedpreHide

Returns void

ProtectedpreShow

`Protected` `Readonly`api

`Protected` `Readonly`config

`Protected`el

`Protected`iframe

`Protected`listeners

`Protected` `Readonly`uiPath

`Protected`url

`Protected`handlePageLoad

`Protected`onMessageExtended

`Protected`postCreate

`Protected`postDestroy

`Protected`postHide

`Protected`postShow

`Protected`preCreate

`Protected`preDestroy

`Protected`preHide

`Protected`preShow

`Protected`resetParentPage

`Protected`trigger