Class ScreenManager<Screens>

Manages screen/state transitions for ECSpresso

Type Parameters

Screens extends Record<string, ScreenDefinition<any, any>> = Record<string, never>

Index

Constructors

Methods

createResource getConfig getCurrentScreen getScreenNames getStackDepth getState hasScreen isActive isCurrent isOverlay popScreen pushScreen register setScreen tryGetConfig tryGetState updateState

Constructors

constructor

new ScreenManager<
    Screens extends
        Record<
            string,
            ScreenDefinition<any, any, default<any, string, string, string, string>>,
        > = Record<string, never>,
>(): ScreenManager<Screens>
Type Parameters
- Screens extends Record<
  string,
  ScreenDefinition<any, any, default<any, string, string, string, string>>,
  > = Record<string, never>
Returns ScreenManager<Screens>

Methods

createResource

createResource(): ScreenResource<Screens>
Create the $screen resource object

Returns ScreenResource<Screens>
- Defined in screen-manager.ts:318

getConfig

getConfig(
screen?: keyof Screens,
): Readonly<ScreenConfig<Screens[keyof Screens]>>
Get the current screen config (immutable). If screen is provided, asserts that the current screen matches.
Parameters
- Optionalscreen: keyof Screens
Returns Readonly<ScreenConfig<Screens[keyof Screens]>>
- Defined in screen-manager.ts:218

getCurrentScreen

getCurrentScreen(): keyof Screens | null
Get the current screen name

Returns keyof Screens | null
- Defined in screen-manager.ts:210

getScreenNames

getScreenNames(): (keyof Screens)[]
Get all registered screen names

Returns (keyof Screens)[]
- Defined in screen-manager.ts:356

getStackDepth

getStackDepth(): number
Get the screen stack depth

Returns number
- Defined in screen-manager.ts:287

getState

getState(screen?: keyof Screens): ScreenState<Screens[keyof Screens]>
Get the current screen state (mutable). If screen is provided, asserts that the current screen matches.
Parameters
- Optionalscreen: keyof Screens
Returns ScreenState<Screens[keyof Screens]>
- Defined in screen-manager.ts:242

hasScreen

hasScreen(name: keyof Screens): boolean
Check if a screen is registered
Parameters
- name: keyof Screens
Returns boolean
- Defined in screen-manager.ts:363

isActive

isActive(screenName: keyof Screens): boolean
Check if a screen is active (current or in stack)
Parameters
- screenName: keyof Screens
Returns boolean
- Defined in screen-manager.ts:301

isCurrent

isCurrent(screenName: keyof Screens): boolean
Check if a screen is the current screen
Parameters
- screenName: keyof Screens
Returns boolean
- Defined in screen-manager.ts:311

isOverlay

isOverlay(): boolean
Check if current screen is an overlay

Returns boolean
- Defined in screen-manager.ts:294

popScreen

popScreen(): Promise<void>
Pop the current screen and return to the previous one

Returns Promise<void>
- Defined in screen-manager.ts:155

pushScreen

pushScreen<K extends string | number | symbol>(
    name: K,
    config: Screens[K] extends ScreenDefinition<
        C,
        any,
        default<any, string, string, string, string>,
    >
        ? C
        : never,
): Promise<void>
Push a screen onto the stack (overlay)
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- config: Screens[K] extends ScreenDefinition<
      C,
      any,
      default<any, string, string, string, string>,
  >
      ? C
      : never
Returns Promise<void>
- Defined in screen-manager.ts:122

register

register<
    K extends string,
    Config extends Record<string, unknown>,
    State extends Record<string, unknown>,
>(
    name: K,
    definition: ScreenDefinition<Config, State>,
): void
Register a screen definition
Type Parameters
- K extends string
- Config extends Record<string, unknown>
- State extends Record<string, unknown>
Parameters
- name: K
- definition: ScreenDefinition<Config, State>
Returns void
- Defined in screen-manager.ts:71

setScreen

setScreen<K extends string | number | symbol>(
    name: K,
    config: Screens[K] extends ScreenDefinition<
        C,
        any,
        default<any, string, string, string, string>,
    >
        ? C
        : never,
): Promise<void>
Transition to a new screen, clearing the stack
Type Parameters
- K extends string | number | symbol
Parameters
- name: K
- config: Screens[K] extends ScreenDefinition<
      C,
      any,
      default<any, string, string, string, string>,
  >
      ? C
      : never
Returns Promise<void>
- Defined in screen-manager.ts:81

tryGetConfig

tryGetConfig(
screen?: keyof Screens,
): Readonly<ScreenConfig<Screens[keyof Screens]>> | undefined
Get the current screen config or undefined. If screen is provided, returns undefined when the current screen doesn't match.
Parameters
- Optionalscreen: keyof Screens
Returns Readonly<ScreenConfig<Screens[keyof Screens]>> | undefined
- Defined in screen-manager.ts:232

tryGetState

tryGetState(
screen?: keyof Screens,
): ScreenState<Screens[keyof Screens]> | undefined
Get the current screen state or undefined. If screen is provided, returns undefined when the current screen doesn't match.
Parameters
- Optionalscreen: keyof Screens
Returns ScreenState<Screens[keyof Screens]> | undefined
- Defined in screen-manager.ts:256

updateState

updateState(update: unknown, screen?: keyof Screens): void
Update the current screen state. If screen is provided, asserts that the current screen matches.
Parameters
- update: unknown
- Optionalscreen: keyof Screens
Returns void
- Defined in screen-manager.ts:266

Class ScreenManager<Screens>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Returns ScreenManager<Screens>

Methods

createResource

Returns ScreenResource<Screens>

getConfig

Parameters

Returns Readonly<ScreenConfig<Screens[keyof Screens]>>

getCurrentScreen

Returns keyof Screens | null

getScreenNames

Returns (keyof Screens)[]

getStackDepth

Returns number

getState

Parameters

Returns ScreenState<Screens[keyof Screens]>

hasScreen

Parameters

Returns boolean

isActive

Parameters

Returns boolean

isCurrent

Parameters

Returns boolean

isOverlay

Returns boolean

popScreen

Returns Promise<void>

pushScreen

Type Parameters

Parameters

Returns Promise<void>

register

Type Parameters

Parameters

Returns void

setScreen

Type Parameters

Parameters

Returns Promise<void>

tryGetConfig

Parameters

Returns Readonly<ScreenConfig<Screens[keyof Screens]>> | undefined

tryGetState

Parameters

Returns ScreenState<Screens[keyof Screens]> | undefined

updateState

Parameters

Returns void

Settings

On This Page