A simple [Angular](https://angular.io) module to bring an easy way to listen to keyboard events in a modularized way consistent with Angular's style.
npm install ngx-keyboard-events
ngx-keyboard-events assumes that you're using Angular in a browser environment. Angular has changed a lot since I started using it, so I'm pretty sure this is a terrible assumption. If you're using it elsewhere and want to offer some recommendations on how to make this library more friendly to other environments, open an issue!
bash
npm i ngx-keyboard-events
`
app.module.ts
`typescript
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { NgxKeyboardEventsModule } from 'ngx-keyboard-events';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
NgxKeyboardEventsModule, // import the module
],
bootstrap: [AppComponent]
})
export class AppModule { }
`
some.component.ts
`typescript
import { Component, OnInit } from '@angular/core';
import { NgxKeyboardEventsService, NgxKeyboardEvent } from 'ngx-keyboard-events';
@Component({
selector: 'ngx-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent implements OnInit {
title = 'ngx';
constructor(private keyboardEventsService: NgxKeyboardEventsService) { }
ngOnInit() {
this.keyboardEventsService.onKeyPressed.subscribe((keyEvent: NgxKeyboardEvent) => {
console.log('key event', keyEvent);
});
}
}
`
Know issues
The current implementation of the service makes prodigious use of keyEvent.keyCode by mapping numerical values from this property to a Typescript enum for a better developer experience. keyCode is deprecated in favor of key, a string property. I need to rejigger my solution so that 1) it takes advantage of the complete set of possible values for key, and 2) it no longer relies on keyCode`. This issue is being tracked here.