react-native-keyboard-controller/lib/typescript/types/module.d.ts

Keyboard manager which works in identical way on both iOS and Android

import type { EmitterSubscription, TextInputProps } from "react-native";
export type KeyboardControllerEvents = "keyboardWillShow" | "keyboardDidShow" | "keyboardWillHide" | "keyboardDidHide";
export type KeyboardEventData = {
    /** Height of the keyboard. */
    height: number;
    /** Duration of the keyboard animation. */
    duration: number;
    /** Timestamp of the last keyboard event. */
    timestamp: number;
    /** Tag of the focused `TextInput`. */
    target: number;
    /** `keyboardType` property from focused `TextInput`. */
    type: NonNullable<TextInputProps["keyboardType"]>;
    /** Keyboard appearance. Can be one of `dark` or `light`. */
    appearance: "dark" | "light";
};
/**
 * An object that represent current keyboard state.
 */
export type KeyboardState = {
    /** Whether the keyboard is currently visible. */
    isVisible: boolean;
} & KeyboardEventData;
export type KeyboardEventsModule = {
    /**
     * The `addListener` function connects a JavaScript function to an identified native
     * keyboard notification event.
     *
     * This function then returns the reference to the listener.
     *
     * `name` is the string that identifies the event you're listening for. This
     * can be any of the following:
     *
     * - `keyboardWillShow`;
     * - `keyboardDidShow`;
     * - `keyboardWillHide`;
     * - `keyboardDidHide`.
     */
    addListener: (name: KeyboardControllerEvents, cb: (e: KeyboardEventData) => void) => EmitterSubscription;
};
export type Direction = "next" | "prev" | "current";
export type DismissOptions = {
    /**
     * A boolean property indicating whether focus should be kept on the input after dismissing the keyboard. Default is `false`.
     */
    keepFocus: boolean;
};
export type KeyboardControllerModule = {
    /**
     * Sets default `windowSoftInputMode` (the one that declared in `AndroidManifest.xml`).
     *
     * @platform android
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setdefaultmode-|docs} page for more details.
     */
    setDefaultMode: () => void;
    /**
     * Changes `windowSoftInputMode` on Android.
     *
     * @platform android
     * @see AndroidSoftInputModes for all possible values and {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setinputmode-|docs} page for more details.
     */
    setInputMode: (mode: number) => void;
    /**
     * A method that preloads the keyboard. It's useful when you want to avoid a delay when the user focuses the first input.
     *
     * @platform ios
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#preload-|docs} page for more details.
     */
    preload: () => void;
    /**
     * Dismisses the active keyboard. Removes a focus by default, but allows to pass `{keepFocus: true}` to keep focus.
     *
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#dismiss|docs} page for more details.
     */
    dismiss: (options?: DismissOptions) => Promise<void>;
    /**
     * Moves focus to the specified direction (`next`, `prev` or `current` to restore a focus).
     *
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#setfocusto|docs} page for more details.
     */
    setFocusTo: (direction: Direction) => void;
    /**
     * Whether the keyboard is fully visible.
     *
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#isvisible|docs} page for more details.
     */
    isVisible: () => boolean;
    /**
     * Method that returns current keyboard state.
     *
     * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/keyboard-controller#state|docs} page for more details.
     */
    state: () => KeyboardEventData;
};
export type KeyboardControllerNativeModule = {
    setDefaultMode: () => void;
    setInputMode: (mode: number) => void;
    preload: () => void;
    dismiss: (keepFocus: boolean) => void;
    setFocusTo: (direction: Direction) => void;
    addListener: (eventName: string) => void;
    removeListeners: (count: number) => void;
};