react-hotkeys-hook 5.0.0-1 → 5.0.0

package/src/useRecordHotkeys.ts

@@ -1,51 +0,0 @@
-import { useCallback, useState } from 'react'
-import { mapKey } from './parseHotkeys'
-
-export default function useRecordHotkeys() {
-  const [keys, setKeys] = useState(new Set<string>())
-  const [isRecording, setIsRecording] = useState(false)
-
-  const handler = useCallback((event: KeyboardEvent) => {
-    if (event.code === undefined) {
-      // Synthetic event (e.g., Chrome autofill).  Ignore.
-      return
-    }
-
-    event.preventDefault()
-    event.stopPropagation()
-
-    setKeys((prev) => {
-      const newKeys = new Set(prev)
-
-      newKeys.add(mapKey(event.code))
-
-      return newKeys
-    })
-  }, [])
-
-  const stop = useCallback(() => {
-    if (typeof document !== 'undefined') {
-      document.removeEventListener('keydown', handler)
-
-      setIsRecording(false)
-    }
-  }, [handler])
-
-  const start = useCallback(() => {
-    setKeys(new Set<string>())
-
-    if (typeof document !== 'undefined') {
-      stop()
-
-      document.addEventListener('keydown', handler)
-
-      setIsRecording(true)
-    }
-  }, [handler, stop])
-
-  const resetKeys = useCallback(() => {
-    setKeys(new Set<string>())
-  }, [])
-
-  return [keys, { start, stop, resetKeys, isRecording }] as const
-}

package/src/validators.ts

@@ -1,111 +0,0 @@
-import { FormTags, Hotkey, Scopes, Trigger } from './types'
-import { isHotkeyPressed, isReadonlyArray } from './isHotkeyPressed'
-import { mapKey } from './parseHotkeys'
-
-export function maybePreventDefault(e: KeyboardEvent, hotkey: Hotkey, preventDefault?: Trigger): void {
-  if ((typeof preventDefault === 'function' && preventDefault(e, hotkey)) || preventDefault === true) {
-    e.preventDefault()
-  }
-}
-
-export function isHotkeyEnabled(e: KeyboardEvent, hotkey: Hotkey, enabled?: Trigger): boolean {
-  if (typeof enabled === 'function') {
-    return enabled(e, hotkey)
-  }
-
-  return enabled === true || enabled === undefined
-}
-
-export function isKeyboardEventTriggeredByInput(ev: KeyboardEvent): boolean {
-  return isHotkeyEnabledOnTag(ev, ['input', 'textarea', 'select'])
-}
-
-export function isHotkeyEnabledOnTag(
-  { target }: KeyboardEvent,
-  enabledOnTags: readonly FormTags[] | boolean = false
-): boolean {
-  const targetTagName = target && (target as HTMLElement).tagName
-
-  if (isReadonlyArray(enabledOnTags)) {
-    return Boolean(
-      targetTagName && enabledOnTags && enabledOnTags.some((tag) => tag.toLowerCase() === targetTagName.toLowerCase())
-    )
-  }
-
-  return Boolean(targetTagName && enabledOnTags && enabledOnTags)
-}
-
-export function isScopeActive(activeScopes: string[], scopes?: Scopes): boolean {
-  if (activeScopes.length === 0 && scopes) {
-    console.warn(
-      'A hotkey has the "scopes" option set, however no active scopes were found. If you want to use the global scopes feature, you need to wrap your app in a <HotkeysProvider>'
-    )
-
-    return true
-  }
-
-  if (!scopes) {
-    return true
-  }
-
-  return activeScopes.some((scope) => scopes.includes(scope)) || activeScopes.includes('*')
-}
-
-export const isHotkeyMatchingKeyboardEvent = (e: KeyboardEvent, hotkey: Hotkey, ignoreModifiers = false): boolean => {
-  const { alt, meta, mod, shift, ctrl, keys, useKey } = hotkey
-  const { code, key: producedKey, ctrlKey, metaKey, shiftKey, altKey } = e
-
-  const mappedCode = mapKey(code)
-
-  if (useKey && keys?.length === 1 && keys.includes(producedKey)) {
-    return true
-  }
-
-  if (
-    !keys?.includes(mappedCode) &&
-    !['ctrl', 'control', 'unknown', 'meta', 'alt', 'shift', 'os'].includes(mappedCode)
-  ) {
-    return false
-  }
-
-  if (!ignoreModifiers) {
-    // We check the pressed keys for compatibility with the keyup event. In keyup events the modifier flags are not set.
-    if (alt !== altKey && mappedCode !== 'alt') {
-      return false
-    }
-
-    if (shift !== shiftKey && mappedCode !== 'shift') {
-      return false
-    }
-
-    // Mod is a special key name that is checking for meta on macOS and ctrl on other platforms
-    if (mod) {
-      if (!metaKey && !ctrlKey) {
-        return false
-      }
-    } else {
-      if (meta !== metaKey && mappedCode !== 'meta' && mappedCode !== 'os') {
-        return false
-      }
-
-      if (ctrl !== ctrlKey && mappedCode !== 'ctrl' && mappedCode !== 'control') {
-        return false
-      }
-    }
-  }
-
-  // All modifiers are correct, now check the key
-  // If the key is set, we check for the key
-  if (keys && keys.length === 1 && keys.includes(mappedCode)) {
-    return true
-  } else if (keys) {
-    // Check if all keys are present in pressedDownKeys set
-    return isHotkeyPressed(keys)
-  } else if (!keys) {
-    // If the key is not set, we only listen for modifiers, that check went alright, so we return true
-    return true
-  }
-
-  // There is nothing that matches.
-  return false
-}