SheetXL - v1.0.2
    Preparing search index...

    Interface VirtualKeyboardHandler

    The imperative handle useVirtualKeyboard returns.

    interface VirtualKeyboardHandler {
        getEditorId(): string | null;
        getInputMode(): VirtualKeyboardInputMode;
        getOptions(): Readonly<VirtualKeyboardOptions>;
        getState(): VirtualKeyboardState;
        hide(): void;
        isActive(): boolean;
        isEnabled(): boolean;
        registerEditor(editorId: string): () => void;
        setInputMode(inputMode: VirtualKeyboardInputMode): void;
        show(): boolean;
    }

    Hierarchy (View Summary)

    Index
    • The editor typing opens in while in keyboard mode, or null for the cell.

      Returns string | null

    • Leave keyboard mode, and go back to the letters keyboard: a field opened later (a double-click into a cell) asks for letters, so the next keyboard does too. A sheet whose typing input has focus hands it to the grid, which lowers the keyboard; an editor that has focus keeps it.

      Returns void

    • Shorthand for getState().active.

      Returns boolean

    • Whether keyboard mode is available: the device has a virtual keyboard, and the store is not VirtualKeyboardOptions.disabled. The counterpart of document.fullscreenEnabled; a host leaves keyboard-mode parts (the sheet's keyboard layer) out when it is false.

      Returns boolean

    • Name the editor that typing opens in while in keyboard mode, by the id it parks on the edit session (EditSession.setActiveEditorId); a phone's formula bar names itself so a typed key opens the edit there rather than in the cell. The latest registration wins.

      Parameters

      • editorId: string

      Returns () => void

      Removes this registration.

    • Enter keyboard mode. A sheet whose focus is not already in a text field focuses its typing input, which raises the keyboard; browsers raise one only inside a user gesture, so call this from a tap.

      Returns boolean

      Whether keyboard mode is on: false when it is not enabled, as requestFullscreen refuses where fullscreen is not.