expo-key-event/build/hooks/useKeyEventListener.js

Provides an interface for reading key events such as from external bluetooth keyboards on Android, iOS and Web.

import { useEventListener } from "expo";
import { useCallback, useEffect } from "react";
import { DevSettings } from "react-native";
import ExpoKeyEventModule from "../ExpoKeyEventModule";
import { unifyKeyCode } from "../utils/unifyKeyCode";
/**
 * This hook is used to listen for key events, but it doesn't keep the track of it.
 * This is useful if you want to handle the state yourself or use the event outside of the react lifecycle.
 * @param listenOnMount Pass 'false' to prevent automatic key event listening
 * - Use startListening/stopListening to control the listener manually
 * @param preventReload Prevent reloading the app when pressing 'r'
 *
 */
export function useKeyEventListener(listener, listenOnMount = true, preventReload = false) {
    const onKeyPress = useCallback(({ key }) => {
        const uniKey = unifyKeyCode(key);
        if (!preventReload && __DEV__ && uniKey === "KeyR")
            DevSettings.reload();
        listener({ key: uniKey });
    }, [listener]);
    useEventListener(ExpoKeyEventModule, "onKeyPress", onKeyPress);
    useEffect(() => {
        if (listenOnMount)
            ExpoKeyEventModule.startListening();
        return () => {
            ExpoKeyEventModule.stopListening();
        };
    }, [listenOnMount]);
    return {
        /**
         * Start listening for key events
         */
        startListening: ExpoKeyEventModule.startListening,
        /**
         * Stop listening for key events
         */
        stopListening: ExpoKeyEventModule.stopListening,
    };
}
//# sourceMappingURL=useKeyEventListener.js.map