{"id":13720823,"url":"https://github.com/microsoft/node-native-keymap","last_synced_at":"2025-10-03T22:51:10.589Z","repository":{"id":40395905,"uuid":"48058516","full_name":"microsoft/node-native-keymap","owner":"microsoft","description":"Provide OS keyboard layout functionality as a nodejs module","archived":false,"fork":false,"pushed_at":"2025-06-12T17:25:33.000Z","size":289,"stargazers_count":144,"open_issues_count":10,"forks_count":37,"subscribers_count":47,"default_branch":"main","last_synced_at":"2025-10-02T00:38:47.248Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"License.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-15T17:29:01.000Z","updated_at":"2025-09-04T05:09:00.000Z","dependencies_parsed_at":"2024-01-22T15:33:06.739Z","dependency_job_id":"abeb51b2-3105-4259-84ef-f64822a7eabd","html_url":"https://github.com/microsoft/node-native-keymap","commit_stats":{"total_commits":172,"total_committers":21,"mean_commits":8.19047619047619,"dds":0.2267441860465116,"last_synced_commit":"d0f4fb507bf5e3551775338db4732038060d5aef"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/node-native-keymap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fnode-native-keymap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fnode-native-keymap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fnode-native-keymap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fnode-native-keymap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/node-native-keymap/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fnode-native-keymap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278239970,"owners_count":25954097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-03T02:00:06.070Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2024-08-03T01:01:08.470Z","updated_at":"2025-10-03T22:51:10.563Z","avatar_url":"https://github.com/microsoft.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"# OS key mapping node module [![Build Status](https://dev.azure.com/ms/node-native-keymap/_apis/build/status/microsoft.node-native-keymap?branchName=master)](https://dev.azure.com/ms/node-native-keymap/_build/latest?definitionId=138\u0026branchName=master)\nReturns what characters are produced by pressing keys with different modifiers on the current system keyboard layout.\n\n## Installing\n\n* On Debian-based Linux: `sudo apt-get install libx11-dev libxkbfile-dev`\n* On Red Hat-based Linux: `sudo yum install libx11-devel.x86_64 libxkbfile-devel.x86_64 # or .i686`\n* On SUSE-based Linux: `sudo zypper install libX11-devel libxkbfile-devel`\n* On FreeBSD: `sudo pkg install libX11`\n\n```sh\nnpm install native-keymap\n```\n\n## Using\n\n```javascript\nvar keymap = require('native-keymap');\nconsole.log(keymap.getKeyMap());\n```\n\nExample output when using standard US keyboard layout (on Windows):\n```\n[\n  ...\n  Space:        { vkey: 'VK_SPACE',      value: ' ',  withShift: ' ', withAltGr: '', withShiftAltGr: '' },\n  Minus:        { vkey: 'VK_OEM_MINUS',  value: '-',  withShift: '_', withAltGr: '', withShiftAltGr: '' },\n  Equal:        { vkey: 'VK_OEM_PLUS',   value: '=',  withShift: '+', withAltGr: '', withShiftAltGr: '' },\n  BracketLeft:  { vkey: 'VK_OEM_4',      value: '[',  withShift: '{', withAltGr: '', withShiftAltGr: '' },\n  BracketRight: { vkey: 'VK_OEM_6',      value: ']',  withShift: '}', withAltGr: '', withShiftAltGr: '' },\n  Backslash:    { vkey: 'VK_OEM_5',      value: '\\\\', withShift: '|', withAltGr: '', withShiftAltGr: '' },\n  Semicolon:    { vkey: 'VK_OEM_1',      value: ';',  withShift: ':', withAltGr: '', withShiftAltGr: '' },\n  Quote:        { vkey: 'VK_OEM_7',      value: '\\'', withShift: '\"', withAltGr: '', withShiftAltGr: '' },\n  Backquote:    { vkey: 'VK_OEM_3',      value: '`',  withShift: '~', withAltGr: '', withShiftAltGr: '' },\n  Comma:        { vkey: 'VK_OEM_COMMA',  value: ',',  withShift: '\u003c', withAltGr: '', withShiftAltGr: '' },\n  Period:       { vkey: 'VK_OEM_PERIOD', value: '.',  withShift: '\u003e', withAltGr: '', withShiftAltGr: '' },\n  Slash:        { vkey: 'VK_OEM_2',      value: '/',  withShift: '?', withAltGr: '', withShiftAltGr: '' },\n  ...\n]\n```\n\nExample output when using German (Swiss) keyboard layout (on Windows):\n```\n[\n  ...\n  Space:        { vkey: 'VK_SPACE',      value: ' ',  withShift: ' ', withAltGr: '',  withShiftAltGr: '' },\n  Minus:        { vkey: 'VK_OEM_4',      value: '\\'', withShift: '?', withAltGr: '´', withShiftAltGr: '' },\n  Equal:        { vkey: 'VK_OEM_6',      value: '^',  withShift: '`', withAltGr: '~', withShiftAltGr: '' },\n  BracketLeft:  { vkey: 'VK_OEM_1',      value: 'ü',  withShift: 'è', withAltGr: '[', withShiftAltGr: '' },\n  BracketRight: { vkey: 'VK_OEM_3',      value: '¨',  withShift: '!', withAltGr: ']', withShiftAltGr: '' },\n  Backslash:    { vkey: 'VK_OEM_8',      value: '$',  withShift: '£', withAltGr: '}', withShiftAltGr: '' },\n  Semicolon:    { vkey: 'VK_OEM_7',      value: 'ö',  withShift: 'é', withAltGr: '',  withShiftAltGr: '' },\n  Quote:        { vkey: 'VK_OEM_5',      value: 'ä',  withShift: 'à', withAltGr: '{', withShiftAltGr: '' },\n  Backquote:    { vkey: 'VK_OEM_2',      value: '§',  withShift: '°', withAltGr: '',  withShiftAltGr: '' },\n  Comma:        { vkey: 'VK_OEM_COMMA',  value: ',',  withShift: ';', withAltGr: '',  withShiftAltGr: '' },\n  Period:       { vkey: 'VK_OEM_PERIOD', value: '.',  withShift: ':', withAltGr: '',  withShiftAltGr: '' },\n  Slash:        { vkey: 'VK_OEM_MINUS',  value: '-',  withShift: '_', withAltGr: '',  withShiftAltGr: '' },\n  ...\n]\n```\n\n## Supported OSes\n * linux (X11)\n * windows\n * mac\n * freebsd\n\n## Known issues\n * only tested from the Electron Main process\n\n## Developing\n * `npm install -g node-gyp`\n * `node-gyp configure` (for debugging use `node-gyp configure -d`)\n * `node-gyp build`\n * `npm test` (for debugging change `index.js` to load the node module from the `Debug` folder and press `F5`)\n\n## License\n[MIT](https://github.com/Microsoft/node-native-keymap/blob/master/License.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fnode-native-keymap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fnode-native-keymap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fnode-native-keymap/lists"}