@keybindy/react 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,6 @@
 # @keybindy/react
 
-@keybindy/react is the official React integration for the [Keybindy](https://www.npmjs.com/package/@keybindy/core) keyboard shortcut system. Built on top of `@keybindy/core`, this package brings powerful and scoped keyboard bindings to your React applications — with components and hooks tailored to React’s architecture.
+`@keybindy/react` is the official React integration for the [Keybindy](https://www.npmjs.com/package/@keybindy/core) keyboard shortcut system. Built on top of `@keybindy/core`, this package brings powerful and scoped keyboard bindings to your React applications — with components and hooks tailored to React’s architecture.
 
 [![npm version](https://badge.fury.io/js/@keybindy%2Freact.svg)](https://www.npmjs.com/package/@keybindy/react)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

package/dist/Keybindy.d.ts

@@ -26,7 +26,7 @@ type KeybindyProps = {
      * The scope under which the shortcuts should be active.
      * This allows managing different contexts for shortcuts.
      */
-    scope: string;
+    scope?: 'global' | string;
     /**
      * Array of shortcut definitions to register for this scope.
      */

package/dist/Keybindy.js

@@ -35,7 +35,7 @@ import { useKeybindy } from './useKeybindy.js';
  *
  * @returns {JSX.Element} The rendered component with registered shortcuts within the provided scope.
  */
-const Keybindy = ({ scope, shortcuts = [], children, disabled, onShortcutFired, logs = false, }) => {
+const Keybindy = ({ scope = 'global', shortcuts = [], children, disabled, onShortcutFired, logs = false, }) => {
     const { register, unregister, manager, pushScope, popScope, getScopes, setScope } = useKeybindy({
         onShortcutFired,
         logs,

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import ShortcutManager, { Keys, ShortcutHandler, ShortcutOptions, Shortcut } from '@keybindy/core';
+export { KeyBinding, Keys, Shortcut, ShortcutHandler, ShortcutOptions } from '@keybindy/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
@@ -28,7 +29,7 @@ type KeybindyProps = {
      * The scope under which the shortcuts should be active.
      * This allows managing different contexts for shortcuts.
      */
-    scope: string;
+    scope?: 'global' | string;
     /**
      * Array of shortcut definitions to register for this scope.
      */
@@ -142,6 +143,33 @@ interface ShortcutLabelProps extends React.DetailedHTMLProps<React.HTMLAttribute
  */
 declare const ShortcutLabel: ({ keys, renderKey, style, ...props }: ShortcutLabelProps) => react_jsx_runtime.JSX.Element;
 
+type UseKeybindyReturn = {
+    register: (keys: Keys[] | Keys[][], handler: ShortcutHandler, options?: ShortcutOptions) => void;
+    unregister: (keys: Keys[], scope?: string) => void;
+    enable: (keys: Keys[], scope?: string) => void;
+    disable: (keys: Keys[], scope?: string) => void;
+    toggle: (keys: Keys[], scope?: string) => void;
+    setScope: (scope: string) => void;
+    getCheatSheet: (scope?: string) => {
+        keys: string[];
+    }[] | undefined;
+    destroy: () => void;
+    getScopeInfo: (scope?: string) => any;
+    getActiveScope: () => string;
+    popScope: () => void;
+    pushScope: (scope: string) => void;
+    resetScope: () => void;
+    getScopes: () => string[];
+    isScopeActive: (scope: string) => boolean | undefined;
+    onTyping: (callback: (payload: {
+        key: string;
+        event: KeyboardEvent;
+    }) => void) => void;
+    enableAll: (scope?: string) => void;
+    clear: () => void;
+    disableAll: (scope?: string) => void;
+    manager: ShortcutManager;
+};
 /**
  * React hook to manage keyboard shortcuts using a shared instance of `ShortcutManager`.
  * Automatically cleans up shortcuts registered by the component on unmount.
@@ -166,51 +194,9 @@ declare const ShortcutLabel: ({ keys, renderKey, style, ...props }: ShortcutLabe
  *   setScope('editor');
  * }, []);
  */
-declare function useKeybindy({ logs, onShortcutFired, }?: {
+declare const useKeybindy: ({ logs, onShortcutFired, }?: {
     logs?: boolean;
     onShortcutFired?: (info: Shortcut) => void;
-}): {
-    register: (keys: Keys[] | Keys[][], handler: ShortcutHandler, options?: ShortcutOptions) => void;
-    unregister: (keys: Keys[], scope?: string) => void;
-    enable: (keys: Keys[], scope?: string) => void;
-    disable: (keys: Keys[], scope?: string) => void;
-    toggle: (keys: Keys[], scope?: string) => void;
-    setScope: (scope: string) => void;
-    getCheatSheet: (scope?: string) => {
-        keys: string[];
-    }[] | undefined;
-    destroy: () => void;
-    getScopeInfo: (scope?: string) => {
-        shortcuts: {
-            keys: string[];
-            id: string;
-            enabled: boolean;
-            data?: Record<string, string>;
-        }[];
-        isActive?: boolean;
-    } | Record<string, {
-        shortcuts: {
-            keys: string[];
-            id: string;
-            enabled: boolean;
-            data?: Record<string, string>;
-        }[];
-        isActive?: boolean;
-    }> | undefined;
-    getActiveScope: () => string | undefined;
-    popScope: () => void;
-    pushScope: (scope: string) => void;
-    resetScope: () => void;
-    getScopes: () => string[] | undefined;
-    isScopeActive: (scope: string) => boolean | undefined;
-    onTyping: (callback: (payload: {
-        key: string;
-        event: KeyboardEvent;
-    }) => void) => void;
-    enableAll: (scope?: string) => void;
-    clear: () => void;
-    disableAll: (scope?: string) => void;
-    manager: ShortcutManager;
-};
+}) => UseKeybindyReturn;
 
 export { Keybindy, ShortcutLabel, useKeybindy };

package/dist/useKeybindy.d.ts

@@ -1,5 +1,32 @@
 import ShortcutManager from '@keybindy/core';
 import type { Keys, Shortcut, ShortcutHandler, ShortcutOptions } from '@keybindy/core';
+type UseKeybindyReturn = {
+    register: (keys: Keys[] | Keys[][], handler: ShortcutHandler, options?: ShortcutOptions) => void;
+    unregister: (keys: Keys[], scope?: string) => void;
+    enable: (keys: Keys[], scope?: string) => void;
+    disable: (keys: Keys[], scope?: string) => void;
+    toggle: (keys: Keys[], scope?: string) => void;
+    setScope: (scope: string) => void;
+    getCheatSheet: (scope?: string) => {
+        keys: string[];
+    }[] | undefined;
+    destroy: () => void;
+    getScopeInfo: (scope?: string) => any;
+    getActiveScope: () => string;
+    popScope: () => void;
+    pushScope: (scope: string) => void;
+    resetScope: () => void;
+    getScopes: () => string[];
+    isScopeActive: (scope: string) => boolean | undefined;
+    onTyping: (callback: (payload: {
+        key: string;
+        event: KeyboardEvent;
+    }) => void) => void;
+    enableAll: (scope?: string) => void;
+    clear: () => void;
+    disableAll: (scope?: string) => void;
+    manager: ShortcutManager;
+};
 /**
  * React hook to manage keyboard shortcuts using a shared instance of `ShortcutManager`.
  * Automatically cleans up shortcuts registered by the component on unmount.
@@ -24,49 +51,8 @@ import type { Keys, Shortcut, ShortcutHandler, ShortcutOptions } from '@keybindy
  *   setScope('editor');
  * }, []);
  */
-export declare function useKeybindy({ logs, onShortcutFired, }?: {
+export declare const useKeybindy: ({ logs, onShortcutFired, }?: {
     logs?: boolean;
     onShortcutFired?: (info: Shortcut) => void;
-}): {
-    register: (keys: Keys[] | Keys[][], handler: ShortcutHandler, options?: ShortcutOptions) => void;
-    unregister: (keys: Keys[], scope?: string) => void;
-    enable: (keys: Keys[], scope?: string) => void;
-    disable: (keys: Keys[], scope?: string) => void;
-    toggle: (keys: Keys[], scope?: string) => void;
-    setScope: (scope: string) => void;
-    getCheatSheet: (scope?: string) => {
-        keys: string[];
-    }[] | undefined;
-    destroy: () => void;
-    getScopeInfo: (scope?: string) => {
-        shortcuts: {
-            keys: string[];
-            id: string;
-            enabled: boolean;
-            data?: Record<string, string>;
-        }[];
-        isActive?: boolean;
-    } | Record<string, {
-        shortcuts: {
-            keys: string[];
-            id: string;
-            enabled: boolean;
-            data?: Record<string, string>;
-        }[];
-        isActive?: boolean;
-    }> | undefined;
-    getActiveScope: () => string | undefined;
-    popScope: () => void;
-    pushScope: (scope: string) => void;
-    resetScope: () => void;
-    getScopes: () => string[] | undefined;
-    isScopeActive: (scope: string) => boolean | undefined;
-    onTyping: (callback: (payload: {
-        key: string;
-        event: KeyboardEvent;
-    }) => void) => void;
-    enableAll: (scope?: string) => void;
-    clear: () => void;
-    disableAll: (scope?: string) => void;
-    manager: ShortcutManager;
-};
+}) => UseKeybindyReturn;
+export {};

package/dist/useKeybindy.js

@@ -26,11 +26,11 @@ let sharedInstance = null;
  *   setScope('editor');
  * }, []);
  */
-function useKeybindy({ logs = false, onShortcutFired, } = {}) {
+const useKeybindy = ({ logs = false, onShortcutFired, } = {}) => {
     const managerRef = React.useRef(null);
     const registeredIds = React.useRef(new Set());
     if (!sharedInstance) {
-        sharedInstance = new ShortcutManager(onShortcutFired);
+        sharedInstance = new ShortcutManager({ onShortcutFired, silent: !logs });
     }
     if (!managerRef.current) {
         managerRef.current = sharedInstance;
@@ -132,7 +132,7 @@ function useKeybindy({ logs = false, onShortcutFired, } = {}) {
      * @returns {string} The active scope.
      */
     const getActiveScope = React.useCallback(() => {
-        return managerRef.current?.getActiveScope();
+        return managerRef.current?.getActiveScope() ?? '';
     }, []);
     /**
      * Disables all shortcuts in the specified scope or all scopes if no scope is provided.
@@ -171,7 +171,7 @@ function useKeybindy({ logs = false, onShortcutFired, } = {}) {
      * @returns An array of scopes.
      */
     const getScopes = React.useCallback(() => {
-        return managerRef.current?.getScopes();
+        return managerRef.current?.getScopes() ?? [];
     }, []);
     /**
      * Checks if the given scope is active.
@@ -248,6 +248,6 @@ function useKeybindy({ logs = false, onShortcutFired, } = {}) {
         disableAll,
         manager: managerRef.current,
     };
-}
+};
 
 export { useKeybindy };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keybindy/react",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Keybindy for React: Simple, scoped keyboard shortcuts that require little setup. designed to smoothly blend in with your React applications, allowing for robust keybinding functionality without the overhead.",
   "author": {
     "name": "PRASSamin",
@@ -49,7 +49,8 @@
     "format": "prettier --write \"src/**/*.{ts,tsx}\"",
     "publish": "npm publish --access public",
     "prebuild": "rm -rf dist",
-    "build": "rollup -c"
+    "build": "rollup -c",
+    "dev": "rollup -c -w"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.3",
@@ -65,7 +66,7 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
-    "@keybindy/core": "^1.0.0",
+    "@keybindy/core": "^1.0.2",
     "react": "^19.1.0"
   }
-}
+}