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

feature: add new hook useescClose for closing element in keypress #666

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

Conversation

jihostudy
Copy link

This PR introduces a new custom hook, useEscClose.

useEscClose is designed to close open pages or components, such as modals, by pressing the ESC key. Users often expect to be able to close open elements like modals or toasts using the ESC key. This hook provides a solution for such scenarios. By passing a boolean value (indicating whether the target is open) and a callback function (to be executed after closing) as arguments, this hook attaches an ESC event listener to the window object and handles the ESC key action accordingly.

Copy link

changeset-bot bot commented Jan 1, 2025

⚠️ No Changeset found

Latest commit: f871feb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@A1X5H04
Copy link

A1X5H04 commented Jan 13, 2025

Suggestion

This would be much better if the hook supports hotkeys instead of specific key, in this case an 'ESC' key.

For eg:
If a user wants to do something when a key is pressed, you can expose a callback function that will execute when a key (or certain key combination) is pressed, you can use any helper library or create one from scratch, you may also include a threshold when to press key combination etc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants