Merge pull request #488 from ggascoigne/ggp/add-enable

Add enable option

README.md

@@ -61,6 +61,7 @@ to do this anymore by yourself.
     to listen to the `+` character, you can set `splitKey` to i.e. `-` and listen for `ctrl-+`
   - `keyup: boolean` Determine if you want to listen on the keyup event
   - `keydown: boolean` Determine if want to listen on the keydown event
+  - `enabled: boolean` is used to prevent installation of the hotkey when set to false (default value: `true`)
 - `deps: any[] = []`: The dependency array that gets appended to the memoisation of the callback. Here you define the inner
 dependencies of your callback. If for example your callback actions depend on a referentially unstable value or a value
 that will change over time, you should add this value to your deps array. Since most of the time your callback won't

src/useHotkeys.ts

@@ -18,6 +18,7 @@ const isKeyboardEventTriggeredByInput = (ev: KeyboardEvent) => {
 };
 
 export type Options = {
+  enabled?: boolean;
   filter?: typeof hotkeys.filter;
   filterPreventDefault?: boolean;
   enableOnTags?: AvailableTags[];
@@ -36,7 +37,7 @@ export function useHotkeys<T extends Element>(keys: string, callback: KeyHandler
     options = undefined;
   }
 
-  const { enableOnTags, filter, keyup, keydown, filterPreventDefault = true } = options || {};
+  const { enableOnTags, filter, keyup, keydown, filterPreventDefault = true, enabled = true } = options as Options || {};
   const ref = useRef<T | null>(null);
 
   const memoisedCallback = useCallback((keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent) => {
@@ -57,6 +58,10 @@ export function useHotkeys<T extends Element>(keys: string, callback: KeyHandler
   }, deps ? [ref, enableOnTags, filter, ...deps] : [ref, enableOnTags, filter]);
 
   useEffect(() => {
+    if(!enabled) {
+      return
+    }
+
     if (keyup && keydown !== true) {
       (options as Options).keydown = false;
     }
@@ -67,4 +72,4 @@ export function useHotkeys<T extends Element>(keys: string, callback: KeyHandler
   }, [memoisedCallback, options, keys]);
 
   return ref;
-}
+}