styleguidist/react-styleguidist

Keyboard shortcuts

Open

#1,036 opened on Jun 29, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
enhancementhelp wantedrequest for comments

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

The problem As a developer, I want to be able to navigate through the stories using just the keyboard.

Proposed solution Add keyboard shortcuts.

Request for comments Scope for this first feature:

  • Implement the following keyboard shortcuts:
  • / : Focus filter input
  • ? : Display an overlay with keyboard shortcuts

External references

Contributor guide

Research direction
Add keyboard event listeners for '/' and '?' keys. For '/', focus the filter input. For '?', show an overlay listing shortcuts. Use React lifecycle or useEffect for binding/unbinding listeners.
Tech stack
reacttypescript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ReactKeyboardEvents
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70