Skip to content
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.

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

fix(x6-plugin-keyboard): triggerKey should use formatKey before call mousetrap #4479

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

phiwyc
Copy link

@phiwyc phiwyc commented Oct 24, 2024

Description

A bugfix of triggerKey function in x6-plugin-keyboard.

Motivation and Context

X6 uses mousetrap as keyboard event listener, but the keys of keyboard are different between X6 and mousetrap. X6 uses a function called "formatKey" to translate X6 keyboard key to mousetrap keyboard key. For example: 'delete' in X6 will translate to 'del' in mousetrap.

But the triggerKey function didn't apply this formatKey function, this cound lead to some misunderstandings, developers may use triggerKey('delete'), but mousetrap accutally can't recognize what 'delete' is. That will look like a bug.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Enhancement (changes that improvement of current feature or performance)
  • Refactoring (changes that neither fixes a bug nor adds a feature)
  • Test Case (changes that add missing tests or correct existing tests)
  • Code style optimization (changes that do not affect the meaning of the code)
  • Docs (changes that only update documentation)
  • Chore (changes that don't modify src or test files)

Self Check before Merge

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • [ x] All new and existing tests passed.

@x6-bot
Copy link
Contributor

x6-bot bot commented Oct 24, 2024

👋 @phiwyc

💖 Thanks for opening this pull request! 💖

Please follow the contributing guidelines. And we use semantic commit messages to streamline the release process.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add graph.scale() method
  • docs: graph.getShortestPath is now available

Things that will help get your PR across the finish line:

  • Follow the TypeScript, JavaScript, CSS and React coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@x6-bot x6-bot bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. PR: unreviewed PR does not have any reviews. labels Oct 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: unreviewed PR does not have any reviews. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant