📜 README.md

React KeyBinder

A lightweight React hook for handling keyboard shortcuts.

🚀 Features

• Easy keybinding for React applications
• Supports both single keys and key combinations (e.g., Ctrl+S, Shift+K)
• Works seamlessly with function components and hooks
• Minimal and efficient

📦 Installation

Install via npm or yarn:

npm install react-keybinder
# or
yarn add react-keybinder

🔥 Usage

Basic Keybinding

import { useKeyBinder } from "react-keybinder";

function App() {
    useKeyBinder("s", () => alert("S key pressed!"));
    return <div>Press "S" to see an alert.</div>;
}

Handling Key Combinations (e.g., Ctrl + S)

useKeyBinder("ctrl+s", (event) => {
    event.preventDefault();
    console.log("Saved!");
});

Binding Multiple Keys

useKeyBinder(["a", "b", "c"], () => console.log("A, B, or C was pressed"));

🎛 API

useKeyBinder(keys: string | string[], callback: (event?: KeyboardEvent) => void);

| Parameter | Type | Description | |-----------|-------------------|---------------------------------------------------------------| | keys | string | string[] | The key(s) or key combinations to listen for ("s", "ctrl+s", ["a", "b"]) | | callback| function | The function to execute when the key is pressed |

🔧 Supported Key Combinations

• Single keys ("s", "Enter", "ArrowUp", etc.)
• Modifier keys (Ctrl, Shift, Alt, Meta)
• Examples: "ctrl+s", "shift+k", "alt+enter"

🛠 Contributing

Contributions are welcome! To contribute:

1. Fork this repository.
2. Create a feature branch:

   git checkout -b feature-name

3. Commit changes:

   git commit -m "Added new feature"

4. Push to GitHub and submit a Pull Request.

📜 License

This project is licensed under the MIT License.