yuvrajkarna2717/react-hook-granth

[Feature]: Add useKeyboard hook for keyboard shortcuts

Open

#10 opened on Dec 6, 2025

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)JavaScript (1 fork)auto 404
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (3 stars)
PR merge metrics
 (PR metrics pending)

Description

Hook Name

useKeyboard

Feature Description

Description: Create a hook for handling keyboard shortcuts and key combinations in React components.

Requirements:

  • Single key and key combinations
  • Modifier keys support (Ctrl, Alt, Shift)
  • Prevent default behavior option
  • Multiple shortcuts per component

Use Case

It handles keyboard shortcuts and key combinations in React components.

Proposed API

useKeyboard('Escape', handleEscape);
useKeyboard(['Ctrl', 'S'], handleSave);

Contributor guide

Research direction
Study existing React hooks libraries for keyboard shortcuts like useKeys or react use's useKey. Understand the implementation pattern: attach an event listener to window, handle keydown events, check for key matches and modifier keys, optionally call e.preventDefault(). The hook should return nothing or a set of active keys.
Tech stack
javascriptreact
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactJavaScriptuseEffectuseCallback
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80