ngx-keys

A reactive Angular library for managing keyboard shortcuts with signals-based UI integration.

Project Structure

This is an Angular workspace containing:

• projects/ngx-keys/ - The ngx-keys library source code
• projects/demo/ - Demo application showcasing library features
• Library Documentation - See projects/ngx-keys/README.md for complete API documentation

Quick Start

Install Dependencies

npm install

Run Demo Application

npm start

Navigate to http://localhost:4200/ to see the demo.

Build Library

ng build ngx-keys

Run Tests

npm test

Library Features

• Reactive Signals: Track active/inactive shortcuts with Angular signals for seamless UI integration
• Dynamic Management: Add, remove, activate/deactivate shortcuts and groups at runtime
• Cross-Platform: Automatic Mac/PC key display formatting (Ctrl+S vs ⌘+S)
• Group Management: Organize shortcuts into logical groups with bulk operations
• Conflict Detection: Comprehensive validation to prevent duplicate IDs and key combinations
• Browser-Safe: Documentation on avoiding browser conflicts
• Fully Tested: Comprehensive test coverage with Angular testing utilities

Documentation

For complete API documentation, examples, and best practices, see: ngx-keys Library Documentation

Development Commands

Command	Description
npm start	Start demo application at http://localhost:4200
npm test	Run unit tests
ng test ngx-keys	Run library tests specifically
ng build ngx-keys	Build library for production
ng build ngx-keys --watch	Build library in watch mode
ng build demo	Build demo application
ng test ngx-keys --watch=false	Run tests once without watch mode

Building

Library

ng build ngx-keys

Demo Application

ng build demo

Publishing

1. Build the library:

   ng build ngx-keys
   

2. Navigate to dist directory:

   cd dist/ngx-keys
   

3. Publish to npm:

   npm publish
   

License

0BSD © ngx-keys Contributors

This project is licensed under the BSD Zero Clause License - see the LICENSE file for details.