Rezi
    Preparing search index...

    Interface App<S>

    interface App<S> {
        pendingChord: string | null;
        router?: RouterApi;
        debugLayout(enabled?: boolean): boolean;
        dispose(): void;
        draw(fn: DrawFn): void;
        getBindings(
            mode?: string,
        ): readonly Readonly<
            { description?: string; mode: string; sequence: string },
        >[];
        getMode(): string;
        getTerminalProfile(): TerminalProfile;
        keys(bindings: BindingMap<KeyContext<S>>): void;
        measureElement(
            id: string,
        ): Readonly<{ h: number; w: number; x: number; y: number }> | null;
        modes(modes: ModeBindingMap<KeyContext<S>>): void;
        onEvent(handler: EventHandler): () => void;
        onFocusChange(handler: FocusChangeHandler): () => void;
        printAbove(view: VNode, opts?: Readonly<{ rows?: number }>): Promise<void>;
        ready(): Promise<void>;
        replaceRoutes(
            routes: readonly Readonly<
                {
                    children?: readonly Readonly<
                        (
                            { id: string; screen: (params: Readonly<Record<string, string>>, context: Readonly<{ router: RouterApi; state: Readonly<S>; update: (updater: S | ((prev: Readonly<S>) => S)) => void; outlet: VNode | null; }>) => VNode; guard?: RouteGuard<...>; children?: readonly Readonly<...>[]; title?: string; keybinding?: string; }
                        ),
                    >[];
                    guard?: RouteGuard<S>;
                    id: string;
                    keybinding?: string;
                    screen: (params: RouteParams, context: RouteRenderContext<S>) => VNode;
                    title?: string;
                },
            >[],
        ): void;
        replaceView(fn: ViewFn<S>): void;
        run(): Promise<void>;
        setInlineRows(rows: number): Promise<void>;
        setMode(modeName: string): void;
        setTheme(theme: ThemeDefinition): void;
        start(): Promise<void>;
        stop(): Promise<void>;
        update(updater: S | ((prev: Readonly<S>) => S)): void;
        view(fn: ViewFn<S>): void;
    }

    Type Parameters

    • S
    Index

    Properties

    pendingChord router?

    Methods

    debugLayout dispose draw getBindings getMode getTerminalProfile keys measureElement modes onEvent onFocusChange printAbove ready replaceRoutes replaceView run setInlineRows setMode setTheme start stop update view

    Properties

    pendingChord: string | null
    router?: RouterApi

    Methods

    • Parameters

      • Optionalenabled: boolean

      Returns boolean

    • Parameters

      • Optionalmode: string

      Returns readonly Readonly<{ description?: string; mode: string; sequence: string }>[]

    • Return the computed layout rect for a widget by its id, or null if not found.

      Parameters

      • id: string

      Returns Readonly<{ h: number; w: number; x: number; y: number }> | null

    • Render a standalone widget tree and commit it into terminal scrollback above the inline region (inline screen mode only). Rows default to the tree's measured height at the current viewport width; pass rows to pin. The committed block becomes ordinary terminal history.

      Parameters

      • view: VNode
      • Optionalopts: Readonly<{ rows?: number }>

      Returns Promise<void>

    • Resolves once start()/run() has finished starting and the app accepts update() calls. Resolves immediately when the app is already running; rejects if startup fails or the app is disposed before starting.

      Returns Promise<void>

    • Parameters

      • routes: readonly Readonly<
            {
                children?: readonly Readonly<
                    (
                        { id: string; screen: (params: Readonly<Record<string, string>>, context: Readonly<{ router: RouterApi; state: Readonly<S>; update: (updater: S | ((prev: Readonly<S>) => S)) => void; outlet: VNode | null; }>) => VNode; guard?: RouteGuard<...>; children?: readonly Readonly<...>[]; title?: string; keybinding?: string; }
                    ),
                >[];
                guard?: RouteGuard<S>;
                id: string;
                keybinding?: string;
                screen: (params: RouteParams, context: RouteRenderContext<S>) => VNode;
                title?: string;
            },
        >[]

      Returns void

    • Change the inline viewport height at runtime (inline screen mode only). The engine clamps to the live terminal height and emits a resize event, so layout follows automatically.

      Parameters

      • rows: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods