React Konami Code Hook
Call a function when a sequence of key presses is detected.
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
About The Project
Use the useKonamiCode hook to call a function when a sequence of key presses is detected:
useKonamiCode(
() => alert('Custom code activated.'),
{ sequence: [ 'a', 'b', 'x', 'y' ] }
)
Built With
Installation
- Install from NPM
npm i @twocatmoon/react-use-konami-code - Include in your project
import { useKonamiCode } from '@twocatmoon/react-use-konami-code'
Usage
Please refer to the Documentation
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Twitter - @twocatmoon
Project Link - https://github.com/twocatmoon/react-use-konami-code