Class SplashScreenHandler

constructor

• new SplashScreenHandler(
      imagePathWhite?: string,
      imagePathBlack?: string,
      splashContainerId?: string,
      useDarkTheme?: boolean | null,
  ): SplashScreenHandler

  Creates an instance of SplashScreenHandler, and generates the splash screen.

  Parameters

  • OptionalimagePathWhite: string

    Path of the image to show for dark theme.

  • OptionalimagePathBlack: string

    Path of the image to show for light theme.

  • OptionalsplashContainerId: string = 'splash'

    Document's target div id, where to put the splash screen.

  • useDarkTheme: boolean | null = null

  Returns SplashScreenHandler

Static Optional Internalinstance

dispose

• dispose(): void

  Disposes the splash screen

  Returns void

handleError

• handleError(error: Error): void

  Parameters

  • error: Error

  Returns void

handleForbiddenEvent

• handleForbiddenEvent(handler: () => void): void

  Parameters

  • handler: () => void

  Returns void

hideForbiddenNotification

• hideForbiddenNotification(handler: () => void): void

  Parameters

  • handler: () => void

  Returns void

showNotification

• showNotification(notificationMsg: string): void

  Shows notification message in splash screen. Useful for showing progress.

  Parameters

  • notificationMsg: string

    Message to show.

  Returns void

stop

• stop(): void

  Returns void