Skip to content

feat(utils): add more key event utils #69

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

Merged
merged 1 commit into from
Sep 12, 2024
Merged

feat(utils): add more key event utils #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions packages/utils/src/utils/key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,31 @@ export function isArrowDownKey(event: KeyboardEvent): boolean {
export function isArrowUpKey(event: KeyboardEvent): boolean {
return event.key === 'ArrowUp' || event.key === 'Up'
}

/**
* Returns `true` if the keyboard event was triggered by the `ArrowLeft` key
*/
export function isArrowLeftKey(event: KeyboardEvent): boolean {
return event.key === 'ArrowLeft' || event.key === 'Left'
}

/**
* Returns `true` if the keyboard event was triggered by the `ArrowRight` key
*/
export function isArrowRightKey(event: KeyboardEvent): boolean {
return event.key === 'ArrowRight' || event.key === 'Right'
}

/**
* Returns `true` if the keyboard event was triggered by the `Home` key
*/
export function isHomeKey(event: KeyboardEvent): boolean {
return event.key === 'Home'
}

/**
* Returns `true` if the keyboard event was triggered by the `End` key
*/
export function isEndKey(event: KeyboardEvent): boolean {
return event.key === 'End'
}