Hammerspoon/hammerspoon

hotkey.modal that ignores anything but given hotkeys

Open

#1505 opened on Jul 30, 2017

View on GitHub
 (12 comments) (0 reactions) (1 assignee)Objective-C (15,415 stars) (688 forks)batch import
enhancementhelp wanted

Description

Is it possible to have a hs.hotkey.modal with a few bindings that would ignore all the other keys. Let's say if I have:

local myModal = hs.hotkey.modal.new({"cmd"}, "space")
myModal:bind("", "g", nil, openGoogleChrome())
myModal:bind("", "f", nil, openFirefox())
myModal:bind("", "s", nil, openSafari())

Then if I press cmd+space, it will activate the modal, in which it would only respond to g, f, and s. Any other keys would be simply ignored. Is that even possible?

Contributor guide

Tech stack
None
Domain
desktoptooling
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Lua scriptingfamiliarity with hs.hotkey module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the current hs.hotkey.modal implementation in the Hammerspoon source code (likely in the hotkey extension). Look for how key events are handled and see if there is a method to filter keys. Consider creating a new method or modifying the modal to allow a whitelist of keys. Check the comments in issue #1505 for any proposed solutions or workarounds.