{"id":31193198,"url":"https://github.com/mrivasperez/ngx-keys","last_synced_at":"2026-02-01T22:00:17.366Z","repository":{"id":314816960,"uuid":"1051965106","full_name":"mrivasperez/ngx-keys","owner":"mrivasperez","description":"A reactive Angular library for managing keyboard shortcuts with signals-based UI integration.","archived":false,"fork":false,"pushed_at":"2025-10-19T19:25:00.000Z","size":118,"stargazers_count":15,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-10-20T02:26:55.653Z","etag":null,"topics":["accessibility","angular","angular-18","angular-19","angular-20","angular-library","developer-tools","hotkeys","keyboard-shortcuts","signals","typescript","zoneless"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ngx-keys","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"0bsd","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrivasperez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-07T05:23:11.000Z","updated_at":"2025-10-19T19:32:45.000Z","dependencies_parsed_at":"2025-09-15T01:19:17.463Z","dependency_job_id":"63c08602-d2af-4ae1-b035-ddf7e97f4a98","html_url":"https://github.com/mrivasperez/ngx-keys","commit_stats":null,"previous_names":["mrivasperez/ngx-keys"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/mrivasperez/ngx-keys","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrivasperez%2Fngx-keys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrivasperez%2Fngx-keys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrivasperez%2Fngx-keys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrivasperez%2Fngx-keys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrivasperez","download_url":"https://codeload.github.com/mrivasperez/ngx-keys/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrivasperez%2Fngx-keys/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28992626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T20:57:35.821Z","status":"ssl_error","status_checked_at":"2026-02-01T20:57:29.580Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","angular","angular-18","angular-19","angular-20","angular-library","developer-tools","hotkeys","keyboard-shortcuts","signals","typescript","zoneless"],"created_at":"2025-09-20T00:03:19.686Z","updated_at":"2026-02-01T22:00:16.940Z","avatar_url":"https://github.com/mrivasperez.png","language":"TypeScript","funding_links":[],"categories":["Third Party Components"],"sub_categories":["Keyboard Mouse"],"readme":"# ngx-keys\n\nA reactive Angular library for managing keyboard shortcuts with signals-based UI integration.\n\n## Project Structure\n\nThis is an Angular workspace containing:\n\n- **`projects/ngx-keys/`** - The ngx-keys library source code\n- **`projects/demo/`** - Demo application showcasing library features\n- **Library Documentation** - See [`projects/ngx-keys/README.md`](./projects/ngx-keys/README.md) for complete API documentation\n\n## Quick Start\n\n### Install Dependencies\n```bash\nnpm install\n```\n\n### Run Demo Application\n```bash\nnpm start\n```\nNavigate to `http://localhost:4200/` to see the demo.\n\n### Build Library\n```bash\nng build ngx-keys\n```\n\n### Run Tests\n```bash\nnpm test\n```\n\n## Library Features\n\n- **Reactive Signals**: Track active/inactive shortcuts with Angular signals for seamless UI integration\n- **Dynamic Management**: Add, remove, activate/deactivate shortcuts and groups at runtime\n- **Cross-Platform**: Automatic Mac/PC key display formatting (`Ctrl+S` vs `⌘+S`)\n- **Group Management**: Organize shortcuts into logical groups with bulk operations\n- **Conflict Detection**: Comprehensive validation to prevent duplicate IDs and key combinations\n- **Browser-Safe**: Documentation on avoiding browser conflicts\n- **Fully Tested**: Comprehensive test coverage with Angular testing utilities\n\n## Documentation\n\nFor complete API documentation, examples, and best practices, see:\n**[ngx-keys Library Documentation](./projects/ngx-keys/README.md)**\n\n## Development Commands\n\n| Command | Description |\n|---------|-------------|\n| `npm start` | Start demo application at http://localhost:4200 |\n| `npm test` | Run unit tests |\n| `ng test ngx-keys` | Run library tests specifically |\n| `ng build ngx-keys` | Build library for production |\n| `ng build ngx-keys --watch` | Build library in watch mode |\n| `ng build demo` | Build demo application |\n| `ng test ngx-keys --watch=false` | Run tests once without watch mode |\n\n## Building\n\n### Library\n```bash\nng build ngx-keys\n```\n\n### Demo Application  \n```bash\nng build demo\n```\n\n## Publishing\n\n1. Build the library:\n   ```bash\n   ng build ngx-keys\n   ```\n\n2. Navigate to dist directory:\n   ```bash\n   cd dist/ngx-keys\n   ```\n\n3. Publish to npm:\n   ```bash\n   npm publish\n   ```\n\n## License\n\n0BSD © [ngx-keys Contributors](LICENSE)\n\nThis project is licensed under the BSD Zero Clause License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrivasperez%2Fngx-keys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrivasperez%2Fngx-keys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrivasperez%2Fngx-keys/lists"}