react-hotkeys-hook 4.4.0 → 4.4.2

package/README.md

@@ -80,7 +80,7 @@ export const ExampleComponent = () => {
 
 #### Changing a scope's active state
 
-You can change the active state of a scope using the `deactivateScope`, `activateScope` and `toggleScope` functions
+You can change the active state of a scope using the `disableScope`, `enableScope` and `toggleScope` functions
 returned by the `useHotkeysContext()` hook. Note that you have to have your app wrapped in a `<HotkeysProvider>` component.
 
 ```jsx harmony

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "react-hotkeys-hook",
   "description": "React hook for handling keyboard shortcuts",
-  "version": "4.4.0",
-  "repository": "https://JohannesKlauss@github.com/JohannesKlauss/react-keymap-hook.git",
+  "version": "4.4.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/JohannesKlauss/react-keymap-hook.git"
+  },
   "homepage": "https://johannesklauss.github.io/react-hotkeys-hook/",
   "author": "Johannes Klauss",
   "main": "dist/index.js",
@@ -75,31 +78,31 @@
     }
   },
   "devDependencies": {
-    "@babel/core": "7.21.4",
+    "@babel/core": "7.23.2",
     "@babel/plugin-proposal-class-properties": "7.18.6",
-    "@babel/plugin-transform-react-jsx": "7.21.0",
-    "@babel/preset-env": "7.21.4",
-    "@babel/preset-react": "7.18.6",
-    "@babel/preset-typescript": "7.21.4",
-    "@testing-library/jest-dom": "5.16.5",
+    "@babel/plugin-transform-react-jsx": "7.22.15",
+    "@babel/preset-env": "7.23.2",
+    "@babel/preset-react": "7.22.15",
+    "@babel/preset-typescript": "7.23.2",
+    "@testing-library/jest-dom": "5.17.0",
     "@testing-library/react": "14.0.0",
     "@testing-library/user-event": "14.4.3",
-    "@types/jest": "29.5.0",
-    "@types/react": "18.0.35",
-    "@types/react-dom": "18.0.11",
-    "@typescript-eslint/eslint-plugin": "5.58.0",
-    "@typescript-eslint/parser": "5.58.0",
-    "eslint": "^8.34.0",
+    "@types/jest": "29.5.6",
+    "@types/react": "18.2.33",
+    "@types/react-dom": "18.2.14",
+    "@typescript-eslint/eslint-plugin": "5.60.0",
+    "@typescript-eslint/parser": "5.60.0",
+    "eslint": "8.56.0",
     "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-react": "^7.32.2",
-    "jest": "29.5.0",
-    "jest-environment-jsdom": "29.5.0",
-    "prettier": "2.8.7",
+    "eslint-plugin-react": "7.33.2",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "prettier": "2.8.8",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-test-renderer": "18.2.0",
     "tsdx": "0.14.1",
-    "tslib": "2.5.0",
+    "tslib": "2.5.3",
     "typescript": "5.0.4"
   },
   "peerDependencies": {

package/src/index.ts

@@ -1,7 +1,16 @@
 import useHotkeys from './useHotkeys'
-import type { Options } from './types'
+import type { Options, Keys, HotkeyCallback } from './types'
 import { HotkeysProvider, useHotkeysContext } from './HotkeysProvider'
 import { isHotkeyPressed } from './isHotkeyPressed'
 import useRecordHotkeys from './useRecordHotkeys'
 
-export { useHotkeys, useRecordHotkeys, useHotkeysContext, isHotkeyPressed, HotkeysProvider, Options }
+export {
+  useHotkeys,
+  useRecordHotkeys,
+  useHotkeysContext,
+  isHotkeyPressed,
+  HotkeysProvider,
+  Options,
+  Keys,
+  HotkeyCallback,
+}

package/src/isHotkeyPressed.ts

@@ -29,8 +29,13 @@ import { isHotkeyModifier, mapKey } from './parseHotkeys'
 
 const currentlyPressedKeys: Set<string> = new Set<string>()
 
-export function isHotkeyPressed(key: string | string[], splitKey = ','): boolean {
-  const hotkeyArray = Array.isArray(key) ? key : key.split(splitKey)
+// https://github.com/microsoft/TypeScript/issues/17002
+export function isReadonlyArray(value: unknown): value is readonly unknown[] {
+  return Array.isArray(value)
+}
+
+export function isHotkeyPressed(key: string | readonly string[], splitKey = ','): boolean {
+  const hotkeyArray = isReadonlyArray(key) ? key : key.split(splitKey)
 
   return hotkeyArray.every((hotkey) => currentlyPressedKeys.has(hotkey.trim().toLowerCase()))
 }

package/src/types.ts

@@ -1,8 +1,8 @@
 import type { DependencyList } from 'react'
 
 export type FormTags = 'input' | 'textarea' | 'select' | 'INPUT' | 'TEXTAREA' | 'SELECT'
-export type Keys = string | string[]
-export type Scopes = string | string[]
+export type Keys = string | readonly string[]
+export type Scopes = string | readonly string[]
 
 export type RefType<T> = T | null
 
@@ -15,7 +15,7 @@ export type KeyboardModifiers = {
 }
 
 export type Hotkey = KeyboardModifiers & {
-  keys?: string[]
+  keys?: readonly string[]
   scopes?: Scopes
   description?: string
 }
@@ -28,7 +28,7 @@ export type Trigger = boolean | ((keyboardEvent: KeyboardEvent, hotkeysEvent: Ho
 
 export type Options = {
   enabled?: Trigger // Main setting that determines if the hotkey is enabled or not. (Default: true)
-  enableOnFormTags?: FormTags[] | boolean // Enable hotkeys on a list of tags. (Default: false)
+  enableOnFormTags?: readonly FormTags[] | boolean // Enable hotkeys on a list of tags. (Default: false)
   enableOnContentEditable?: boolean // Enable hotkeys on tags with contentEditable props. (Default: false)
   ignoreEventWhen?: (e: KeyboardEvent) => boolean // Ignore evenets based on a condition (Default: undefined)
   combinationKey?: string // Character to split keys in hotkeys combinations. (Default: +)

package/src/useHotkeys.ts

@@ -12,7 +12,7 @@ import {
 import { useHotkeysContext } from './HotkeysProvider'
 import { useBoundHotkeysProxy } from './BoundHotkeysProxyProvider'
 import useDeepEqualMemo from './useDeepEqualMemo'
-import { pushToCurrentlyPressedKeys, removeFromCurrentlyPressedKeys } from './isHotkeyPressed'
+import { isReadonlyArray, pushToCurrentlyPressedKeys, removeFromCurrentlyPressedKeys } from './isHotkeyPressed'
 
 const stopPropagation = (e: KeyboardEvent): void => {
   e.stopPropagation()
@@ -36,7 +36,7 @@ export default function useHotkeys<T extends HTMLElement>(
     : !(dependencies instanceof Array)
     ? (dependencies as Options)
     : undefined
-  const _keys: string = keys instanceof Array ? keys.join(_options?.splitKey) : keys
+  const _keys: string = isReadonlyArray(keys) ? keys.join(_options?.splitKey) : keys
   const _deps: DependencyList | undefined =
     options instanceof Array ? options : dependencies instanceof Array ? dependencies : undefined
 

package/src/validators.ts

@@ -1,5 +1,5 @@
 import { FormTags, Hotkey, Scopes, Trigger } from './types'
-import { isHotkeyPressed } from './isHotkeyPressed'
+import { isHotkeyPressed, isReadonlyArray } from './isHotkeyPressed'
 import { mapKey } from './parseHotkeys'
 
 export function maybePreventDefault(e: KeyboardEvent, hotkey: Hotkey, preventDefault?: Trigger): void {
@@ -20,10 +20,13 @@ export function isKeyboardEventTriggeredByInput(ev: KeyboardEvent): boolean {
   return isHotkeyEnabledOnTag(ev, ['input', 'textarea', 'select'])
 }
 
-export function isHotkeyEnabledOnTag({ target }: KeyboardEvent, enabledOnTags: FormTags[] | boolean = false): boolean {
+export function isHotkeyEnabledOnTag(
+  { target }: KeyboardEvent,
+  enabledOnTags: readonly FormTags[] | boolean = false
+): boolean {
   const targetTagName = target && (target as HTMLElement).tagName
 
-  if (enabledOnTags instanceof Array) {
+  if (isReadonlyArray(enabledOnTags)) {
     return Boolean(
       targetTagName && enabledOnTags && enabledOnTags.some((tag) => tag.toLowerCase() === targetTagName.toLowerCase())
     )
@@ -55,6 +58,10 @@ export const isHotkeyMatchingKeyboardEvent = (e: KeyboardEvent, hotkey: Hotkey,
   const keyCode = mapKey(code)
   const pressedKey = pressedKeyUppercase.toLowerCase()
 
+  if (!keys?.includes(keyCode) && !['ctrl', 'control', 'unknown', 'meta', 'alt', 'shift', 'os'].includes(keyCode)) {
+    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 && pressedKey !== 'alt') {

package/dist/BoundHotkeysProxyProvider.d.ts

@@ -1,14 +0,0 @@
-import { ReactNode } from 'react';
-import { Hotkey } from './types';
-declare type BoundHotkeysProxyProviderType = {
-    addHotkey: (hotkey: Hotkey) => void;
-    removeHotkey: (hotkey: Hotkey) => void;
-};
-export declare const useBoundHotkeysProxy: () => BoundHotkeysProxyProviderType | undefined;
-interface Props {
-    children: ReactNode;
-    addHotkey: (hotkey: Hotkey) => void;
-    removeHotkey: (hotkey: Hotkey) => void;
-}
-export default function BoundHotkeysProxyProviderProvider({ addHotkey, removeHotkey, children }: Props): JSX.Element;
-export {};

package/dist/HotkeysProvider.d.ts

@@ -1,16 +0,0 @@
-import { Hotkey } from './types';
-import { ReactNode } from 'react';
-export declare type HotkeysContextType = {
-    hotkeys: ReadonlyArray<Hotkey>;
-    enabledScopes: string[];
-    toggleScope: (scope: string) => void;
-    enableScope: (scope: string) => void;
-    disableScope: (scope: string) => void;
-};
-export declare const useHotkeysContext: () => HotkeysContextType;
-interface Props {
-    initiallyActiveScopes?: string[];
-    children: ReactNode;
-}
-export declare const HotkeysProvider: ({ initiallyActiveScopes, children }: Props) => JSX.Element;
-export {};

package/dist/deepEqual.d.ts

@@ -1 +0,0 @@
-export default function deepEqual(x: any, y: any): boolean;

package/dist/index.d.ts

@@ -1,6 +0,0 @@
-import useHotkeys from './useHotkeys';
-import type { Options } from './types';
-import { HotkeysProvider, useHotkeysContext } from './HotkeysProvider';
-import { isHotkeyPressed } from './isHotkeyPressed';
-import useRecordHotkeys from './useRecordHotkeys';
-export { useHotkeys, useRecordHotkeys, useHotkeysContext, isHotkeyPressed, HotkeysProvider, Options };

package/dist/index.js

@@ -1,8 +0,0 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./react-hotkeys-hook.cjs.production.min.js')
-} else {
-  module.exports = require('./react-hotkeys-hook.cjs.development.js')
-}

package/dist/isHotkeyPressed.d.ts

@@ -1,3 +0,0 @@
-export declare function isHotkeyPressed(key: string | string[], splitKey?: string): boolean;
-export declare function pushToCurrentlyPressedKeys(key: string | string[]): void;
-export declare function removeFromCurrentlyPressedKeys(key: string | string[]): void;

package/dist/parseHotkeys.d.ts

@@ -1,5 +0,0 @@
-import { Hotkey } from './types';
-export declare function mapKey(key: string): string;
-export declare function isHotkeyModifier(key: string): boolean;
-export declare function parseKeysHookInput(keys: string, splitKey?: string): string[];
-export declare function parseHotkey(hotkey: string, combinationKey?: string, description?: string): Hotkey;