react-hotkeys-hook 4.0.0-6 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-hotkeys-hook",
-  "version": "4.0.0-6",
+  "version": "4.0.0",
   "repository": "https://JohannesKlauss@github.com/JohannesKlauss/react-keymap-hook.git",
   "homepage": "https://johannesklauss.github.io/react-hotkeys-hook/",
   "author": "Johannes Klauss",

package/src/HotkeysProvider.tsx

@@ -4,19 +4,19 @@ import BoundHotkeysProxyProviderProvider from './BoundHotkeysProxyProvider'
 
 export type HotkeysContextType = {
   hotkeys: ReadonlyArray<Hotkey>
-  activeScopes: string[]
+  enabledScopes: string[]
   toggleScope: (scope: string) => void
-  activateScope: (scope: string) => void
-  deactivateScope: (scope: string) => void
+  enableScope: (scope: string) => void
+  disableScope: (scope: string) => void
 }
 
 // The context is only needed for special features like global scoping, so we use a graceful default fallback
 const HotkeysContext = createContext<HotkeysContextType>({
   hotkeys: [],
-  activeScopes: [], // This array has to be empty instead of containing '*' as default, to check if the provider is set or not
+  enabledScopes: [], // This array has to be empty instead of containing '*' as default, to check if the provider is set or not
   toggleScope: () => {},
-  activateScope: () => {},
-  deactivateScope: () => {},
+  enableScope: () => {},
+  disableScope: () => {},
 })
 
 export const useHotkeysContext = () => {
@@ -34,7 +34,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
 
   const isAllActive = useMemo(() => internalActiveScopes.includes('*'), [internalActiveScopes])
 
-  const activateScope = (scope: string) => {
+  const enableScope = (scope: string) => {
     if (isAllActive) {
       setInternalActiveScopes([scope])
     } else {
@@ -42,7 +42,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
     }
   }
 
-  const deactivateScope = (scope: string) => {
+  const disableScope = (scope: string) => {
     const scopes = internalActiveScopes.filter(s => s !== scope)
 
     if (scopes.length === 0) {
@@ -54,9 +54,9 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
 
   const toggleScope = (scope: string) => {
     if (internalActiveScopes.includes(scope)) {
-      deactivateScope(scope)
+      disableScope(scope)
     } else {
-      activateScope(scope)
+      enableScope(scope)
     }
   }
 
@@ -69,7 +69,7 @@ export const HotkeysProvider = ({initiallyActiveScopes = ['*'], children}: Props
   }
 
   return (
-    <HotkeysContext.Provider value={{activeScopes: internalActiveScopes, hotkeys: boundHotkeys, activateScope, deactivateScope, toggleScope}}>
+    <HotkeysContext.Provider value={{enabledScopes: internalActiveScopes, hotkeys: boundHotkeys, enableScope, disableScope, toggleScope}}>
       <BoundHotkeysProxyProviderProvider addHotkey={addBoundHotkey} removeHotkey={removeBoundHotkey}>
         {children}
       </BoundHotkeysProxyProviderProvider>

package/src/useHotkeys.ts

@@ -34,11 +34,11 @@ export default function useHotkeys<T extends HTMLElement>(
   const cb = useCallback(callback, [..._deps])
   const memoisedOptions = useDeepEqualMemo(_options)
 
-  const { activeScopes } = useHotkeysContext()
+  const { enabledScopes } = useHotkeysContext()
   const proxy = useBoundHotkeysProxy()
 
   useLayoutEffect(() => {
-    if (memoisedOptions?.enabled === false || !isScopeActive(activeScopes, memoisedOptions?.scopes)) {
+    if (memoisedOptions?.enabled === false || !isScopeActive(enabledScopes, memoisedOptions?.scopes)) {
       return
     }
 
@@ -117,7 +117,7 @@ export default function useHotkeys<T extends HTMLElement>(
         parseKeysHookInput(keys, memoisedOptions?.splitKey).forEach((key) => proxy.removeHotkey(parseHotkey(key, memoisedOptions?.combinationKey)))
       }
     }
-  }, [keys, cb, memoisedOptions, activeScopes])
+  }, [keys, cb, memoisedOptions, enabledScopes])
 
   return ref
 }