TanStack / TanStack/hotkeys

'Space'-shortcut overrides native behavior triggering focused elements

Open
#142 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
719
Forks
47
Avg merge
5d 5h
Merged PRs (30d)
1

Description

TanStack Hotkeys version

0.10.0

Framework/Library version

React 18.3.1

Describe the bug and the steps to reproduce it

Issue:
The space key can be used (at least on Mac) to trigger a focussed element such as a button.
The smart default (smart default: false for Mod+S, true for single keys) doesn't take this behavior into account.
This means once a useHotkey('Space',...-shortcut is set up this behavior is lost.

Likely a similar case for the "Enter"-key

Expected behavior:
It should make an exception for button-like (buttons, checkboxes, links, etc.) to preserve native behavior. i.e. "click" the button if focused, even if a 'Short'-hotkey is set.

My workaround:

const isNothingFocused = () => {
    return document.activeElement === document.body || document.activeElement === null;
};

useHotkey('Space', () => {
    if (isNothingFocused()) {
      doSomeAction();
    } else {
      // Allow space for confirmation
      (document.activeElement as HTMLElement)?.click();
    }
});
Your Minimal, Reproducible Example - (Sandbox Highly Recommended)

https://codesandbox.io/p/sandbox/stoic-snyder-59xd9x

Screenshots or Videos (Optional)

No response

Do you intend to try to help solve this bug with your own PR?

No, because I do not know how or whether it follows your design principles

Terms & Code of Conduct
  • I agree to follow this project's Code of Conduct
  • I understand that if my bug cannot be reliable reproduced in a debuggable environment, it will probably not be fixed and this issue may even be closed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked CodeSandbox and trace how useHotkey('Space', ...) handles focused elements, especially document.activeElement. The change is done when Space preserves native activation for focused button-like elements while still triggering the shortcut when nothing relevant is focused; consider whether Enter has the same behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.