Add ignoreRepeat option to skip callback on held keys

Uses KeyboardEvent.repeat to detect when a key is being held down
and skips the callback invocation when ignoreRepeat is enabled.

Author: nikoewe

packages/react-hotkeys-hook/src/lib/types.ts

@@ -87,6 +87,8 @@ export type Options = {
   sequenceTimeoutMs?: number
   // The character to split the sequence of keys. (Default: >)
   sequenceSplitKey?: string
+  // Ignore repeated events when the key is held down. (Default: false)
+  ignoreRepeat?: boolean
   // MetaData | Custom data to store and retrieve with the hotkey (Default: undefined)
   metadata?: Record<string, unknown>
 }

packages/react-hotkeys-hook/src/lib/useHotkeys.ts

@@ -67,6 +67,10 @@ export default function useHotkeys<T extends HTMLElement>(
     let sequenceTimer: NodeJS.Timeout | undefined
 
     const listener = (e: KeyboardEvent, isKeyUp = false) => {
+      if (memoisedOptions?.ignoreRepeat && e.repeat) {
+        return
+      }
+
       if (isKeyboardEventTriggeredByInput(e) && !isHotkeyEnabledOnTag(e, memoisedOptions?.enableOnFormTags)) {
         return
       }