ink-cartridge
    Preparing search index...

    Type Alias LayerOptions

    Options for OpenLayerFn.

    type LayerOptions = {
        automaticTakeoverKeyboard?: boolean | ComponentType<any>[];
        crossPage?: boolean;
    }
    Index
    automaticTakeoverKeyboard?: boolean | ComponentType<any>[]

    Whether the layer automatically takes over keyboard events, and the scope of that takeover.

    • false (default): no takeover — the bindings stay active on every page.
    • true: the bindings are active only while the layer's host page is the current page; navigating away pops the keyboard owner and returning to the host page pushes it again.
    • ComponentType<any>[]: scopes the takeover to the listed pages. While the current page is one of them, the keyboard owner is popped and the bindings go dormant; on any other page they stay active.

    Typically used together with crossPage so a persistent layer does not intercept keys on other pages.

    crossPage?: boolean

    Normally, when the application executes page-switching methods such as skip or gotoScreen, the layer is automatically cleared; a toggle is provided here to prevent this automatic clearing.