Hotkey Recorder records wrong key format
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.7.1
Framework/Library version
Svelte 0.9.1
Describe the bug and the steps to reproduce it
When using createHotkeyRecorder, the recorded hotkey is using the wrong format.
When I record a Shift+1 hotkey, it captures a Shift+! instead. Same happens for the option key; Option+1 captures ⌥ ¡.
Using the validateHotkey function, validateHotkey('Shift+1') is valid and has no errors and warnings, but validateHotkey('Shift+!') has this warning: "Unknown key: '!'. This may still work but won't have type-safe autocomplete."
Expectation
Recording Shift+1 should return Shift+1, not Shift+!
Code
<script lang="ts">
import { createHotkeyRecorder, formatForDisplay, validateHotkey } from '@tanstack/svelte-hotkeys';
const recorder = createHotkeyRecorder({
onRecord: (hotkey) => {
console.log({
hotkey,
recorded: recorder.recordedHotkey,
formatForDisplay: formatForDisplay(hotkey),
});
},
});
console.log('validateHotkey("Shift+1")', validateHotkey('Shift+1'));
console.log('validateHotkey("Shift+!")', validateHotkey('Shift+!'));
</script>
<button
onclick={() => {
recorder.startRecording();
}}
>
Record
</button>
Your Minimal, Reproducible Example - (Sandbox Highly Recommended)
Screenshots or Videos (Optional)
https://github.com/user-attachments/assets/2097c392-1c24-4586-8656-9ab5d1e9fa7a
Do you intend to try to help solve this bug with your own PR?
No, because I do not have time to dig into it
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the createHotkeyRecorder entry point and compare how keyboard events produce Shift+1 versus Shift+!. Check the related validateHotkey behavior shown in the report, then reproduce the recorder example in Svelte. Done means recorded Shift+1 and Option+1 preserve their physical key format instead of becoming shifted symbols.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100