Class AppWidget

A widget that takes up the full screen, and is used to display different parts of the app.

Hierarchy (view full)

BaseWidget
- AppWidget

Index

Constructors

Properties

api config el iframe uiPath url

Methods

destroy getIframe getUrl handlePageLoad hide isOpen onMessageExtended postCreate postDestroy postHide postShow preCreate preDestroy preHide preShow resetParentPage sendMessage setUrl show

Constructors

constructor

new AppWidget(config, el, api): AppWidget
Parameters
- config: OfcpConfig
- el: HTMLElement
- api: TecsafeApi
Returns AppWidget
Inherited from BaseWidget.constructor
- 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: "" = ''

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

See

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

getIframe

getIframe(): HTMLIFrameElement
Gets the iframe element

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

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

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

hide

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

Returns void
void
Inherited from BaseWidget.hide
- 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
Inherited from BaseWidget.isOpen
- 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
Overrides BaseWidget.onMessageExtended
- Defined in widget/AppWidget.ts:69

`Protected`postCreate

postCreate(): void
Lifecycle hook for extending classes

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

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

`Protected`preDestroy

preDestroy(): void
Lifecycle hook for extending classes

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

`Protected`preHide

preHide(): void
Lifecycle hook for extending classes

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

`Protected`preShow

preShow(): void
Lifecycle hook for extending classes

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

`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: Message
  The message to send
Returns void
void
Inherited from BaseWidget.sendMessage
- Defined in types/BaseWidget.ts:45

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

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