Class default

Hierarchy

Constructors

constructor

Properties

event screenWrapper

Methods

all await get getTop hasOverlay hide initialize isInterruptVisible isTop isVisible show

Constructors

constructor

  • Returns default

Properties

Readonly event

event: IEventEmitter<default, IScreenManagerEvents>

Readonly screenWrapper

screenWrapper: default<HTMLElement> = ...

Methods

all

  • Streams all initialized screens.

    Returns Stream<default>

await

  • Returns a promise that resolves when the given screen is shown.

    Type Parameters

    Parameters

    • screenId: SCREEN

    Returns Promise<ScreenById[SCREEN]>

get

  • Returns a screen, or undefined, if the screen is not initialized.

    Type Parameters

    Parameters

    • screenId: ID

      The ID of the screen to return

    Returns undefined | ScreenById[ID]

getTop

  • Returns the "top" screen.

    There are two screen layers:

    1. The main layer
    2. The overlay layer

    The overlay layer is always in front of the main layer, therefore if there is no overlay screen visible, this method returns the main layer screen. Otherwise, this method returns the overlay layer screen.

    Type Parameters

    Returns S

hasOverlay

  • Returns boolean

hide

  • Hides the given screen, or the current screen if none is passed.

    Parameters

    Returns void | Promise<void>

initialize

  • If the screen by the given ID is not already initialized, initializes it.

    Returns

    The initialized screen

    Type Parameters

    Parameters

    • screenId: ID

      The ID of the screen to initialize

    Returns ScreenById[ID]

isInterruptVisible

  • Returns boolean

isTop

  • Returns if the given screen id is the "top" screen.

    There are two screen layers:

    1. The main layer
    2. The overlay layer

    The overlay layer is always in front of the main layer, therefore if there is no overlay screen visible, this method returns if the given screen ID is the main layer screen. Otherwise, this method returns if the given screen ID is the overlay layer screen.

    Parameters

    Returns boolean

isVisible

  • Returns if the given screen id is a currently visible screen (either the main screen or the overlay screen).

    Parameters

    Returns boolean

show

  • Shows a screen

    Type Parameters

    Parameters

    • screenId: ID

      The id of the screen to show

    • Optional screenInitializer: ((screen: ScreenById[ID]) => any)

    Returns ScreenById[ID]

Settings

Member Visibility

Theme

Generated using TypeDoc