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.

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

fix(useHotKey): allow hotkeys with implicit SHIFT and add caseSensitive, custom event filter options #6301

Merged
merged 3 commits into from
Dec 20, 2024
Merged

fix(useHotKey): allow hotkeys with implicit SHIFT and add caseSensitive, custom event filter options #6301

merged 3 commits into from
Dec 20, 2024

Conversation

Antreesy
Copy link
Contributor

@Antreesy Antreesy commented Dec 11, 2024 •
edited
Loading

☑️ Resolves

  • Fixup to feat(useHotKey): add composable for keyboard shortcuts #5899
  • make sure shift modifier is defined, rest are treated as false by default
    • this allows to use composable with ?, which is Shift + /
  • add caseSensitive modifier (false by default)
    • this allows to use composable with d and D by only defining one of them
  • adjust documentation and code comments
    • default modifiers values
    • keysOrFilter arguments typing

🖼️ Screenshots

No visual changes

🚧 Tasks

  • TODO: add key code support

🏁 Checklist

  • ⛑️ Tests are included or are not applicable
  • 📘 Component documentation has been extended, updated or is not applicable
  • 3️⃣ Backport to next requested with a Vue 3 upgrade

@Antreesy
fix(useHotKey): make sure shift modifier is defined
527d251 
- adjust documentation and code comments

Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
@Antreesy
docs(useHotKey): describe support of keyFilter function
c67b40c 
- it is allowed by composable and supported by upstream library, but not defined in vue-lib documentation

Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
@Antreesy
fix(useHotKey): validate event keys as case-insensitive by default
85cb275 
Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
@Antreesy Antreesy added bug Something isn't working 3. to review Waiting for reviews feature: functions composables, functions, mixins and other non-components labels Dec 11, 2024
@Antreesy Antreesy added this to the 8.21.1 milestone Dec 11, 2024
@Antreesy Antreesy self-assigned this Dec 11, 2024
skjnldsv
skjnldsv approved these changes Dec 14, 2024
View reviewed changes
Copy link
Contributor

@skjnldsv skjnldsv left a comment

Choose a reason for hiding this comment

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

Works

@Antreesy Antreesy requested a review from ShGKme December 14, 2024 13:32
@ShGKme ShGKme changed the title fix(useHotKey): composable fixups fix(useHotKey): allow hotkeys with implicit SHIFT and add caseSensetive, custom event filter options Dec 20, 2024
@Antreesy Antreesy merged commit d0f4bd9 into master Dec 20, 2024
19 checks passed
@Antreesy Antreesy deleted the fix/5899/usehotkey-fixups branch December 20, 2024 12:52
@Antreesy
Copy link
Contributor Author

/backport to next

@backportbot backportbot bot mentioned this pull request Dec 20, 2024
Merged
@Antreesy Antreesy changed the title fix(useHotKey): allow hotkeys with implicit SHIFT and add caseSensetive, custom event filter options fix(useHotKey): allow hotkeys with implicit SHIFT and add caseSensitive, custom event filter options Dec 20, 2024
@hamza221 hamza221 mentioned this pull request Dec 20, 2024
Merged
@susnux susnux modified the milestones: 8.21.1, 8.22.0 Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ShGKme ShGKme ShGKme approved these changes

@skjnldsv skjnldsv skjnldsv approved these changes

@DorraJaouad DorraJaouad Awaiting requested review from DorraJaouad

Assignees

@Antreesy Antreesy

Labels
3. to review Waiting for reviews bug Something isn't working feature: functions composables, functions, mixins and other non-components
Projects
None yet
Milestone
8.22.0
Development

Successfully merging this pull request may close these issues.
4 participants
@Antreesy @skjnldsv @ShGKme @susnux