avo-hq/avo

Keyboard shortcuts

Open

#2,665 opened on Apr 6, 2024

View on GitHub
 (4 comments) (1 reaction) (0 assignees)Ruby (308 forks)user submission
Avo 4FeatureHelp wantedJavascriptTask

Repository metrics

Stars
 (1,778 stars)
PR merge metrics
 (Avg merge 1d 6h) (67 merged PRs in 30d)

Description

Feature

We'd love to add keyboard shortcuts to Avo. We already have Mousetrap installed but I think this solution (2025 update) from Yaro is a bit more Stimulus-oriented.

This is another approach (https://github.com/github/hotkey, controller)

Initial shortcuts

We don't need to support "everything" in the initial iteration, so let's pick a few we know they might be highly used.

  • Shift + ? Show a modal with the current shortcuts
  • Command + K Open search (already supported but we want to show it there)
  • command + return Save button
  • command + \ toggle sidebar
  • esc close modal. Ensure it really closes all modals
  • c create button when on an index view
  • anything else?

Current workarounds

Add them with custom JS.

Contributor guide

Research direction
Review the existing Stimulus setup in the Avo project, then implement the shortcut list using the hotkey library or Stimulus actions. Start with the simplest shortcuts like '?' modal and 'c' create button.
Tech stack
rubyjavascript
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
Ruby on RailsJavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75