Skip to content

fix(useMagicKeys): doesn't trigger on releasing and pressing again the second key in a combination #4691

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(useMagicKeys): doesn't trigger on releasing and pressing again the second key in a combination #4691

wants to merge 3 commits into from

Conversation

hunterwilhelm
Copy link

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

Fixes #3026

Additional context

This is the explanation of the issue and the solution

  1. On MacOS browser
  2. Press and hold ⌘
  3. Press Z twice
  4. The keydown event will fire twice, but the ref won't update because it is the same value.
  5. So, if a double keydown event is detected, run a manual keyup right before it.

@hunterwilhelm
fixes vueuse#3026 useMagicKeys - doesn't trigger on releasing and pre…
4218aa5 
…ssing again the second key in a combination
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 3, 2025
@ilyaliao ilyaliao changed the title fixes #3026 useMagicKeys - doesn't trigger on releasing and pressing again the second key in a combination fix(useMagicKeys): doesn't trigger on releasing and pressing again the second key in a combination Apr 4, 2025
OrbisK
OrbisK reviewed Apr 4, 2025
View reviewed changes
packages/core/useMagicKeys/index.ts
const key = e.key?.toLowerCase()
// #3026: doesn't trigger on releasing and pressing again the second key in a combination
// Solution: Trigger "keyup" event manually when "keydown" event is fired without "keyup"
if (key && e.getModifierState('Meta') && current.has(key)) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it this a meta key only problem? what about shift and ctrl?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@OrbisK Yes it's only a meta key problem. Shift and ctrl don't have any issues on Mac

More info:
https://stackoverflow.com/questions/25438608/javascript-keyup-isnt-called-when-command-and-another-is-pressed
https://blog.bitsrc.io/keyup-event-and-cmd-problem-88f4038c5ed2

@hunterwilhelm
Copy link
Author

@OrbisK Anything else needed for this to be merged?

@hunterwilhelm
Copy link
Author

Closing because I found a bug with this approach when holding cmd+z

@hunterwilhelm hunterwilhelm reopened this Apr 7, 2025
@hunterwilhelm
Copy link
Author

@OrbisK Reopening because supporting key repeats is out of scope for useMagicKeys. Instead, we're going to use onKeyStroke

@hunterwilhelm
Copy link
Author

@OrbisK Everything is working, and all tests are passing. Is there anything I can do to help get this approved?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@OrbisK OrbisK OrbisK left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

useMagicKeys - doesn't trigger on releasing and pressing again the second key in a combination
2 participants
@hunterwilhelm @OrbisK