react-native-keyboard-controller/lib/typescript/context.d.ts

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

import { Animated } from "react-native";
import type { FocusedInputHandler, FocusedInputLayoutChangedEvent, KeyboardHandler } from "./types";
import type React from "react";
import type { SharedValue } from "react-native-reanimated";
export type AnimatedContext = {
    /**
     * A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible.
     * Represented as `Animated.Value`.
     */
    progress: Animated.Value;
    /** Height of the keyboard. Represented as `Animated.Value`. */
    height: Animated.AnimatedMultiplication<number>;
};
export type ReanimatedContext = {
    /**
     * A value between `0` and `1` indicating keyboard position, where `0` means keyboard is closed and `1` means keyboard is fully visible.
     * Represented as `SharedValue`.
     */
    progress: SharedValue<number>;
    /** Height of the keyboard. Represented as `SharedValue`. */
    height: SharedValue<number>;
};
export type KeyboardAnimationContext = {
    /** Whether KeyboardController library is active or not. */
    enabled: boolean;
    /** Object that stores animated values that reflect the keyboard’s current position and movement. */
    animated: AnimatedContext;
    /** Object that stores reanimated values that reflect the keyboard’s current position and movement. */
    reanimated: ReanimatedContext;
    /** Layout of the focused `TextInput` represented as `SharedValue`. */
    layout: SharedValue<FocusedInputLayoutChangedEvent | null>;
    /** Method for setting workletized keyboard handlers. */
    setKeyboardHandlers: (handlers: KeyboardHandler) => () => void;
    /** Method for setting workletized handlers for tracking focused input events. */
    setInputHandlers: (handlers: FocusedInputHandler) => () => void;
    /** Method to enable/disable KeyboardController library. */
    setEnabled: React.Dispatch<React.SetStateAction<boolean>>;
};
export declare const KeyboardContext: React.Context<KeyboardAnimationContext>;
/**
 * A hook that returns a reference to {@link KeyboardAnimationContext} object.
 *
 * @returns Object {@link KeyboardAnimationContext|containing} keyboard-controller context.
 * @example
 * ```ts
 *   const context = useKeyboardContext();
 *
 *   useLayoutEffect(() => {
 *     const cleanup = context.setInputHandlers(handler);
 *
 *     return () => cleanup();
 *   }, deps);
 * ```
 */
export declare const useKeyboardContext: () => KeyboardAnimationContext;