ink-cartridge
    Preparing search index...

    Interface ScreenSystemContextValue

    Value provided by ScenarioManagementProvider via React context.

    Includes the current screen, all active overlays, navigation functions, overlay management functions, and modal management functions.

    interface ScreenSystemContextValue {
        activateElement: ActivateElementFn;
        activateElementInModalLayer: ActivateElementInModalLayerFn;
        allLayers: Layer[];
        allModalLayers: ModalLayer[];
        applyElement: ApplyElementFn;
        applyElementToModalLayer: ApplyElementToModalLayerFn;
        back: BackFn;
        bringLayerToFront: BringLayerToFrontFn;
        closeAllLayer: CloseAllLayerFn;
        closeAllModalLayer: CloseAllModalLayerFn;
        closeLayer: CloseLayerFn;
        closeModalLayer: CloseModalLayerFn;
        currentPath: Page[];
        deactivateElement: DeactivateElementFn;
        deactivateElementInModalLayer: DeactivateElementInModalLayerFn;
        eraseElement: EraseElementFn;
        eraseElementInModalLayer: EraseElementInModalLayerFn;
        fullScreen?: boolean;
        gotoScreen: GotoScreenFn;
        openLayer: OpenLayerFn;
        openModalLayer: OpenModalLayerFn;
        pageLayer: ReactNode;
        restoreLayerZIndex: RestoreLayerZIndexFn;
        skip: SkipFn;
    }
    Index
    activateElement activateElementInModalLayer allLayers allModalLayers applyElement applyElementToModalLayer back bringLayerToFront closeAllLayer closeAllModalLayer closeLayer closeModalLayer currentPath deactivateElement deactivateElementInModalLayer eraseElement eraseElementInModalLayer fullScreen? gotoScreen openLayer openModalLayer pageLayer restoreLayerZIndex skip
    activateElement: ActivateElementFn

    Reactivates a previously deactivated layer element.

    activateElementInModalLayer: ActivateElementInModalLayerFn

    Reactivates a previously deactivated modal-layer element.

    allLayers: Layer[]

    All layers

    allModalLayers: ModalLayer[]

    All modal layers

    applyElement: ApplyElementFn

    Applies an element to a registered layer.

    applyElementToModalLayer: ApplyElementToModalLayerFn

    Applies an element to a registered modal layer.

    back: BackFn

    Navigate up the tree toward the root.

    bringLayerToFront: BringLayerToFrontFn

    Raises a regular layer above all other layers (no-op for the top layer; modal layers unaffected).

    closeAllLayer: CloseAllLayerFn

    Closes all layers at once.

    closeAllModalLayer: CloseAllModalLayerFn

    Closes all modal layers at once.

    closeLayer: CloseLayerFn

    Closes a registered layer by its ID.

    closeModalLayer: CloseModalLayerFn

    Closes a registered modal layer by its ID.

    currentPath: Page[]

    Full navigation path from root to the current screen.

    deactivateElement: DeactivateElementFn

    Deactivates a layer element (its keyboard bindings stop receiving keys; the element stays mounted).

    deactivateElementInModalLayer: DeactivateElementInModalLayerFn

    Deactivates a modal-layer element (its keyboard bindings stop receiving keys; the element stays mounted).

    eraseElement: EraseElementFn

    Removes an element from a registered layer.

    eraseElementInModalLayer: EraseElementInModalLayerFn

    Removes an element from a registered modal layer.

    fullScreen?: boolean

    Whether to turn on full screen effect

    gotoScreen: GotoScreenFn

    Jump to any registered screen across branches via LCA resolution.

    openLayer: OpenLayerFn

    Opens a new layer with a unique ID and z-index.

    openModalLayer: OpenModalLayerFn

    Opens a new modal layer with a unique ID and z-index.

    pageLayer: ReactNode

    The rendered React element for the current (top-of-stack) screen.

    restoreLayerZIndex: RestoreLayerZIndexFn

    Restores a raised regular layer to the zIndex it was opened with (no-op when already restored; modal layers unaffected).

    skip: SkipFn

    Navigate down the tree to a direct child of the current screen.

    Settings
    Member Visibility

    On This Page
    Properties