Class UiBlockerOverlay

UiBlockerOverlay class. An blocking overlay for time consuming operations. Info messages can be presented to the user.

Hierarchy

UiBlockerOverlay

Index

Constructors

Methods

close info open showMessage

Constructors

constructor

new UiBlockerOverlay(uiMode?: UIBlockerModeEnum, zIndex?: number): UiBlockerOverlay
constructor
Parameters
- Optional uiMode: UIBlockerModeEnum
  
  Choose the dark or light mode of the UiBlockerOverlay; default = dark
- Optional zIndex: number
  
  the z-index of the overlay, default = 1000
Returns UiBlockerOverlay

Methods

close

close(): void
Closes the UiBlocker-Overlay

Returns void

info

info(text: string, isHtml?: boolean): void
Presents an info message to the user
Parameters
- text: string
  
  the message that is presented to the user
- Optional isHtml: boolean
  
  if the string should be parsed as html set this option to true, default = false
Returns void

open

open(duration?: number, msg?: string): void
Opens the UiBlocker-Overlay
Parameters
- Optional duration: number
  
  duration of the fade-in animation, default = 0;
- Optional msg: string
  
  the message that is shown to the user
Returns void

`Static` showMessage

showMessage(msg: string, isHtml?: boolean): Promise<void>
Replaces the UiBlocker message with given string
Parameters
- msg: string
  
  the message that is presented to the user
- isHtml: boolean = false
  
  if the string should be parsed as html set this option to true
Returns Promise<void>

Generated using TypeDoc