ngXYZ-Konami
An Angular Module to add Konami Codes (Cheat Codes / Easter Eggs) to your Angular App
- Inspired by original Konami Cheat Codes
- You can also use it to Show/Hide features in your production website.
- You can use localstorage in combination and preserve the state of Showing/Hiding that feature, once revealed.
Basically, provided a code like "HELLO" and a Callback function. When the user types "HELLO" , the callback function will be called. You can do whatever you want in that callback.
Setup
npm i ngxyz-konami
Usage
- Well, first you gotta import NgxyzKonamiModule into your AppModule (or any other Module where you intend to use it)
;; ;
Inject the Service
; // inject the serviceconstructorprivate konamiService: NgxyzKonamiService
Simplest usage, a cheat when triggered shows the message in a message-dialog.
// register a cheatthis.konamiService.addCheat;// now click in an empty space, and type 'hello' without the quotes.
A cheat with callback, once triggered the callback will be called
// register a cheatthis.konamiService.addCheat;// now click in an empty space, and type 'hello' without the quotes.
Configure it in one go, register all the cheats at once.
// configure the service, all of this is optional, every option is optionalthis.konamiService.configure;// now click in an empty space, and type a code eg: 'bye' without the quotes.
Remove an already registered cheat.
this.konamiService.removeCheat'youtubeTime';
Get the original, already registered cheat.
this.konamiService.getCheat'youtubeTime';
Remove all the registered cheats.
this.konamiService.clearCheats;
Disable KonamiService manually.
this.konamiService.disable;
Enable KonamiService manually.
this.konamiService.enable;
For Contributors / Tinkerers
This library was generated with Angular CLI version 8.2.14.
Code scaffolding
Run ng generate component component-name --project ngxyz-konami
to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project ngxyz-konami
.
Note: Don't forget to add
--project ngxyz-konami
or else it will be added to the default project in yourangular.json
file.
Build
Run ng build ngxyz-konami
to build the project. The build artifacts will be stored in the dist/
directory.
Publishing
After building your library with ng build ngxyz-konami
, go to the dist folder cd dist/ngxyz-konami
and run npm publish
.
Running unit tests
Run ng test ngxyz-konami
to execute the unit tests via Karma.
Further help
To get more help on the Angular CLI use ng help
or go check out the Angular CLI README.