ecspresso
    Preparing search index...

    Interface ScreenResource<Screens>

    Resource interface for accessing screen state in systems Exposed as $screen resource

    interface ScreenResource<
        Screens extends Record<string, ScreenDefinition<any, any>>,
    > {
        config: Readonly<ScreenConfig<Screens[keyof Screens]>> | null;
        current: keyof Screens | null;
        isOverlay: boolean;
        stack: readonly ScreenStackEntry<Screens, keyof Screens>[];
        stackDepth: number;
        state: ScreenState<Screens[keyof Screens]> | null;
        isActive(screenName: keyof Screens): boolean;
        isCurrent(screenName: keyof Screens): boolean;
    }

    Type Parameters

    Index

    Properties

    config current isOverlay stack stackDepth state

    Methods

    isActive isCurrent

    Properties

    config: Readonly<ScreenConfig<Screens[keyof Screens]>> | null

    Immutable config of the current screen

    current: keyof Screens | null

    Current active screen name, or null if no screen

    isOverlay: boolean

    Whether the current screen is an overlay (has screens beneath it)

    stack: readonly ScreenStackEntry<Screens, keyof Screens>[]

    The screen stack (read-only view)

    stackDepth: number

    Current depth of the screen stack

    state: ScreenState<Screens[keyof Screens]> | null

    Mutable state of the current screen

    Methods

    • Check if a specific screen is currently active (either current or in stack)

      Parameters

      Returns boolean

    • Check if a specific screen is the current screen

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods