xonecas.io
366
Hc

hirenimble-challenge / files

hirenimble-challenge / src / hooks / useOnKeyEvent.js

1.0 KB
1import { useEffect, useCallback } from 'react';
2
3/**
4 * Hook to run a function when a key event happens.
5 *
6 * Usage:
7 *   useOnKeyEvent('Enter', 'keyup', onSubmit);
8 *
9 * @param {function} key key to listen for, eg/ 'Enter'
10 * @param {function} keyEvent key event to listen for, eg/ 'keyup'
11 * @param {function} onKeyEvent function to run on key press
12 * @param {boolean} shouldListen set false to prevent extra events when something is not open
13 */
14export const useOnKeyEvent = (key, keyEvent, onKeyEvent, shouldListen = true) => {
15  const handleKeyEvent = useCallback(
16    event => {
17      if (event.key === key) {
18        onKeyEvent();
19      }
20    },
21    [key, onKeyEvent]
22  );
23  useEffect(() => {
24    if (shouldListen) {
25      document.addEventListener(keyEvent, handleKeyEvent, false);
26    } else {
27      document.removeEventListener(keyEvent, handleKeyEvent, false);
28    }
29
30    return () => {
31      document.removeEventListener(keyEvent, handleKeyEvent, false);
32    };
33  }, [keyEvent, shouldListen, handleKeyEvent]);
34};
35// 'Escape'