Add shortcat integration #1940
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| from talon import Module, actions, settings | ||
|
|
||
| mod = Module() | ||
|
|
||
| mod.setting( | ||
| "shortcat_hotkey", | ||
| type=str, | ||
| default="cmd-shift-space", | ||
| desc="Hotkey that is configured to activate Shortcat", | ||
| ) | ||
| mod.setting( | ||
| "shortcat_click_delay", | ||
| type=str, | ||
| default="500ms", | ||
| desc="Delay to wait for Shortcat to show the shortcuts before clicking", | ||
| ) | ||
|
|
||
|
|
||
| @mod.action_class | ||
| class Actions: | ||
| def shortcat_hover(text: str): | ||
| "Hover over a button using shortcat" | ||
| actions.key(settings.get("user.shortcat_hotkey")) | ||
| actions.sleep(settings.get("user.shortcat_click_delay")) | ||
| actions.insert(text) | ||
|
|
||
| def shortcat_click(text: str, click_delay: str = "0ms"): | ||
| "Click a button using shortcat" | ||
| actions.user.shortcat_hover(text) | ||
| actions.sleep(click_delay) | ||
| actions.key("enter") | ||
| actions.sleep("100ms") | ||
| actions.mouse_click(0) | ||
|
|
||
| def shortcat_double_click(text: str, click_delay: str = "0ms"): | ||
| "Double click a button using shortcat" | ||
| actions.user.shortcat_hover(text) | ||
| actions.sleep(click_delay) | ||
| actions.key("enter") | ||
| actions.sleep("100ms") | ||
| actions.mouse_click(0) | ||
| actions.mouse_click(0) | ||
|
Collaborator
There was a problem hiding this comment. Consider using a single action for single and multiple clicks. |
||
|
|
||
| def shortcat_right(text: str, click_delay: str = "0ms"): | ||
| "Right click a button using shortcat" | ||
| actions.user.shortcat_hover(text) | ||
| actions.sleep(click_delay) | ||
| actions.key("ctrl-enter") | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| os: mac | ||
| - | ||
|
|
||
| ^(shot | sot) [<user.text>]: user.shortcat_hover(text or "") | ||
|
|
||
| ^(shot | sot) click [<user.text>]: | ||
| # Add some delay to cancel click if needed | ||
| user.shortcat_click(text or "", "1500ms") | ||
|
Collaborator
There was a problem hiding this comment. I think that this delay would be incredibly frustrating in practice, not to mention it is likely to trigger Talon's watchdog timer and spam your log. I would recommend that you have this as a configurable setting, if you decide to use the cancel delay rather than a confirmation action. |
||
|
|
||
| ^(shot | sot) right [<user.text>]: | ||
| # Add some delay to cancel right-click if needed | ||
| user.shortcat_right(text or "", "1500ms") | ||
|
|
||
| ^(shot | sot) dub [<user.text>]: | ||
| # Add some delay to cancel double-click if needed | ||
| user.shortcat_double_click(text or "", "1500ms") | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From the community backlog session, we had a couple comments on this behavior.
If the delay is to give you time to cancel if the wrong button is about to be clicked, then using
actions.sleepwill block Talon and not allow you to cancel using a voice command or other Talon action. A couple options:cronsuch that Talon is active while it is waiting.Our preference is for the first option as we feel that any substantial delay long enough to give you a chance to cancel would be frustrating to use in practice.