[ { "path": ".editorconfig", "content": "# http://editorconfig.org\nroot = true\n\n[*]\nindent_style = space\nindent_size = 2\nend_of_line = lf\ncharset = utf-8\ntrim_trailing_whitespace = true\ninsert_final_newline = true\n\n[*.md]\ntrim_trailing_whitespace = false\n\n[Makefile]\nindent_style = tab\n" }, { "path": ".github/FUNDING.yml", "content": "github: [jaywcjlove]\n#ko_fi: jaywcjlove\n#buy_me_a_coffee: jaywcjlove\n# custom: [\"https://wangchujiang.com/#/sponsor\"]\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\non:\n push:\n branches:\n - master\n # tags:\n # - v*\n\nenv:\n SKIP_PREFLIGHT_CHECK: true\n\njobs:\n build-deploy:\n runs-on: ubuntu-latest\n permissions:\n contents: write\n id-token: write\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-node@v6\n with:\n node-version: 24\n registry-url: 'https://registry.npmjs.org'\n\n - name: Look Changelog\n uses: jaywcjlove/changelog-generator@main\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n filter-author: (jaywcjlove|小弟调调™|dependabot\\[bot\\]|Renovate Bot)\n filter: (^[\\s]+?[R|r]elease)|(^[R|r]elease)\n\n - run: npm install\n - run: npm run build\n - run: npm run test\n - run: cp -rp dist doc\n - run: cp -rp coverage/lcov-report doc\n\n - name: Extract coverage percentage\n id: coverage\n run: |\n COVERAGE=$(cat coverage/js-coverage.txt)\n echo \"coverage=$COVERAGE\" >> $GITHUB_OUTPUT\n echo \"Coverage: $COVERAGE%\"\n\n - name: Generate Badges\n uses: jaywcjlove/generated-badges@main\n with:\n label: coverage\n status: ${{ steps.coverage.outputs.coverage }}%\n output: doc/coverage.svg\n\n - name: Generate Contributors Images\n uses: jaywcjlove/github-action-contributors@main\n with:\n filter-author: (renovate\\[bot\\]|renovate-bot|dependabot\\[bot\\])\n output: doc/CONTRIBUTORS.svg\n avatarSize: 42\n\n - name: Create Tag\n id: create_tag\n uses: jaywcjlove/create-tag-action@main\n with:\n package-path: ./package.json\n\n - name: get tag version\n id: tag_version\n uses: jaywcjlove/changelog-generator@main\n\n - name: Build and Deploy\n uses: peaceiris/actions-gh-pages@v4\n with:\n commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }}\n github_token: ${{ secrets.GITHUB_TOKEN }}\n publish_dir: ./doc\n\n - name: Generate Changelog\n id: changelog\n uses: jaywcjlove/changelog-generator@main\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n filter-author: (jaywcjlove|小弟调调™|dependabot\\[bot\\]|Renovate Bot)\n filter: (^[\\s]+?[R|r]elease)|(^[R|r]elease)\n\n - run: |\n echo \"tag: ${{ steps.changelog.outputs.tag }}\"\n echo \"version: ${{ steps.changelog.outputs.version }}\"\n echo \"ref: ${{ github.ref }}\"\n\n - name: Create Release\n uses: ncipollo/release-action@v1\n if: steps.create_tag.outputs.successful\n with:\n allowUpdates: true\n token: ${{ secrets.GITHUB_TOKEN }}\n name: ${{ steps.create_tag.outputs.version }}\n tag: ${{ steps.create_tag.outputs.version }}\n body: |\n [![Buy me a coffee](https://img.shields.io/badge/Buy%20me%20a%20coffee-048754?logo=buymeacoffee)](https://jaywcjlove.github.io/#/sponsor) [![](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/hotkeys-js@${{steps.changelog.outputs.version}}/file/README.md) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/hotkeys-js)](https://bundlephobia.com/result?p=hotkeys-js@${{steps.changelog.outputs.version}}) [![npm version](https://img.shields.io/npm/v/hotkeys-js.svg)](https://www.npmjs.com/package/hotkeys-js)\n \n Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/hotkeys/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html \n Comparing Changes: ${{ steps.changelog.outputs.compareurl }} \n\n ```bash\n npm i hotkeys-js@${{steps.changelog.outputs.version}}\n ```\n\n ${{ steps.changelog.outputs.changelog }}\n\n - name: package.json info\n uses: jaywcjlove/github-action-package@main\n with:\n unset: browserslist,lint-staged,devDependencies,jest,scripts\n \n # node@v24.0.0+ \n # https://gist.github.com/jaywcjlove/a178278521a6f72c74525d3f1d9c4bf9\n - run: NODE_AUTH_TOKEN=\"\" npm publish --access public --provenance\n name: 📦 hotkeys-js to NPM\n continue-on-error: true" }, { "path": ".github/workflows/pr.yml", "content": "name: CI-PR\non:\n pull_request:\n\nenv:\n SKIP_PREFLIGHT_CHECK: true\n\njobs:\n build-deploy:\n runs-on: ubuntu-latest\n permissions:\n contents: write\n id-token: write\n steps:\n - uses: actions/checkout@v6\n - uses: actions/setup-node@v6\n with:\n node-version: 24\n registry-url: 'https://registry.npmjs.org'\n\n - name: Look Changelog\n uses: jaywcjlove/changelog-generator@main\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n filter-author: (jaywcjlove|小弟调调™|dependabot\\[bot\\]|Renovate Bot)\n filter: (^[\\s]+?[R|r]elease)|(^[R|r]elease)\n\n - run: npm install\n - run: npm run build\n - run: npm run test\n " }, { "path": ".gitignore", "content": "npm-debug.log\nyarn.lock\nnode_modules\nbuild\ndoc\ncoverage\n\n.DS_Store\n.cache\n.vscode\n.idea\n\n*.bak\n*.tem\n*.temp\n#.swp\n*.*~\n~*.*\n" }, { "path": ".husky/.gitignore", "content": "_\n" }, { "path": ".husky/pre-commit", "content": "#!/bin/sh\n. \"$(dirname \"$0\")/_/husky.sh\"\n\nnpx lint-staged\n" }, { "path": ".npmignore", "content": "# Exclude test files\ndist/test-formats.html\n\n# Exclude development files\nsrc/\ntest/\nwebsite/\ncoverage/\n\n# Exclude configuration files\n*.config.ts\n*.config.js\neslint.config.js\ntsconfig.json\n\n# Exclude other unnecessary files\nREADME-zh.md\nDISTRIBUTION-GUIDE.md\nDISTRIBUTION-GUIDE-zh.md\n.github/\n.gitignore\n.husky/" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2015-present, Kenny Wong.\n\nCopyright (c) 2011-2013 Thomas Fuchs (https://github.com/madrobby/keymaster)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README-zh.md", "content": "
\n 使用我的应用也是一种支持我的方式：\n
\n \"Scap:\n \"Screen\n \"Deskmark\"\n \"Keyzer\"\n \"Vidwall\n \"VidCrop\"\n \"Vidwall\"\n \"Mousio\n \"Mousio\"\n \"Musicer\"\n \"Audioer\"\n \"FileSentinel\"\n \"FocusCursor\"\n \"Videoer\"\n \"KeyClicker\"\n \"DayBar\"\n \"Iconed\"\n \"Menuist\"\n \"Quick\n \"Quick\n \"Web\n \"Copybook\n \"DevTutor\n \"RegexMate\"\n \"Time\n \"Iconize\n \"Textsound\n \"Create\n \"DevHub\"\n \"Resume\n \"Palette\n \"Symbol\n
\n
\n\n# Hotkeys\n\n\n\n[![Buy me a coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-ffdd00?logo=buy-me-a-coffee&logoColor=black)](https://jaywcjlove.github.io/#/sponsor)\n[![Follow On X](https://img.shields.io/badge/Follow%20on%20X-333333?logo=x&logoColor=white)](https://x.com/jaywcjlove)\n[![](https://img.shields.io/npm/dm/hotkeys-js?logo=npm)](https://www.npmjs.com/package/hotkeys-js)\n[![](https://img.shields.io/github/stars/jaywcjlove/hotkeys-js.svg)](https://github.com/jaywcjlove/hotkeys/stargazers)\n[![GitHub Actions CI](https://github.com/jaywcjlove/hotkeys-js/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/hotkeys-js/actions/workflows/ci.yml)\n[![Coverage Status](https://jaywcjlove.github.io/hotkeys-js/coverage.svg)](https://jaywcjlove.github.io/hotkeys-js/lcov-report/index.html)\n[![English](https://jaywcjlove.github.io/sb/lang/english.svg)](https://jaywcjlove.github.io/hotkeys-js/)\n[![jaywcjlove/hotkeys-js](https://jaywcjlove.github.io/sb/ico/gitee.svg)](https://gitee.com/jaywcjlove/hotkeys)\n\nHotKeys.js 是一个具有一些非常特殊功能的输入捕获库，它易于上手和使用，占用空间合理（[~8kB](https://bundlephobia.com/result?p=hotkeys-js)）（压缩后：**`3.8kB`**），无依赖。它不应该干扰任何 JavaScript 库或框架。官方文档 [演示预览](https://jaywcjlove.github.io/hotkeys-js)，[兼容性测试](https://jaywcjlove.github.io/hotkeys-js/dist/compatibility-test.html)。[更多示例](https://github.com/jaywcjlove/hotkeys-js/issues?q=label%3ADemo+)。\n\n```bash\n╭┈┈╮ ╭┈┈╮ ╭┈┈╮\n┆ ├┈┈..┈┈┈┈┈.┆ └┈╮┆ ├┈┈..┈┈┈┈┈..┈┈.┈┈..┈┈┈┈┈.\n┆ ┆┆ □ ┆┆ ┈┤┆ < ┆ -__┘┆ ┆ ┆┆__ ┈┈┤\n╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈┈╯╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈ ┆╰┈┈┈┈┈╯\n ╰┈┈┈┈┈╯\n```\n\n## 使用\n\n您的系统需要安装 `Node.js`。\n\n```bash\nnpm install hotkeys-js --save\n```\n\n```js\nimport hotkeys from 'hotkeys-js';\n\nhotkeys('f5', function(event, handler){\n // 阻止 WINDOWS 系统下的默认刷新事件\n event.preventDefault()\n alert('你按下了 F5!')\n});\n```\n\n### 浏览器使用\n\n或者手动下载并在 HTML 中链接 **hotkeys.js**。该库提供了不同格式以满足不同的使用需求：\n\n**CDN 链接：** [UNPKG](https://unpkg.com/hotkeys-js/dist/) | [jsDelivr](https://cdn.jsdelivr.net/npm/hotkeys-js/) | [Githack](https://raw.githack.com/jaywcjlove/hotkeys/master/dist/) | [Statically](https://cdn.statically.io/gh/jaywcjlove/hotkeys/master/dist/)\n\n**可用格式：**\n\n**IIFE（立即调用函数表达式）- 推荐用于直接浏览器使用：**\n\n```html\n\n\n```\n\n**UMD（通用模块定义）- 用于 CommonJS/AMD 环境：**\n\n```html\n\n```\n\n**ES 模块 - 用于支持模块的现代浏览器：**\n\n```html\n\n```\n\n### 在 React 中使用\n\n[react-hotkeys](https://github.com/jaywcjlove/react-hotkeys) 是监听 keydown 和 keyup 键盘事件的 React 组件，定义和调度键盘快捷键。详细的使用方法请查看其文档 [react-hotkeys](https://github.com/jaywcjlove/react-hotkeys)。 \n[react-hotkeys-hook](https://github.com/JohannesKlauss/react-hotkeys-hook) - 在组件中使用键盘快捷键的 React hook。请确保您至少安装了 react 和 react-dom 的 16.8 版本，否则 hooks 将不会为您工作。\n\n## 浏览器支持\n\nHotkeys.js 已经过测试，应该在以下浏览器中工作。\n\n```shell\nInternet Explorer 6+\nSafari\nFirefox\nChrome\n```\n\n## 支持的按键\n\nHotKeys 理解以下修饰符：`⇧`、`shift`、`option`、`⌥`、`alt`、`ctrl`、`control`、`command` 和 `⌘`。\n\n以下特殊按键可用于快捷键：backspace、tab、clear、enter、return、esc、escape、space、up、down、left、right、home、end、pageup、pagedown、del、delete、f1 到 f19、num_0 到 num_9、num_multiply、num_add、num_enter、num_subtract、num_decimal、num_divide。\n\n`⌘` Command() \n`⌃` Control \n`⌥` Option(alt) \n`⇧` Shift \n`⇪` Caps Lock(Capital) \n~~`fn` 不支持 fn~~ \n`↩︎` return/Enter space \n\n## 定义快捷键\n\n暴露了一个全局方法，当直接调用时定义快捷键。\n\n```ts\ndeclare interface HotkeysInterface extends HotkeysAPI {\n (key: string, method: KeyHandler): void;\n (key: string, scope: string, method: KeyHandler): void;\n (key: string, option: HotkeysOptions, method: KeyHandler): void;\n shift?: boolean;\n ctrl?: boolean;\n alt?: boolean;\n option?: boolean;\n control?: boolean;\n cmd?: boolean;\n command?: boolean;\n}\ndeclare interface HotkeysAPI {\n setScope: SetScope;\n getScope: GetScope;\n deleteScope: DeleteScope;\n getPressedKeyCodes: GetPressedKeyCodes;\n getPressedKeyString: GetPressedKeyString;\n getAllKeyCodes: GetAllKeyCodes;\n isPressed: IsPressed;\n filter: Filter;\n trigger: Trigger;\n unbind: Unbind;\n noConflict: NoConflict;\n keyMap: Record;\n modifier: Record;\n modifierMap: Record;\n}\n```\n\n```js\nhotkeys('f5', function(event, handler) {\n // 阻止 WINDOWS 系统下的默认刷新事件\n event.preventDefault();\n alert('你按下了 F5!');\n});\n\n// 返回 false 停止事件并阻止默认浏览器事件\n// Mac OS 系统将 `command + r` 定义为刷新快捷键\nhotkeys('ctrl+r, command+r', function() {\n alert('停止刷新!');\n return false;\n});\n\n// 单个按键\nhotkeys('a', function(event,handler){\n //event.srcElement: input\n //event.target: input\n if(event.target === \"input\"){\n alert('你按下了 a!')\n }\n alert('你按下了 a!')\n});\n\n// 组合键\nhotkeys('ctrl+a,ctrl+b,r,f', function (event, handler){\n switch (handler.key) {\n case 'ctrl+a': alert('你按下了 ctrl+a!');\n break;\n case 'ctrl+b': alert('你按下了 ctrl+b!');\n break;\n case 'r': alert('你按下了 r!');\n break;\n case 'f': alert('你按下了 f!');\n break;\n default: alert(event);\n }\n});\n\nhotkeys('ctrl+a+s', function() {\n alert('你按下了 ctrl+a+s!');\n});\n\n// 使用作用域\nhotkeys('*','wcj', function(event){\n console.log('做一些事情', event);\n});\n```\n\n#### option 选项\n\n- `scope`：设置快捷键生效的作用域\n- `element`：指定要绑定事件的 DOM 元素\n- `keyup`：是否在按键释放时触发快捷键\n- `keydown`：是否在按键按下时触发快捷键\n- `splitKey`：组合键的分隔符（默认为 `+`）\n- `capture`：是否在捕获阶段触发监听器（在事件冒泡之前）\n- `single`：只允许一个回调函数（自动解绑之前的）\n\n```js\nhotkeys('o, enter', {\n scope: 'wcj',\n element: document.getElementById('wrapper'),\n}, function() {\n console.log('做其他事情');\n});\n\nhotkeys('ctrl-+', { splitKey: '-' }, function(e) {\n console.log('你按下了 ctrl 和 +');\n});\n\nhotkeys('+', { splitKey: '-' }, function(e){\n console.log('你按下了 +');\n})\n```\n\n**keyup**\n\n**按键按下** 和 **按键释放** 都执行回调事件。\n\n```js\nhotkeys('ctrl+a,alt+a+s', {keyup: true}, function(event, handler) {\n if (event.type === 'keydown') {\n console.log('keydown:', event.type, handler, handler.key);\n }\n\n if (event.type === 'keyup') {\n console.log('keyup:', event.type, handler, handler.key);\n }\n});\n```\n\n## API 参考\n\n星号 \"*\"\n\n修饰键判断\n\n```js\nhotkeys('*', function() {\n if (hotkeys.shift) {\n console.log('按下了 shift!');\n }\n\n if (hotkeys.ctrl) {\n console.log('按下了 ctrl!');\n }\n\n if (hotkeys.alt) {\n console.log('按下了 alt!');\n }\n\n if (hotkeys.option) {\n console.log('按下了 option!');\n }\n\n if (hotkeys.control) {\n console.log('按下了 control!');\n }\n\n if (hotkeys.cmd) {\n console.log('按下了 cmd!');\n }\n\n if (hotkeys.command) {\n console.log('按下了 command!');\n }\n});\n```\n\n### setScope\n\n使用 `hotkeys.setScope` 方法来设置作用域。除了 'all' 之外，只能有一个活动作用域。默认情况下 'all' 总是活动的。\n\n```js\n// 定义带有作用域的快捷键\nhotkeys('ctrl+o, ctrl+alt+enter', 'issues', function() {\n console.log('做一些事情');\n});\nhotkeys('o, enter', 'files', function() {\n console.log('做其他事情');\n});\n\n// 设置作用域（只有 'all' 和 'issues' 快捷键会被处理）\nhotkeys.setScope('issues'); // 默认作用域是 'all'\n```\n\n### getScope\n\n使用 `hotkeys.getScope` 方法来获取作用域。\n\n```js\nhotkeys.getScope();\n```\n\n### deleteScope\n\n使用 `hotkeys.deleteScope` 方法来删除作用域。这也会移除与之关联的所有热键。\n\n```js\nhotkeys.deleteScope('issues');\n```\n如果需要在删除后设置新的作用域，可以使用第二个参数。\n\n```js\nhotkeys.deleteScope('issues', 'newScopeName');\n```\n\n### unbind\n\n与定义快捷键类似，它们可以使用 `hotkeys.unbind` 来解绑。\n\n```js\n// 解绑 'a' 处理器\nhotkeys.unbind('a');\n\n// 只为单个作用域解绑热键\n// 如果没有指定作用域，默认为当前作用域\n// （hotkeys.getScope()）\nhotkeys.unbind('o, enter', 'issues');\nhotkeys.unbind('o, enter', 'files');\n```\n\n通过函数解绑事件。\n\n```js\nfunction example() {\n hotkeys('a', example);\n hotkeys.unbind('a', example);\n\n hotkeys('a', 'issues', example);\n hotkeys.unbind('a', 'issues', example);\n}\n```\n\n解绑所有。\n\n```js\nhotkeys.unbind();\n```\n\n### isPressed\n\n例如，如果当前按下了 `M` 键，`hotkeys.isPressed(77)` 返回 true。\n\n```js\nhotkeys('a', function() {\n console.log(hotkeys.isPressed('a')); //=> true\n console.log(hotkeys.isPressed('A')); //=> true\n console.log(hotkeys.isPressed(65)); //=> true\n});\n```\n\n### trigger\n\n触发快捷键事件\n\n```js\nhotkeys.trigger('ctrl+o');\nhotkeys.trigger('ctrl+o', 'scope2');\n```\n\n### getPressedKeyCodes\n\n返回当前按下的键码数组。\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getPressedKeyCodes()); //=> [17, 65] 或 [70]\n})\n```\n\n### getPressedKeyString\n\n返回当前按下的键字符串数组。\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getPressedKeyString()); \n //=> ['⌘', '⌃', '⇧', 'A', 'F']\n})\n```\n\n### getAllKeyCodes\n\n获取所有注册码的列表。\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getAllKeyCodes());\n // [\n // { \n // scope: 'all', \n // shortcut: 'command+ctrl+shift+a', \n // mods: [91, 17, 16], \n // keys: [91, 17, 16, 65] \n // },\n // { scope: 'all', shortcut: 'f', mods: [], keys: [42] }\n // ]\n})\n```\n\n### filter\n\n默认情况下，`INPUT` `SELECT` `TEXTAREA` 元素不启用热键。`Hotkeys.filter` 返回 `true` 快捷键设置发挥作用，`false` 快捷键设置失败。\n\n```js\nhotkeys.filter = function(event){\n return true;\n}\n// 如何为编辑标签添加过滤器。\n//
\n// \"contentEditable\" 不支持的较旧浏览器会被丢弃\nhotkeys.filter = function(event) {\n var target = event.target || event.srcElement;\n var tagName = target.tagName;\n return !(\n target.isContentEditable ||\n tagName == 'INPUT' ||\n tagName == 'SELECT' ||\n tagName == 'TEXTAREA'\n );\n}\n\nhotkeys.filter = function(event){\n var tagName = (event.target || event.srcElement).tagName;\n hotkeys.setScope(\n /^(INPUT|TEXTAREA|SELECT)$/.test(tagName) ? 'input' : 'other'\n );\n return true;\n}\n```\n\n### noConflict\n\n放弃 HotKeys 对 `hotkeys` 变量的控制。\n\n```js\nvar k = hotkeys.noConflict();\nk('a', function() {\n console.log(\"做一些事情\")\n});\n\nhotkeys()\n// -->Uncaught TypeError: hotkeys is not a function(anonymous function)\n// @ VM2170:2InjectedScript._evaluateOn\n// @ VM2165:883InjectedScript._evaluateAndWrap\n// @ VM2165:816InjectedScript.evaluate @ VM2165:682\n```\n\n## 开发\n\n要开发，需要安装依赖，获取代码：\n\n```shell\n$ git https://github.com/jaywcjlove/hotkeys.git\n$ cd hotkeys # 进入目录\n$ npm install # 或者 yarn install\n```\n\n要开发，运行自重载构建：\n\n```shell\n$ npm run watch\n```\n\n运行文档网站环境。\n\n```shell\n$ npm run doc # 生成文档网页\n# 实时生成文档网页\n$ npm run start \n```\n\n要贡献，请 fork Hotkeys.js，添加您的补丁和测试（在 `test/` 文件夹中）并提交拉取请求。\n\n```shell\n$ npm run test\n$ npm run test:watch # 开发模式\n```\n\n## 贡献者\n\n一如既往，感谢我们出色的贡献者！\n\n\n \n\n\n使用 [action-contributors](https://github.com/jaywcjlove/github-action-contributors) 制作。\n\n特别感谢 [@dimensi](https://github.com/dimensi) 对版本 [4.0](https://github.com/jaywcjlove/hotkeys-js/issues/313) 的重构。\n\n## 许可证\n\n[MIT © Kenny Wong](./LICENSE)\n" }, { "path": "README.md", "content": "
\n Using my app is also a way to support me:\n
\n \"Scap:\n \"Screen\n \"Deskmark\"\n \"Keyzer\"\n \"Vidwall\n \"VidCrop\"\n \"Vidwall\"\n \"Mousio\n \"Mousio\"\n \"Musicer\"\n \"Audioer\"\n \"FileSentinel\"\n \"FocusCursor\"\n \"Videoer\"\n \"KeyClicker\"\n \"DayBar\"\n \"Iconed\"\n \"Menuist\"\n \"Quick\n \"Quick\n \"Web\n \"Copybook\n \"DevTutor\n \"RegexMate\"\n \"Time\n \"Iconize\n \"Textsound\n \"Create\n \"DevHub\"\n \"Resume\n \"Palette\n \"Symbol\n
\n
\n\n# Hotkeys\n\n[![Buy me a coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-ffdd00?logo=buy-me-a-coffee&logoColor=black)](https://jaywcjlove.github.io/#/sponsor)\n[![Follow On X](https://img.shields.io/badge/Follow%20on%20X-333333?logo=x&logoColor=white)](https://x.com/jaywcjlove)\n[![](https://img.shields.io/npm/dm/hotkeys-js?logo=npm&label=)](https://www.npmjs.com/package/hotkeys-js)\n[![](https://img.shields.io/github/stars/jaywcjlove/hotkeys-js.svg)](https://github.com/jaywcjlove/hotkeys/stargazers)\n[![GitHub Actions CI](https://github.com/jaywcjlove/hotkeys-js/actions/workflows/ci.yml/badge.svg)](https://github.com/jaywcjlove/hotkeys-js/actions/workflows/ci.yml)\n[![Coverage Status](https://jaywcjlove.github.io/hotkeys-js/coverage.svg)](https://jaywcjlove.github.io/hotkeys-js/lcov-report/index.html)\n[![Chinese](https://jaywcjlove.github.io/sb/lang/chinese.svg)](https://wangchujiang.com/hotkeys-js/?lang=zh)\n[![jaywcjlove/hotkeys-js](https://jaywcjlove.github.io/sb/ico/gitee.svg)](https://gitee.com/jaywcjlove/hotkeys)\n\nHotKeys.js is an input capture library with some very special features, it is easy to pick up and use, has a reasonable footprint ([~8kB](https://bundlephobia.com/result?p=hotkeys-js)) (gzipped: **`3.8kB`**), and has no dependencies. It should not interfere with any JavaScript libraries or frameworks. Official document [demo preview](https://jaywcjlove.github.io/hotkeys-js), [compatibility test](https://jaywcjlove.github.io/hotkeys-js/dist/compatibility-test.html). [More examples](https://github.com/jaywcjlove/hotkeys-js/issues?q=label%3ADemo+).\n\n```bash\n╭┈┈╮ ╭┈┈╮ ╭┈┈╮\n┆ ├┈┈..┈┈┈┈┈.┆ └┈╮┆ ├┈┈..┈┈┈┈┈..┈┈.┈┈..┈┈┈┈┈.\n┆ ┆┆ □ ┆┆ ┈┤┆ < ┆ -__┘┆ ┆ ┆┆__ ┈┈┤\n╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈┈╯╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈ ┆╰┈┈┈┈┈╯\n ╰┈┈┈┈┈╯\n```\n\n## Usage\n\nYou will need `Node.js` installed on your system.\n\n```bash\nnpm install hotkeys-js --save\n```\n\n```js\nimport hotkeys from 'hotkeys-js';\n\nhotkeys('f5', function(event, handler){\n // Prevent the default refresh event under WINDOWS system\n event.preventDefault()\n alert('you pressed F5!')\n});\n```\n\n### Browser Usage\n\nOr manually download and link **hotkeys.js** in your HTML. The library provides different formats for different use cases:\n\n**CDN Links:** [UNPKG](https://unpkg.com/hotkeys-js/dist/) | [jsDelivr](https://cdn.jsdelivr.net/npm/hotkeys-js/) | [Githack](https://raw.githack.com/jaywcjlove/hotkeys/master/dist/) | [Statically](https://cdn.statically.io/gh/jaywcjlove/hotkeys/master/dist/)\n\n**Available Formats:**\n\n**IIFE (Immediately Invoked Function Expression) - Recommended for direct browser usage:**\n\n```html\n\n\n```\n\n**UMD (Universal Module Definition) - For CommonJS/AMD environments:**\n\n```html\n\n```\n\n**ES Module - For modern browsers with module support:**\n\n```html\n\n```\n\n### Used in React\n\n[react-hotkeys](https://github.com/jaywcjlove/react-hotkeys) is the React component that listen to keydown and keyup keyboard events, defining and dispatching keyboard shortcuts. Detailed use method please see its documentation [react-hotkeys](https://github.com/jaywcjlove/react-hotkeys).\n\n[react-hotkeys-hook](https://github.com/JohannesKlauss/react-hotkeys-hook) - React hook for using keyboard shortcuts in components. Make sure that you have at least version 16.8 of react and react-dom installed, or otherwise hooks won't work for you.\n\n## Browser Support\n\nHotkeys.js has been tested and should work in.\n\n```shell\nInternet Explorer 6+\nSafari\nFirefox\nChrome\n```\n\n## Supported Keys\n\nHotKeys understands the following modifiers: `⇧`, `shift`, `option`, `⌥`, `alt`, `ctrl`, `control`, `command`, and `⌘`.\n\nThe following special keys can be used for shortcuts: backspace, tab, clear, enter, return, esc, escape, space, up, down, left, right, home, end, pageup, pagedown, del, delete, f1 through f19, num_0 through num_9, num_multiply, num_add, num_enter, num_subtract, num_decimal, num_divide.\n\n`⌘` Command() \n`⌃` Control \n`⌥` Option(alt) \n`⇧` Shift \n`⇪` Caps Lock(Capital) \n~~`fn` Does not support fn~~ \n`↩︎` return/Enter space \n\n## Defining Shortcuts\n\nOne global method is exposed, key which defines shortcuts when called directly.\n\n```ts\ndeclare interface HotkeysInterface extends HotkeysAPI {\n (key: string, method: KeyHandler): void;\n (key: string, scope: string, method: KeyHandler): void;\n (key: string, option: HotkeysOptions, method: KeyHandler): void;\n shift?: boolean;\n ctrl?: boolean;\n alt?: boolean;\n option?: boolean;\n control?: boolean;\n cmd?: boolean;\n command?: boolean;\n}\ndeclare interface HotkeysAPI {\n setScope: SetScope;\n getScope: GetScope;\n deleteScope: DeleteScope;\n getPressedKeyCodes: GetPressedKeyCodes;\n getPressedKeyString: GetPressedKeyString;\n getAllKeyCodes: GetAllKeyCodes;\n isPressed: IsPressed;\n filter: Filter;\n trigger: Trigger;\n unbind: Unbind;\n noConflict: NoConflict;\n keyMap: Record;\n modifier: Record;\n modifierMap: Record;\n}\n```\n\n\n```js\nhotkeys('f5', function(event, handler) {\n // Prevent the default refresh event under WINDOWS system\n event.preventDefault();\n alert('you pressed F5!');\n});\n\n// Returning false stops the event and prevents default browser events\n// Mac OS system defines `command + r` as a refresh shortcut\nhotkeys('ctrl+r, command+r', function() {\n alert('stopped reload!');\n return false;\n});\n\n// Single key\nhotkeys('a', function(event,handler){\n //event.srcElement: input\n //event.target: input\n if(event.target === \"input\"){\n alert('you pressed a!')\n }\n alert('you pressed a!')\n});\n\n// Key Combination\nhotkeys('ctrl+a,ctrl+b,r,f', function (event, handler){\n switch (handler.key) {\n case 'ctrl+a': alert('you pressed ctrl+a!');\n break;\n case 'ctrl+b': alert('you pressed ctrl+b!');\n break;\n case 'r': alert('you pressed r!');\n break;\n case 'f': alert('you pressed f!');\n break;\n default: alert(event);\n }\n});\n\nhotkeys('ctrl+a+s', function() {\n alert('you pressed ctrl+a+s!');\n});\n\n// Using a scope\nhotkeys('*','wcj', function(event){\n console.log('do something', event);\n});\n```\n\n#### option\n\n- `scope`: Sets the scope in which the shortcut key is active\n- `element`: Specifies the DOM element to bind the event to\n- `keyup`: Whether to trigger the shortcut on key release\n- `keydown`: Whether to trigger the shortcut on key press\n- `splitKey`: Delimiter for key combinations (default is `+`)\n- `capture`: Whether to trigger the listener during the capture phase (before the event bubbles down)\n- `single`: Allows only one callback function (automatically unbinds previous one)\n\n```js\nhotkeys('o, enter', {\n scope: 'wcj',\n element: document.getElementById('wrapper'),\n}, function() {\n console.log('do something else');\n});\n\nhotkeys('ctrl-+', { splitKey: '-' }, function(e) {\n console.log('you pressed ctrl and +');\n});\n\nhotkeys('+', { splitKey: '-' }, function(e){\n console.log('you pressed +');\n})\n```\n\n**keyup**\n\n**key down** and **key up** both perform callback events.\n\n```js\nhotkeys('ctrl+a,alt+a+s', {keyup: true}, function(event, handler) {\n if (event.type === 'keydown') {\n console.log('keydown:', event.type, handler, handler.key);\n }\n\n if (event.type === 'keyup') {\n console.log('keyup:', event.type, handler, handler.key);\n }\n});\n```\n\n## API REFERENCE\n\nAsterisk \"*\"\n\nModifier key judgments\n\n```js\nhotkeys('*', function() {\n if (hotkeys.shift) {\n console.log('shift is pressed!');\n }\n\n if (hotkeys.ctrl) {\n console.log('ctrl is pressed!');\n }\n\n if (hotkeys.alt) {\n console.log('alt is pressed!');\n }\n\n if (hotkeys.option) {\n console.log('option is pressed!');\n }\n\n if (hotkeys.control) {\n console.log('control is pressed!');\n }\n\n if (hotkeys.cmd) {\n console.log('cmd is pressed!');\n }\n\n if (hotkeys.command) {\n console.log('command is pressed!');\n }\n});\n```\n\n### setScope\n\nUse the `hotkeys.setScope` method to set scope. There can only be one active scope besides 'all'. By default 'all' is always active.\n\n```js\n// Define shortcuts with a scope\nhotkeys('ctrl+o, ctrl+alt+enter', 'issues', function() {\n console.log('do something');\n});\nhotkeys('o, enter', 'files', function() {\n console.log('do something else');\n});\n\n// Set the scope (only 'all' and 'issues' shortcuts will be honored)\nhotkeys.setScope('issues'); // default scope is 'all'\n```\n\n### getScope\n\nUse the `hotkeys.getScope` method to get scope.\n\n```js\nhotkeys.getScope();\n```\n\n### deleteScope\n\nUse the `hotkeys.deleteScope` method to delete a scope. This will also remove all associated hotkeys with it.\n\n```js\nhotkeys.deleteScope('issues');\n```\nYou can use second argument, if need set new scope after deleting.\n\n```js\nhotkeys.deleteScope('issues', 'newScopeName');\n```\n\n### unbind\n\nSimilar to defining shortcuts, they can be unbound using `hotkeys.unbind`.\n\n```js\n// unbind 'a' handler\nhotkeys.unbind('a');\n\n// Unbind a hotkeys only for a single scope\n// If no scope is specified it defaults to the current \n// scope (hotkeys.getScope())\nhotkeys.unbind('o, enter', 'issues');\nhotkeys.unbind('o, enter', 'files');\n```\n\nUnbind events through functions.\n\n```js\nfunction example() {\n hotkeys('a', example);\n hotkeys.unbind('a', example);\n\n hotkeys('a', 'issues', example);\n hotkeys.unbind('a', 'issues', example);\n}\n```\n\nTo unbind everything.\n\n```js\nhotkeys.unbind();\n```\n\n### isPressed\n\nFor example, `hotkeys.isPressed(77)` is true if the `M` key is currently pressed.\n\n```js\nhotkeys('a', function() {\n console.log(hotkeys.isPressed('a')); //=> true\n console.log(hotkeys.isPressed('A')); //=> true\n console.log(hotkeys.isPressed(65)); //=> true\n});\n```\n\n### trigger\n\ntrigger shortcut key event\n\n```js\nhotkeys.trigger('ctrl+o');\nhotkeys.trigger('ctrl+o', 'scope2');\n```\n\n### getPressedKeyCodes\n\nReturns an array of key codes currently pressed.\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getPressedKeyCodes()); //=> [17, 65] or [70]\n})\n```\n\n### getPressedKeyString\n\nReturns an array of key codes currently pressed.\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getPressedKeyString()); \n //=> ['⌘', '⌃', '⇧', 'A', 'F']\n})\n```\n\n### getAllKeyCodes\n\nGet a list of all registration codes.\n\n```js\nhotkeys('command+ctrl+shift+a,f', function() {\n console.log(hotkeys.getAllKeyCodes());\n // [\n // { \n // scope: 'all', \n // shortcut: 'command+ctrl+shift+a', \n // mods: [91, 17, 16], \n // keys: [91, 17, 16, 65] \n // },\n // { scope: 'all', shortcut: 'f', mods: [], keys: [42] }\n // ]\n})\n```\n\n### filter\n\nBy default hotkeys are not enabled for `INPUT` `SELECT` `TEXTAREA` elements. `Hotkeys.filter` to return to the `true` shortcut keys set to play a role, `false` shortcut keys set up failure.\n\n```js\nhotkeys.filter = function(event){\n return true;\n}\n// How to add the filter to edit labels. \n//
\n// \"contentEditable\" Older browsers that do not support drops\nhotkeys.filter = function(event) {\n var target = event.target || event.srcElement;\n var tagName = target.tagName;\n return !(\n target.isContentEditable || \n tagName == 'INPUT' || \n tagName == 'SELECT' || \n tagName == 'TEXTAREA'\n );\n}\n\nhotkeys.filter = function(event){\n var tagName = (event.target || event.srcElement).tagName;\n hotkeys.setScope(\n /^(INPUT|TEXTAREA|SELECT)$/.test(tagName) ? 'input' : 'other'\n );\n return true;\n}\n```\n\n### noConflict\n\nRelinquish HotKeys’s control of the `hotkeys` variable.\n\n```js\nvar k = hotkeys.noConflict();\nk('a', function() {\n console.log(\"do something\")\n});\n\nhotkeys()\n// -->Uncaught TypeError: hotkeys is not a function(anonymous function)\n// @ VM2170:2InjectedScript._evaluateOn\n// @ VM2165:883InjectedScript._evaluateAndWrap\n// @ VM2165:816InjectedScript.evaluate @ VM2165:682\n```\n\n## Development\n\nTo develop, Install dependencies, Get the code:\n\n```shell\n$ git https://github.com/jaywcjlove/hotkeys.git\n$ cd hotkeys # Into the directory\n$ npm install # or yarn install\n```\n\nTo develop, run the self-reloading build:\n\n```shell\n$ npm run watch\n```\n\nRun Document Website Environment.\n\n```shell\n# Generate documentation website\n$ npm run doc \n# Live-generate documentation website\n$ npm run start \n```\n\nTo contribute, please fork Hotkeys.js, add your patch and tests for it (in the `test/` folder) and submit a pull request.\n\n```shell\n$ npm run test\n$ npm run test:watch # Development model\n```\n\n## Contributors\n\nAs always, thanks to our amazing contributors!\n\n\n \n\n\nMade with [action-contributors](https://github.com/jaywcjlove/github-action-contributors).\n\nSpecial thanks to [@dimensi](https://github.com/dimensi) for the refactoring of version [4.0](https://github.com/jaywcjlove/hotkeys-js/issues/313).\n\n## License\n\n[MIT © Kenny Wong](./LICENSE)\n" }, { "path": "dist/compatibility-test.html", "content": "\n\n\n \n \n Hotkeys-js Comprehensive Compatibility Test\n \n\n\n
\n

🔥 Hotkeys-js Comprehensive Compatibility Test Suite

\n

Test the compatibility of hotkeys-js library across different module formats and environments

\n
\n
\n
0
\n
Total Tests
\n
\n
\n
0
\n
Passed Tests
\n
\n
\n
0
\n
Failed Tests
\n
\n
\n
\n\n \n
\n

📦 Module Format Compatibility Tests

\n

Test loading and basic functionality of hotkeys-js library in different build formats

\n \n
\n
\n

IIFE Format (hotkeys-js.min.js)

\n

Immediately Invoked Function Expression, suitable for direct browser use

\n

Press F1 to test

\n
Loading...
\n
\n \n
\n

UMD Format (hotkeys-js.umd.cjs)

\n

Universal Module Definition, compatible with CommonJS, AMD and global variables

\n

Press F2 to test

\n
Loading...
\n
\n \n
\n

ES Module Format (hotkeys-js.js)

\n

Modern ES6 module format, requires server environment

\n

Press F3 to test

\n
Loading...
\n
\n
\n
\n\n \n
\n

🎯 Hotkey Functionality Tests

\n

Test various hotkey combinations and functions

\n \n
\n
\n Ctrl + K
\n Basic hotkey test\n
\n
\n Alt + S
\n Modifier key combination test\n
\n
\n Ctrl + Shift + T
\n Multiple modifier keys test\n
\n
\n Esc
\n Single key test\n
\n
\n Space
\n Space key test\n
\n
\n Enter
\n Enter key test\n
\n
\n \n
\n
\n\n \n
\n

🔧 API Method Tests

\n

Test various API methods provided by hotkeys-js

\n \n
\n \n \n \n \n
\n \n
\n
\n\n \n
\n

📋 Module Loading Details

\n
\n
\n\n \n
\n

📝 Usage Examples

\n \n

ESM Environment (Recommended)

\n 
import hotkeys from 'hotkeys-js';\n\nhotkeys('ctrl+k', function(event, handler) {\n  event.preventDefault();\n  console.log('Hotkey pressed!');\n});
\n \n

CommonJS Environment

\n 
const hotkeys = require('hotkeys-js');\n// or\nconst hotkeys = require('hotkeys-js').default;\n\nhotkeys('ctrl+k', function(event, handler) {\n  event.preventDefault();\n  console.log('Hotkey pressed!');\n});
\n \n

Browser Global Environment

\n 
<script src=\"hotkeys-js/dist/hotkeys-js.min.js\"></script>\n<script>\n  hotkeys('ctrl+k', function(event, handler) {\n    event.preventDefault();\n    console.log('Hotkey pressed!');\n  });\n</script>
\n
\n\n \n \n \n \n \n \n \n \n\n \n\n" }, { "path": "dist/hotkeys-js.js", "content": "/*!\n * hotkeys-js v4.0.2\n * A simple micro-library for defining and dispatching keyboard shortcuts. It has no dependencies.\n * \n * @author kenny wong \n * @license MIT\n * @homepage https://jaywcjlove.github.io/hotkeys-js\n */\nconst isff = typeof navigator !== \"undefined\" ? navigator.userAgent.toLowerCase().indexOf(\"firefox\") > 0 : false;\nfunction addEvent(object, event, method, useCapture) {\n if (object.addEventListener) {\n object.addEventListener(event, method, useCapture);\n } else if (object.attachEvent) {\n object.attachEvent(`on${event}`, method);\n }\n}\nfunction removeEvent(object, event, method, useCapture) {\n if (!object) return;\n if (object.removeEventListener) {\n object.removeEventListener(event, method, useCapture);\n } else if (object.detachEvent) {\n object.detachEvent(`on${event}`, method);\n }\n}\nfunction getMods(modifier, key) {\n const modsKeys = key.slice(0, key.length - 1);\n const modsCodes = [];\n for (let i = 0; i < modsKeys.length; i++) {\n modsCodes.push(modifier[modsKeys[i].toLowerCase()]);\n }\n return modsCodes;\n}\nfunction getKeys(key) {\n if (typeof key !== \"string\") key = \"\";\n key = key.replace(/\\s/g, \"\");\n const keys = key.split(\",\");\n let index = keys.lastIndexOf(\"\");\n for (; index >= 0; ) {\n keys[index - 1] += \",\";\n keys.splice(index, 1);\n index = keys.lastIndexOf(\"\");\n }\n return keys;\n}\nfunction compareArray(a1, a2) {\n const arr1 = a1.length >= a2.length ? a1 : a2;\n const arr2 = a1.length >= a2.length ? a2 : a1;\n let isIndex = true;\n for (let i = 0; i < arr1.length; i++) {\n if (arr2.indexOf(arr1[i]) === -1) isIndex = false;\n }\n return isIndex;\n}\nfunction getLayoutIndependentKeyCode(event) {\n let key = event.keyCode || event.which || event.charCode;\n if (event.code && /^Key[A-Z]$/.test(event.code)) {\n key = event.code.charCodeAt(3);\n }\n return key;\n}\nconst _keyMap = {\n backspace: 8,\n \"⌫\": 8,\n tab: 9,\n clear: 12,\n enter: 13,\n \"↩\": 13,\n return: 13,\n esc: 27,\n escape: 27,\n space: 32,\n left: 37,\n up: 38,\n right: 39,\n down: 40,\n /// https://w3c.github.io/uievents/#events-keyboard-key-location\n arrowup: 38,\n arrowdown: 40,\n arrowleft: 37,\n arrowright: 39,\n del: 46,\n delete: 46,\n ins: 45,\n insert: 45,\n home: 36,\n end: 35,\n pageup: 33,\n pagedown: 34,\n capslock: 20,\n num_0: 96,\n num_1: 97,\n num_2: 98,\n num_3: 99,\n num_4: 100,\n num_5: 101,\n num_6: 102,\n num_7: 103,\n num_8: 104,\n num_9: 105,\n num_multiply: 106,\n num_add: 107,\n num_enter: 108,\n num_subtract: 109,\n num_decimal: 110,\n num_divide: 111,\n \"⇪\": 20,\n \",\": 188,\n \".\": 190,\n \"/\": 191,\n \"`\": 192,\n \"-\": isff ? 173 : 189,\n \"=\": isff ? 61 : 187,\n \";\": isff ? 59 : 186,\n \"'\": 222,\n \"{\": 219,\n \"}\": 221,\n \"[\": 219,\n \"]\": 221,\n \"\\\\\": 220\n};\nconst _modifier = {\n // shiftKey\n \"⇧\": 16,\n shift: 16,\n // altKey\n \"⌥\": 18,\n alt: 18,\n option: 18,\n // ctrlKey\n \"⌃\": 17,\n ctrl: 17,\n control: 17,\n // metaKey\n \"⌘\": 91,\n cmd: 91,\n meta: 91,\n command: 91\n};\nconst modifierMap = {\n 16: \"shiftKey\",\n 18: \"altKey\",\n 17: \"ctrlKey\",\n 91: \"metaKey\",\n shiftKey: 16,\n ctrlKey: 17,\n altKey: 18,\n metaKey: 91\n};\nconst _mods = {\n 16: false,\n 18: false,\n 17: false,\n 91: false\n};\nconst _handlers = {};\nfor (let k = 1; k < 20; k++) {\n _keyMap[`f${k}`] = 111 + k;\n}\nlet _downKeys = [];\nlet winListendFocus = null;\nlet winListendFullscreen = null;\nlet _scope = \"all\";\nconst elementEventMap = /* @__PURE__ */ new Map();\nconst code = (x) => _keyMap[x.toLowerCase()] || _modifier[x.toLowerCase()] || x.toUpperCase().charCodeAt(0);\nconst getKey = (x) => Object.keys(_keyMap).find((k) => _keyMap[k] === x);\nconst getModifier = (x) => Object.keys(_modifier).find((k) => _modifier[k] === x);\nconst setScope = (scope) => {\n _scope = scope || \"all\";\n};\nconst getScope = () => {\n return _scope || \"all\";\n};\nconst getPressedKeyCodes = () => {\n return _downKeys.slice(0);\n};\nconst getPressedKeyString = () => {\n return _downKeys.map(\n (c) => getKey(c) || getModifier(c) || String.fromCharCode(c)\n );\n};\nconst getAllKeyCodes = () => {\n const result = [];\n Object.keys(_handlers).forEach((k) => {\n _handlers[k].forEach(({ key, scope, mods, shortcut }) => {\n result.push({\n scope,\n shortcut,\n mods,\n keys: key.split(\"+\").map((v) => code(v))\n });\n });\n });\n return result;\n};\nconst filter = (event) => {\n const target = event.target || event.srcElement;\n const { tagName } = target;\n let flag = true;\n const isInput = tagName === \"INPUT\" && ![\n \"checkbox\",\n \"radio\",\n \"range\",\n \"button\",\n \"file\",\n \"reset\",\n \"submit\",\n \"color\"\n ].includes(target.type);\n if (target.isContentEditable || (isInput || tagName === \"TEXTAREA\" || tagName === \"SELECT\") && !target.readOnly) {\n flag = false;\n }\n return flag;\n};\nconst isPressed = (keyCode) => {\n if (typeof keyCode === \"string\") {\n keyCode = code(keyCode);\n }\n return _downKeys.indexOf(keyCode) !== -1;\n};\nconst deleteScope = (scope, newScope) => {\n let handlers;\n let i;\n if (!scope) scope = getScope();\n for (const key in _handlers) {\n if (Object.prototype.hasOwnProperty.call(_handlers, key)) {\n handlers = _handlers[key];\n for (i = 0; i < handlers.length; ) {\n if (handlers[i].scope === scope) {\n const deleteItems = handlers.splice(i, 1);\n deleteItems.forEach(({ element }) => removeKeyEvent(element));\n } else {\n i++;\n }\n }\n }\n }\n if (getScope() === scope) setScope(newScope || \"all\");\n};\nfunction clearModifier(event) {\n let key = getLayoutIndependentKeyCode(event);\n if (event.key && event.key.toLowerCase() === \"capslock\") {\n key = code(event.key);\n }\n const i = _downKeys.indexOf(key);\n if (i >= 0) {\n _downKeys.splice(i, 1);\n }\n if (event.key && event.key.toLowerCase() === \"meta\") {\n _downKeys.splice(0, _downKeys.length);\n }\n if (key === 93 || key === 224) key = 91;\n if (key in _mods) {\n _mods[key] = false;\n for (const k in _modifier)\n if (_modifier[k] === key) hotkeys[k] = false;\n }\n}\nconst unbind = (keysInfo, ...args) => {\n if (typeof keysInfo === \"undefined\") {\n Object.keys(_handlers).forEach((key) => {\n if (Array.isArray(_handlers[key])) {\n _handlers[key].forEach((info) => eachUnbind(info));\n }\n delete _handlers[key];\n });\n removeKeyEvent(null);\n } else if (Array.isArray(keysInfo)) {\n keysInfo.forEach((info) => {\n if (info.key) eachUnbind(info);\n });\n } else if (typeof keysInfo === \"object\") {\n if (keysInfo.key) eachUnbind(keysInfo);\n } else if (typeof keysInfo === \"string\") {\n let [scope, method] = args;\n if (typeof scope === \"function\") {\n method = scope;\n scope = \"\";\n }\n eachUnbind({\n key: keysInfo,\n scope,\n method,\n splitKey: \"+\"\n });\n }\n};\nconst eachUnbind = ({\n key,\n scope,\n method,\n splitKey = \"+\"\n}) => {\n const multipleKeys = getKeys(key);\n multipleKeys.forEach((originKey) => {\n const unbindKeys = originKey.split(splitKey);\n const len = unbindKeys.length;\n const lastKey = unbindKeys[len - 1];\n const keyCode = lastKey === \"*\" ? \"*\" : code(lastKey);\n if (!_handlers[keyCode]) return;\n if (!scope) scope = getScope();\n const mods = len > 1 ? getMods(_modifier, unbindKeys) : [];\n const unbindElements = [];\n _handlers[keyCode] = _handlers[keyCode].filter((record) => {\n const isMatchingMethod = method ? record.method === method : true;\n const isUnbind = isMatchingMethod && record.scope === scope && compareArray(record.mods, mods);\n if (isUnbind) unbindElements.push(record.element);\n return !isUnbind;\n });\n unbindElements.forEach((element) => removeKeyEvent(element));\n });\n};\nfunction eventHandler(event, handler, scope, element) {\n if (handler.element !== element) {\n return;\n }\n let modifiersMatch;\n if (handler.scope === scope || handler.scope === \"all\") {\n modifiersMatch = handler.mods.length > 0;\n for (const y in _mods) {\n if (Object.prototype.hasOwnProperty.call(_mods, y)) {\n if (!_mods[y] && handler.mods.indexOf(+y) > -1 || _mods[y] && handler.mods.indexOf(+y) === -1) {\n modifiersMatch = false;\n }\n }\n }\n if (handler.mods.length === 0 && !_mods[16] && !_mods[18] && !_mods[17] && !_mods[91] || modifiersMatch || handler.shortcut === \"*\") {\n handler.keys = [];\n handler.keys = handler.keys.concat(_downKeys);\n if (handler.method(event, handler) === false) {\n if (event.preventDefault) event.preventDefault();\n else event.returnValue = false;\n if (event.stopPropagation) event.stopPropagation();\n if (event.cancelBubble) event.cancelBubble = true;\n }\n }\n }\n}\nfunction dispatch(event, element) {\n const asterisk = _handlers[\"*\"];\n let key = getLayoutIndependentKeyCode(event);\n if (event.key && event.key.toLowerCase() === \"capslock\") {\n return;\n }\n const filterFn = hotkeys.filter || filter;\n if (!filterFn.call(this, event)) return;\n if (key === 93 || key === 224) key = 91;\n if (_downKeys.indexOf(key) === -1 && key !== 229) _downKeys.push(key);\n [\"metaKey\", \"ctrlKey\", \"altKey\", \"shiftKey\"].forEach((keyName) => {\n const keyNum = modifierMap[keyName];\n if (event[keyName] && _downKeys.indexOf(keyNum) === -1) {\n _downKeys.push(keyNum);\n } else if (!event[keyName] && _downKeys.indexOf(keyNum) > -1) {\n _downKeys.splice(_downKeys.indexOf(keyNum), 1);\n } else if (keyName === \"metaKey\" && event[keyName]) {\n _downKeys = _downKeys.filter((k) => k in modifierMap || k === key);\n }\n });\n if (key in _mods) {\n _mods[key] = true;\n for (const k in _modifier) {\n if (Object.prototype.hasOwnProperty.call(_modifier, k)) {\n const eventKey = modifierMap[_modifier[k]];\n hotkeys[k] = event[eventKey];\n }\n }\n if (!asterisk) return;\n }\n for (const e in _mods) {\n if (Object.prototype.hasOwnProperty.call(_mods, e)) {\n _mods[e] = event[modifierMap[e]];\n }\n }\n if (event.getModifierState && !(event.altKey && !event.ctrlKey) && event.getModifierState(\"AltGraph\")) {\n if (_downKeys.indexOf(17) === -1) {\n _downKeys.push(17);\n }\n if (_downKeys.indexOf(18) === -1) {\n _downKeys.push(18);\n }\n _mods[17] = true;\n _mods[18] = true;\n }\n const scope = getScope();\n if (asterisk) {\n for (let i = 0; i < asterisk.length; i++) {\n if (asterisk[i].scope === scope && (event.type === \"keydown\" && asterisk[i].keydown || event.type === \"keyup\" && asterisk[i].keyup)) {\n eventHandler(event, asterisk[i], scope, element);\n }\n }\n }\n if (!(key in _handlers)) return;\n const handlerKey = _handlers[key];\n const keyLen = handlerKey.length;\n for (let i = 0; i < keyLen; i++) {\n if (event.type === \"keydown\" && handlerKey[i].keydown || event.type === \"keyup\" && handlerKey[i].keyup) {\n if (handlerKey[i].key) {\n const record = handlerKey[i];\n const { splitKey } = record;\n const keyShortcut = record.key.split(splitKey);\n const _downKeysCurrent = [];\n for (let a = 0; a < keyShortcut.length; a++) {\n _downKeysCurrent.push(code(keyShortcut[a]));\n }\n if (_downKeysCurrent.sort().join(\"\") === _downKeys.sort().join(\"\")) {\n eventHandler(event, record, scope, element);\n }\n }\n }\n }\n}\nconst hotkeys = function hotkeys2(key, option, method) {\n _downKeys = [];\n const keys = getKeys(key);\n let mods = [];\n let scope = \"all\";\n let element = document;\n let i = 0;\n let keyup = false;\n let keydown = true;\n let splitKey = \"+\";\n let capture = false;\n let single = false;\n if (method === void 0 && typeof option === \"function\") {\n method = option;\n }\n if (Object.prototype.toString.call(option) === \"[object Object]\") {\n const opts = option;\n if (opts.scope) scope = opts.scope;\n if (opts.element) element = opts.element;\n if (opts.keyup) keyup = opts.keyup;\n if (opts.keydown !== void 0) keydown = opts.keydown;\n if (opts.capture !== void 0) capture = opts.capture;\n if (typeof opts.splitKey === \"string\") splitKey = opts.splitKey;\n if (opts.single === true) single = true;\n }\n if (typeof option === \"string\") scope = option;\n if (single) unbind(key, scope);\n for (; i < keys.length; i++) {\n const currentKey = keys[i].split(splitKey);\n mods = [];\n if (currentKey.length > 1) mods = getMods(_modifier, currentKey);\n let finalKey = currentKey[currentKey.length - 1];\n finalKey = finalKey === \"*\" ? \"*\" : code(finalKey);\n if (!(finalKey in _handlers)) _handlers[finalKey] = [];\n _handlers[finalKey].push({\n keyup,\n keydown,\n scope,\n mods,\n shortcut: keys[i],\n method,\n key: keys[i],\n splitKey,\n element\n });\n }\n if (typeof element !== \"undefined\" && typeof window !== \"undefined\") {\n if (!elementEventMap.has(element)) {\n const keydownListener = (event = window.event) => dispatch(event, element);\n const keyupListenr = (event = window.event) => {\n dispatch(event, element);\n clearModifier(event);\n };\n elementEventMap.set(element, { keydownListener, keyupListenr, capture });\n addEvent(element, \"keydown\", keydownListener, capture);\n addEvent(element, \"keyup\", keyupListenr, capture);\n }\n if (!winListendFocus) {\n const listener = () => {\n _downKeys = [];\n };\n winListendFocus = { listener, capture };\n addEvent(window, \"focus\", listener, capture);\n }\n if (!winListendFullscreen && typeof document !== \"undefined\") {\n const onFullscreenChange = () => {\n _downKeys = [];\n for (const k in _mods) _mods[k] = false;\n for (const k in _modifier) hotkeys2[k] = false;\n };\n const fullscreenListener = onFullscreenChange;\n const webkitListener = onFullscreenChange;\n document.addEventListener(\"fullscreenchange\", fullscreenListener);\n document.addEventListener(\"webkitfullscreenchange\", webkitListener);\n winListendFullscreen = { fullscreen: fullscreenListener, webkit: webkitListener };\n }\n }\n};\nfunction trigger(shortcut, scope = \"all\") {\n Object.keys(_handlers).forEach((key) => {\n const dataList = _handlers[key].filter(\n (item) => item.scope === scope && item.shortcut === shortcut\n );\n dataList.forEach((data) => {\n if (data && data.method) {\n data.method({}, data);\n }\n });\n });\n}\nfunction removeKeyEvent(element) {\n const values = Object.values(_handlers).flat();\n const findindex = values.findIndex(({ element: el }) => el === element);\n if (findindex < 0 && element) {\n const { keydownListener, keyupListenr, capture } = elementEventMap.get(element) || {};\n if (keydownListener && keyupListenr) {\n removeEvent(element, \"keyup\", keyupListenr, capture);\n removeEvent(element, \"keydown\", keydownListener, capture);\n elementEventMap.delete(element);\n }\n }\n if (values.length <= 0 || elementEventMap.size <= 0) {\n const eventKeys = Array.from(elementEventMap.keys());\n eventKeys.forEach((el) => {\n const { keydownListener, keyupListenr, capture } = elementEventMap.get(el) || {};\n if (keydownListener && keyupListenr) {\n removeEvent(el, \"keyup\", keyupListenr, capture);\n removeEvent(el, \"keydown\", keydownListener, capture);\n elementEventMap.delete(el);\n }\n });\n elementEventMap.clear();\n Object.keys(_handlers).forEach((key) => delete _handlers[key]);\n if (winListendFocus) {\n const { listener, capture } = winListendFocus;\n removeEvent(window, \"focus\", listener, capture);\n winListendFocus = null;\n }\n if (winListendFullscreen && typeof document !== \"undefined\") {\n document.removeEventListener(\"fullscreenchange\", winListendFullscreen.fullscreen);\n document.removeEventListener(\"webkitfullscreenchange\", winListendFullscreen.webkit);\n winListendFullscreen = null;\n }\n }\n}\nconst _api = {\n getPressedKeyString,\n setScope,\n getScope,\n deleteScope,\n getPressedKeyCodes,\n getAllKeyCodes,\n isPressed,\n filter,\n trigger,\n unbind,\n keyMap: _keyMap,\n modifier: _modifier,\n modifierMap\n};\nfor (const a in _api) {\n const key = a;\n if (Object.prototype.hasOwnProperty.call(_api, key)) {\n hotkeys[key] = _api[key];\n }\n}\nif (typeof window !== \"undefined\") {\n const _hotkeys = window.hotkeys;\n hotkeys.noConflict = (deep) => {\n if (deep && window.hotkeys === hotkeys) {\n window.hotkeys = _hotkeys;\n }\n return hotkeys;\n };\n window.hotkeys = hotkeys;\n}\nif (typeof module !== \"undefined\" && module.exports) {\n module.exports = hotkeys;\n module.exports.default = hotkeys;\n}\nexport {\n hotkeys as default\n};\n//# sourceMappingURL=hotkeys-js.js.map\n" }, { "path": "dist/hotkeys-js.umd.cjs", "content": "(function(global, factory) {\n typeof exports === \"object\" && typeof module !== \"undefined\" ? module.exports = factory() : typeof define === \"function\" && define.amd ? define(factory) : (global = typeof globalThis !== \"undefined\" ? globalThis : global || self, global.hotkeys = factory());\n})(this, function() {\n \"use strict\";/*!\n * hotkeys-js v4.0.2\n * A simple micro-library for defining and dispatching keyboard shortcuts. It has no dependencies.\n * \n * @author kenny wong \n * @license MIT\n * @homepage https://jaywcjlove.github.io/hotkeys-js\n */\n\n const isff = typeof navigator !== \"undefined\" ? navigator.userAgent.toLowerCase().indexOf(\"firefox\") > 0 : false;\n function addEvent(object, event, method, useCapture) {\n if (object.addEventListener) {\n object.addEventListener(event, method, useCapture);\n } else if (object.attachEvent) {\n object.attachEvent(`on${event}`, method);\n }\n }\n function removeEvent(object, event, method, useCapture) {\n if (!object) return;\n if (object.removeEventListener) {\n object.removeEventListener(event, method, useCapture);\n } else if (object.detachEvent) {\n object.detachEvent(`on${event}`, method);\n }\n }\n function getMods(modifier, key) {\n const modsKeys = key.slice(0, key.length - 1);\n const modsCodes = [];\n for (let i = 0; i < modsKeys.length; i++) {\n modsCodes.push(modifier[modsKeys[i].toLowerCase()]);\n }\n return modsCodes;\n }\n function getKeys(key) {\n if (typeof key !== \"string\") key = \"\";\n key = key.replace(/\\s/g, \"\");\n const keys = key.split(\",\");\n let index = keys.lastIndexOf(\"\");\n for (; index >= 0; ) {\n keys[index - 1] += \",\";\n keys.splice(index, 1);\n index = keys.lastIndexOf(\"\");\n }\n return keys;\n }\n function compareArray(a1, a2) {\n const arr1 = a1.length >= a2.length ? a1 : a2;\n const arr2 = a1.length >= a2.length ? a2 : a1;\n let isIndex = true;\n for (let i = 0; i < arr1.length; i++) {\n if (arr2.indexOf(arr1[i]) === -1) isIndex = false;\n }\n return isIndex;\n }\n function getLayoutIndependentKeyCode(event) {\n let key = event.keyCode || event.which || event.charCode;\n if (event.code && /^Key[A-Z]$/.test(event.code)) {\n key = event.code.charCodeAt(3);\n }\n return key;\n }\n const _keyMap = {\n backspace: 8,\n \"⌫\": 8,\n tab: 9,\n clear: 12,\n enter: 13,\n \"↩\": 13,\n return: 13,\n esc: 27,\n escape: 27,\n space: 32,\n left: 37,\n up: 38,\n right: 39,\n down: 40,\n /// https://w3c.github.io/uievents/#events-keyboard-key-location\n arrowup: 38,\n arrowdown: 40,\n arrowleft: 37,\n arrowright: 39,\n del: 46,\n delete: 46,\n ins: 45,\n insert: 45,\n home: 36,\n end: 35,\n pageup: 33,\n pagedown: 34,\n capslock: 20,\n num_0: 96,\n num_1: 97,\n num_2: 98,\n num_3: 99,\n num_4: 100,\n num_5: 101,\n num_6: 102,\n num_7: 103,\n num_8: 104,\n num_9: 105,\n num_multiply: 106,\n num_add: 107,\n num_enter: 108,\n num_subtract: 109,\n num_decimal: 110,\n num_divide: 111,\n \"⇪\": 20,\n \",\": 188,\n \".\": 190,\n \"/\": 191,\n \"`\": 192,\n \"-\": isff ? 173 : 189,\n \"=\": isff ? 61 : 187,\n \";\": isff ? 59 : 186,\n \"'\": 222,\n \"{\": 219,\n \"}\": 221,\n \"[\": 219,\n \"]\": 221,\n \"\\\\\": 220\n };\n const _modifier = {\n // shiftKey\n \"⇧\": 16,\n shift: 16,\n // altKey\n \"⌥\": 18,\n alt: 18,\n option: 18,\n // ctrlKey\n \"⌃\": 17,\n ctrl: 17,\n control: 17,\n // metaKey\n \"⌘\": 91,\n cmd: 91,\n meta: 91,\n command: 91\n };\n const modifierMap = {\n 16: \"shiftKey\",\n 18: \"altKey\",\n 17: \"ctrlKey\",\n 91: \"metaKey\",\n shiftKey: 16,\n ctrlKey: 17,\n altKey: 18,\n metaKey: 91\n };\n const _mods = {\n 16: false,\n 18: false,\n 17: false,\n 91: false\n };\n const _handlers = {};\n for (let k = 1; k < 20; k++) {\n _keyMap[`f${k}`] = 111 + k;\n }\n let _downKeys = [];\n let winListendFocus = null;\n let winListendFullscreen = null;\n let _scope = \"all\";\n const elementEventMap = /* @__PURE__ */ new Map();\n const code = (x) => _keyMap[x.toLowerCase()] || _modifier[x.toLowerCase()] || x.toUpperCase().charCodeAt(0);\n const getKey = (x) => Object.keys(_keyMap).find((k) => _keyMap[k] === x);\n const getModifier = (x) => Object.keys(_modifier).find((k) => _modifier[k] === x);\n const setScope = (scope) => {\n _scope = scope || \"all\";\n };\n const getScope = () => {\n return _scope || \"all\";\n };\n const getPressedKeyCodes = () => {\n return _downKeys.slice(0);\n };\n const getPressedKeyString = () => {\n return _downKeys.map(\n (c) => getKey(c) || getModifier(c) || String.fromCharCode(c)\n );\n };\n const getAllKeyCodes = () => {\n const result = [];\n Object.keys(_handlers).forEach((k) => {\n _handlers[k].forEach(({ key, scope, mods, shortcut }) => {\n result.push({\n scope,\n shortcut,\n mods,\n keys: key.split(\"+\").map((v) => code(v))\n });\n });\n });\n return result;\n };\n const filter = (event) => {\n const target = event.target || event.srcElement;\n const { tagName } = target;\n let flag = true;\n const isInput = tagName === \"INPUT\" && ![\n \"checkbox\",\n \"radio\",\n \"range\",\n \"button\",\n \"file\",\n \"reset\",\n \"submit\",\n \"color\"\n ].includes(target.type);\n if (target.isContentEditable || (isInput || tagName === \"TEXTAREA\" || tagName === \"SELECT\") && !target.readOnly) {\n flag = false;\n }\n return flag;\n };\n const isPressed = (keyCode) => {\n if (typeof keyCode === \"string\") {\n keyCode = code(keyCode);\n }\n return _downKeys.indexOf(keyCode) !== -1;\n };\n const deleteScope = (scope, newScope) => {\n let handlers;\n let i;\n if (!scope) scope = getScope();\n for (const key in _handlers) {\n if (Object.prototype.hasOwnProperty.call(_handlers, key)) {\n handlers = _handlers[key];\n for (i = 0; i < handlers.length; ) {\n if (handlers[i].scope === scope) {\n const deleteItems = handlers.splice(i, 1);\n deleteItems.forEach(({ element }) => removeKeyEvent(element));\n } else {\n i++;\n }\n }\n }\n }\n if (getScope() === scope) setScope(newScope || \"all\");\n };\n function clearModifier(event) {\n let key = getLayoutIndependentKeyCode(event);\n if (event.key && event.key.toLowerCase() === \"capslock\") {\n key = code(event.key);\n }\n const i = _downKeys.indexOf(key);\n if (i >= 0) {\n _downKeys.splice(i, 1);\n }\n if (event.key && event.key.toLowerCase() === \"meta\") {\n _downKeys.splice(0, _downKeys.length);\n }\n if (key === 93 || key === 224) key = 91;\n if (key in _mods) {\n _mods[key] = false;\n for (const k in _modifier)\n if (_modifier[k] === key) hotkeys2[k] = false;\n }\n }\n const unbind = (keysInfo, ...args) => {\n if (typeof keysInfo === \"undefined\") {\n Object.keys(_handlers).forEach((key) => {\n if (Array.isArray(_handlers[key])) {\n _handlers[key].forEach((info) => eachUnbind(info));\n }\n delete _handlers[key];\n });\n removeKeyEvent(null);\n } else if (Array.isArray(keysInfo)) {\n keysInfo.forEach((info) => {\n if (info.key) eachUnbind(info);\n });\n } else if (typeof keysInfo === \"object\") {\n if (keysInfo.key) eachUnbind(keysInfo);\n } else if (typeof keysInfo === \"string\") {\n let [scope, method] = args;\n if (typeof scope === \"function\") {\n method = scope;\n scope = \"\";\n }\n eachUnbind({\n key: keysInfo,\n scope,\n method,\n splitKey: \"+\"\n });\n }\n };\n const eachUnbind = ({\n key,\n scope,\n method,\n splitKey = \"+\"\n }) => {\n const multipleKeys = getKeys(key);\n multipleKeys.forEach((originKey) => {\n const unbindKeys = originKey.split(splitKey);\n const len = unbindKeys.length;\n const lastKey = unbindKeys[len - 1];\n const keyCode = lastKey === \"*\" ? \"*\" : code(lastKey);\n if (!_handlers[keyCode]) return;\n if (!scope) scope = getScope();\n const mods = len > 1 ? getMods(_modifier, unbindKeys) : [];\n const unbindElements = [];\n _handlers[keyCode] = _handlers[keyCode].filter((record) => {\n const isMatchingMethod = method ? record.method === method : true;\n const isUnbind = isMatchingMethod && record.scope === scope && compareArray(record.mods, mods);\n if (isUnbind) unbindElements.push(record.element);\n return !isUnbind;\n });\n unbindElements.forEach((element) => removeKeyEvent(element));\n });\n };\n function eventHandler(event, handler, scope, element) {\n if (handler.element !== element) {\n return;\n }\n let modifiersMatch;\n if (handler.scope === scope || handler.scope === \"all\") {\n modifiersMatch = handler.mods.length > 0;\n for (const y in _mods) {\n if (Object.prototype.hasOwnProperty.call(_mods, y)) {\n if (!_mods[y] && handler.mods.indexOf(+y) > -1 || _mods[y] && handler.mods.indexOf(+y) === -1) {\n modifiersMatch = false;\n }\n }\n }\n if (handler.mods.length === 0 && !_mods[16] && !_mods[18] && !_mods[17] && !_mods[91] || modifiersMatch || handler.shortcut === \"*\") {\n handler.keys = [];\n handler.keys = handler.keys.concat(_downKeys);\n if (handler.method(event, handler) === false) {\n if (event.preventDefault) event.preventDefault();\n else event.returnValue = false;\n if (event.stopPropagation) event.stopPropagation();\n if (event.cancelBubble) event.cancelBubble = true;\n }\n }\n }\n }\n function dispatch(event, element) {\n const asterisk = _handlers[\"*\"];\n let key = getLayoutIndependentKeyCode(event);\n if (event.key && event.key.toLowerCase() === \"capslock\") {\n return;\n }\n const filterFn = hotkeys2.filter || filter;\n if (!filterFn.call(this, event)) return;\n if (key === 93 || key === 224) key = 91;\n if (_downKeys.indexOf(key) === -1 && key !== 229) _downKeys.push(key);\n [\"metaKey\", \"ctrlKey\", \"altKey\", \"shiftKey\"].forEach((keyName) => {\n const keyNum = modifierMap[keyName];\n if (event[keyName] && _downKeys.indexOf(keyNum) === -1) {\n _downKeys.push(keyNum);\n } else if (!event[keyName] && _downKeys.indexOf(keyNum) > -1) {\n _downKeys.splice(_downKeys.indexOf(keyNum), 1);\n } else if (keyName === \"metaKey\" && event[keyName]) {\n _downKeys = _downKeys.filter((k) => k in modifierMap || k === key);\n }\n });\n if (key in _mods) {\n _mods[key] = true;\n for (const k in _modifier) {\n if (Object.prototype.hasOwnProperty.call(_modifier, k)) {\n const eventKey = modifierMap[_modifier[k]];\n hotkeys2[k] = event[eventKey];\n }\n }\n if (!asterisk) return;\n }\n for (const e in _mods) {\n if (Object.prototype.hasOwnProperty.call(_mods, e)) {\n _mods[e] = event[modifierMap[e]];\n }\n }\n if (event.getModifierState && !(event.altKey && !event.ctrlKey) && event.getModifierState(\"AltGraph\")) {\n if (_downKeys.indexOf(17) === -1) {\n _downKeys.push(17);\n }\n if (_downKeys.indexOf(18) === -1) {\n _downKeys.push(18);\n }\n _mods[17] = true;\n _mods[18] = true;\n }\n const scope = getScope();\n if (asterisk) {\n for (let i = 0; i < asterisk.length; i++) {\n if (asterisk[i].scope === scope && (event.type === \"keydown\" && asterisk[i].keydown || event.type === \"keyup\" && asterisk[i].keyup)) {\n eventHandler(event, asterisk[i], scope, element);\n }\n }\n }\n if (!(key in _handlers)) return;\n const handlerKey = _handlers[key];\n const keyLen = handlerKey.length;\n for (let i = 0; i < keyLen; i++) {\n if (event.type === \"keydown\" && handlerKey[i].keydown || event.type === \"keyup\" && handlerKey[i].keyup) {\n if (handlerKey[i].key) {\n const record = handlerKey[i];\n const { splitKey } = record;\n const keyShortcut = record.key.split(splitKey);\n const _downKeysCurrent = [];\n for (let a = 0; a < keyShortcut.length; a++) {\n _downKeysCurrent.push(code(keyShortcut[a]));\n }\n if (_downKeysCurrent.sort().join(\"\") === _downKeys.sort().join(\"\")) {\n eventHandler(event, record, scope, element);\n }\n }\n }\n }\n }\n const hotkeys2 = function hotkeys22(key, option, method) {\n _downKeys = [];\n const keys = getKeys(key);\n let mods = [];\n let scope = \"all\";\n let element = document;\n let i = 0;\n let keyup = false;\n let keydown = true;\n let splitKey = \"+\";\n let capture = false;\n let single = false;\n if (method === void 0 && typeof option === \"function\") {\n method = option;\n }\n if (Object.prototype.toString.call(option) === \"[object Object]\") {\n const opts = option;\n if (opts.scope) scope = opts.scope;\n if (opts.element) element = opts.element;\n if (opts.keyup) keyup = opts.keyup;\n if (opts.keydown !== void 0) keydown = opts.keydown;\n if (opts.capture !== void 0) capture = opts.capture;\n if (typeof opts.splitKey === \"string\") splitKey = opts.splitKey;\n if (opts.single === true) single = true;\n }\n if (typeof option === \"string\") scope = option;\n if (single) unbind(key, scope);\n for (; i < keys.length; i++) {\n const currentKey = keys[i].split(splitKey);\n mods = [];\n if (currentKey.length > 1) mods = getMods(_modifier, currentKey);\n let finalKey = currentKey[currentKey.length - 1];\n finalKey = finalKey === \"*\" ? \"*\" : code(finalKey);\n if (!(finalKey in _handlers)) _handlers[finalKey] = [];\n _handlers[finalKey].push({\n keyup,\n keydown,\n scope,\n mods,\n shortcut: keys[i],\n method,\n key: keys[i],\n splitKey,\n element\n });\n }\n if (typeof element !== \"undefined\" && typeof window !== \"undefined\") {\n if (!elementEventMap.has(element)) {\n const keydownListener = (event = window.event) => dispatch(event, element);\n const keyupListenr = (event = window.event) => {\n dispatch(event, element);\n clearModifier(event);\n };\n elementEventMap.set(element, { keydownListener, keyupListenr, capture });\n addEvent(element, \"keydown\", keydownListener, capture);\n addEvent(element, \"keyup\", keyupListenr, capture);\n }\n if (!winListendFocus) {\n const listener = () => {\n _downKeys = [];\n };\n winListendFocus = { listener, capture };\n addEvent(window, \"focus\", listener, capture);\n }\n if (!winListendFullscreen && typeof document !== \"undefined\") {\n const onFullscreenChange = () => {\n _downKeys = [];\n for (const k in _mods) _mods[k] = false;\n for (const k in _modifier) hotkeys22[k] = false;\n };\n const fullscreenListener = onFullscreenChange;\n const webkitListener = onFullscreenChange;\n document.addEventListener(\"fullscreenchange\", fullscreenListener);\n document.addEventListener(\"webkitfullscreenchange\", webkitListener);\n winListendFullscreen = { fullscreen: fullscreenListener, webkit: webkitListener };\n }\n }\n };\n function trigger(shortcut, scope = \"all\") {\n Object.keys(_handlers).forEach((key) => {\n const dataList = _handlers[key].filter(\n (item) => item.scope === scope && item.shortcut === shortcut\n );\n dataList.forEach((data) => {\n if (data && data.method) {\n data.method({}, data);\n }\n });\n });\n }\n function removeKeyEvent(element) {\n const values = Object.values(_handlers).flat();\n const findindex = values.findIndex(({ element: el }) => el === element);\n if (findindex < 0 && element) {\n const { keydownListener, keyupListenr, capture } = elementEventMap.get(element) || {};\n if (keydownListener && keyupListenr) {\n removeEvent(element, \"keyup\", keyupListenr, capture);\n removeEvent(element, \"keydown\", keydownListener, capture);\n elementEventMap.delete(element);\n }\n }\n if (values.length <= 0 || elementEventMap.size <= 0) {\n const eventKeys = Array.from(elementEventMap.keys());\n eventKeys.forEach((el) => {\n const { keydownListener, keyupListenr, capture } = elementEventMap.get(el) || {};\n if (keydownListener && keyupListenr) {\n removeEvent(el, \"keyup\", keyupListenr, capture);\n removeEvent(el, \"keydown\", keydownListener, capture);\n elementEventMap.delete(el);\n }\n });\n elementEventMap.clear();\n Object.keys(_handlers).forEach((key) => delete _handlers[key]);\n if (winListendFocus) {\n const { listener, capture } = winListendFocus;\n removeEvent(window, \"focus\", listener, capture);\n winListendFocus = null;\n }\n if (winListendFullscreen && typeof document !== \"undefined\") {\n document.removeEventListener(\"fullscreenchange\", winListendFullscreen.fullscreen);\n document.removeEventListener(\"webkitfullscreenchange\", winListendFullscreen.webkit);\n winListendFullscreen = null;\n }\n }\n }\n const _api = {\n getPressedKeyString,\n setScope,\n getScope,\n deleteScope,\n getPressedKeyCodes,\n getAllKeyCodes,\n isPressed,\n filter,\n trigger,\n unbind,\n keyMap: _keyMap,\n modifier: _modifier,\n modifierMap\n };\n for (const a in _api) {\n const key = a;\n if (Object.prototype.hasOwnProperty.call(_api, key)) {\n hotkeys2[key] = _api[key];\n }\n }\n if (typeof window !== \"undefined\") {\n const _hotkeys = window.hotkeys;\n hotkeys2.noConflict = (deep) => {\n if (deep && window.hotkeys === hotkeys2) {\n window.hotkeys = _hotkeys;\n }\n return hotkeys2;\n };\n window.hotkeys = hotkeys2;\n }\n if (typeof module !== \"undefined\" && module.exports) {\n module.exports = hotkeys2;\n module.exports.default = hotkeys2;\n }\n return hotkeys2;\n});\nif (typeof module === \"object\" && module.exports) {\n module.exports.default = module.exports;\n}\nif (typeof define === \"function\" && define.amd) {\n define([], function() {\n return hotkeys;\n });\n}\n//# sourceMappingURL=hotkeys-js.umd.cjs.map\n" }, { "path": "dist/index.d.ts", "content": "declare const _default: HotkeysInterface;\r\nexport default _default;\r\n\r\ndeclare type DeleteScope = (scope?: string, newScope?: string) => void;\r\n\r\ndeclare type Filter = (event: KeyboardEvent) => boolean;\r\n\r\ndeclare type GetAllKeyCodes = () => KeyCodeInfo[];\r\n\r\ndeclare type GetPressedKeyCodes = () => number[];\r\n\r\ndeclare type GetPressedKeyString = () => string[];\r\n\r\ndeclare type GetScope = () => string;\r\n\r\ndeclare interface HotkeysAPI {\r\n /**\r\n * Use the `hotkeys.setScope` method to set scope. There can only be one active scope besides 'all'. By default 'all' is always active.\r\n *\r\n * ```js\r\n * // Define shortcuts with a scope\r\n * hotkeys('ctrl+o, ctrl+alt+enter', 'issues', function() {\r\n * console.log('do something');\r\n * });\r\n * hotkeys('o, enter', 'files', function() {\r\n * console.log('do something else');\r\n * });\r\n *\r\n * // Set the scope (only 'all' and 'issues' shortcuts will be honored)\r\n * hotkeys.setScope('issues'); // default scope is 'all'\r\n * ```\r\n */\r\n setScope: SetScope;\r\n /**\r\n * Use the `hotkeys.getScope` method to get scope.\r\n *\r\n * ```js\r\n * hotkeys.getScope();\r\n * ```\r\n */\r\n getScope: GetScope;\r\n /**\r\n * Use the `hotkeys.deleteScope` method to delete a scope. This will also remove all associated hotkeys with it.\r\n *\r\n * ```js\r\n * hotkeys.deleteScope('issues');\r\n * ```\r\n * You can use second argument, if need set new scope after deleting.\r\n *\r\n * ```js\r\n * hotkeys.deleteScope('issues', 'newScopeName');\r\n * ```\r\n */\r\n deleteScope: DeleteScope;\r\n /**\r\n * Returns an array of key codes currently pressed.\r\n *\r\n * ```js\r\n * hotkeys('command+ctrl+shift+a,f', function() {\r\n * console.log(hotkeys.getPressedKeyCodes()); //=> [17, 65] or [70]\r\n * })\r\n * ```\r\n */\r\n getPressedKeyCodes: GetPressedKeyCodes;\r\n /**\r\n * Returns an array of key codes currently pressed.\r\n *\r\n * ```js\r\n * hotkeys('command+ctrl+shift+a,f', function() {\r\n * console.log(hotkeys.getPressedKeyString()); //=> ['⌘', '⌃', '⇧', 'A', 'F']\r\n * })\r\n * ```\r\n */\r\n getPressedKeyString: GetPressedKeyString;\r\n /**\r\n * Get a list of all registration codes.\r\n *\r\n * ```js\r\n * hotkeys('command+ctrl+shift+a,f', function() {\r\n * console.log(hotkeys.getAllKeyCodes());\r\n * // [\r\n * // { scope: 'all', shortcut: 'command+ctrl+shift+a', mods: [91, 17, 16], keys: [91, 17, 16, 65] },\r\n * // { scope: 'all', shortcut: 'f', mods: [], keys: [42] }\r\n * // ]\r\n * })\r\n * ```\r\n *\r\n */\r\n getAllKeyCodes: GetAllKeyCodes;\r\n isPressed: IsPressed;\r\n /**\r\n * By default hotkeys are not enabled for `INPUT` `SELECT` `TEXTAREA` elements.\r\n * `Hotkeys.filter` to return to the `true` shortcut keys set to play a role,\r\n * `false` shortcut keys set up failure.\r\n *\r\n * ```js\r\n * hotkeys.filter = function(event){\r\n * return true;\r\n * }\r\n * //How to add the filter to edit labels.
\r\n * //\"contentEditable\" Older browsers that do not support drops\r\n * hotkeys.filter = function(event) {\r\n * var target = event.target || event.srcElement;\r\n * var tagName = target.tagName;\r\n * return !(target.isContentEditable || tagName == 'INPUT' || tagName == 'SELECT' || tagName == 'TEXTAREA');\r\n * }\r\n *\r\n * hotkeys.filter = function(event){\r\n * var tagName = (event.target || event.srcElement).tagName;\r\n * hotkeys.setScope(/^(INPUT|TEXTAREA|SELECT)$/.test(tagName) ? 'input' : 'other');\r\n * return true;\r\n * }\r\n * ```\r\n */\r\n filter: Filter;\r\n /**\r\n * trigger shortcut key event\r\n *\r\n * ```js\r\n * hotkeys.trigger('ctrl+o');\r\n * hotkeys.trigger('ctrl+o', 'scope2');\r\n * ```\r\n */\r\n trigger: Trigger;\r\n /**\r\n * Unbinds a shortcut key event.\r\n *\r\n * ```js\r\n * hotkeys.unbind('ctrl+o');\r\n * hotkeys.unbind('ctrl+o', 'scope1');\r\n * hotkeys.unbind('ctrl+o', 'scope1', method);\r\n * hotkeys.unbind('ctrl+o', method);\r\n * ```\r\n */\r\n unbind: Unbind;\r\n /**\r\n * Relinquish HotKeys’s control of the `hotkeys` variable.\r\n *\r\n * ```js\r\n * var k = hotkeys.noConflict();\r\n * k('a', function() {\r\n * console.log(\"do something\")\r\n * });\r\n *\r\n * hotkeys()\r\n * // -->Uncaught TypeError: hotkeys is not a function(anonymous function)\r\n * // @ VM2170:2InjectedScript._evaluateOn\r\n * // @ VM2165:883InjectedScript._evaluateAndWrap\r\n * // @ VM2165:816InjectedScript.evaluate @ VM2165:682\r\n * ```\r\n */\r\n noConflict: NoConflict;\r\n keyMap: Record;\r\n modifier: Record;\r\n modifierMap: Record;\r\n}\r\n\r\nexport declare interface HotkeysEvent {\r\n keyup: boolean;\r\n keydown: boolean;\r\n scope: string;\r\n mods: number[];\r\n shortcut: string;\r\n method: KeyHandler;\r\n key: string;\r\n splitKey: string;\r\n element: HTMLElement | Document;\r\n keys?: number[];\r\n}\r\n\r\ndeclare interface HotkeysInterface extends HotkeysAPI {\r\n (key: string, method: KeyHandler): void;\r\n (key: string, scope: string, method: KeyHandler): void;\r\n (key: string, option: HotkeysOptions, method: KeyHandler): void;\r\n shift?: boolean;\r\n ctrl?: boolean;\r\n alt?: boolean;\r\n option?: boolean;\r\n control?: boolean;\r\n cmd?: boolean;\r\n command?: boolean;\r\n}\r\n\r\ndeclare interface HotkeysOptions {\r\n scope?: string;\r\n element?: HTMLElement | Document;\r\n keyup?: boolean;\r\n keydown?: boolean;\r\n capture?: boolean;\r\n splitKey?: string;\r\n single?: boolean;\r\n}\r\n\r\ndeclare interface IsPressed {\r\n /** For example, `hotkeys.isPressed(77)` is true if the `M` key is currently pressed. */\r\n (keyCode: number): boolean;\r\n /** For example, `hotkeys.isPressed('m')` is true if the `M` key is currently pressed. */\r\n (keyCode: string): boolean;\r\n}\r\n\r\ndeclare interface KeyCodeInfo {\r\n scope: string;\r\n shortcut: string;\r\n mods: number[];\r\n keys: number[];\r\n}\r\n\r\nexport declare interface KeyHandler {\r\n (keyboardEvent: KeyboardEvent, hotkeysEvent: HotkeysEvent): void | boolean;\r\n}\r\n\r\ndeclare type NoConflict = (deep?: boolean) => HotkeysInterface;\r\n\r\ndeclare type SetScope = (scope: string) => void;\r\n\r\ndeclare type Trigger = (shortcut: string, scope?: string) => void;\r\n\r\ndeclare interface Unbind {\r\n (key?: string): void;\r\n (keysInfo: UnbindInfo): void;\r\n (keysInfo: UnbindInfo[]): void;\r\n (key: string, scopeName: string): void;\r\n (key: string, scopeName: string, method: KeyHandler): void;\r\n (key: string, method: KeyHandler): void;\r\n}\r\n\r\ndeclare interface UnbindInfo {\r\n key: string;\r\n scope?: string;\r\n method?: KeyHandler;\r\n splitKey?: string;\r\n}\r\n\r\nexport { }\r\n" }, { "path": "eslint.config.js", "content": "// @ts-check\nimport { defineConfig } from 'eslint/config';\nimport eslint from '@eslint/js';\nimport tseslint from 'typescript-eslint';\nimport reactPlugin from 'eslint-plugin-react';\nimport reactHooksPlugin from 'eslint-plugin-react-hooks';\nimport importPlugin from 'eslint-plugin-import';\nimport jsxA11yPlugin from 'eslint-plugin-jsx-a11y';\nimport globals from 'globals';\n\nexport default defineConfig([\n eslint.configs.recommended,\n ...tseslint.configs.recommended,\n {\n files: ['**/*.{js,jsx,ts,tsx}'],\n languageOptions: {\n ecmaVersion: 2020,\n sourceType: 'module',\n parserOptions: {\n ecmaFeatures: {\n jsx: true,\n },\n },\n globals: {\n ...globals.browser,\n ...globals.node,\n ...globals.es2020,\n ...globals.jest,\n },\n },\n plugins: {\n react: reactPlugin,\n 'react-hooks': reactHooksPlugin,\n import: importPlugin,\n 'jsx-a11y': jsxA11yPlugin,\n },\n settings: {\n react: {\n version: 'detect',\n },\n },\n rules: {\n // TypeScript rules\n '@typescript-eslint/no-explicit-any': 'off',\n '@typescript-eslint/explicit-module-boundary-types': 'off',\n '@typescript-eslint/no-inferrable-types': 'off',\n '@typescript-eslint/no-non-null-assertion': 'off',\n '@typescript-eslint/no-unused-expressions': 'error',\n\n // General rules\n 'no-console': ['error', { allow: ['log'] }],\n 'no-underscore-dangle': 'off',\n 'no-plusplus': 'off',\n 'no-param-reassign': 'off',\n 'no-restricted-syntax': 'off',\n 'no-use-before-define': 'off',\n 'max-len': 'off',\n 'comma-dangle': 'off',\n 'no-multiple-empty-lines': ['error', { max: 1, maxEOF: 0 }],\n 'quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],\n 'indent': ['error', 2, { SwitchCase: 1 }],\n 'linebreak-style': ['error', 'unix'],\n 'no-trailing-spaces': 'error',\n 'eol-last': ['error', 'always'],\n 'object-curly-newline': 'off',\n 'arrow-body-style': 'off',\n 'consistent-return': 'off',\n 'generator-star-spacing': 'off',\n 'global-require': 'warn',\n 'no-bitwise': 'off',\n 'no-cond-assign': 'off',\n 'no-else-return': 'off',\n 'no-nested-ternary': 'off',\n 'require-yield': 'warn',\n 'class-methods-use-this': 'off',\n 'no-confusing-arrow': 'off',\n 'no-unused-expressions': 'off',\n\n // React rules\n 'react/jsx-filename-extension': [\n 'warn',\n {\n extensions: ['.js', '.jsx', '.ts', '.tsx'],\n },\n ],\n 'react/jsx-no-bind': 'off',\n 'react/prop-types': 'off',\n 'react/no-array-index-key': 'off',\n 'react/forbid-prop-types': 'off',\n 'react/prefer-stateless-function': 'off',\n 'react/sort-comp': 'off',\n 'react/no-did-mount-set-state': 'off',\n 'react-hooks/rules-of-hooks': 'error',\n 'react-hooks/exhaustive-deps': 'warn',\n\n // Import rules\n 'import/extensions': 'off',\n 'import/no-unresolved': 'off',\n 'import/no-extraneous-dependencies': 'off',\n 'import/prefer-default-export': 'off',\n\n // JSX A11y rules\n 'jsx-a11y/no-noninteractive-element-interactions': 'off',\n 'jsx-a11y/no-static-element-interactions': 'off',\n },\n },\n {\n files: ['**/*.ts', '**/*.tsx'],\n languageOptions: {\n parserOptions: {\n projectService: true,\n tsconfigRootDir: import.meta.dirname,\n },\n },\n },\n {\n ignores: ['dist/**', 'node_modules/**', 'coverage/**', 'build/**', 'doc/**'],\n },\n]);\n" }, { "path": "package.json", "content": "{\n \"name\": \"hotkeys-js\",\n \"description\": \"A simple micro-library for defining and dispatching keyboard shortcuts. It has no dependencies.\",\n \"version\": \"4.0.2\",\n \"type\": \"module\",\n \"main\": \"dist/hotkeys-js.umd.cjs\",\n \"module\": \"dist/hotkeys-js.js\",\n \"browser\": \"dist/hotkeys-js.min.js\",\n \"types\": \"dist/index.d.ts\",\n \"exports\": {\n \".\": {\n \"types\": \"./dist/index.d.ts\",\n \"import\": \"./dist/hotkeys-js.js\",\n \"require\": \"./dist/hotkeys-js.umd.cjs\",\n \"browser\": \"./dist/hotkeys-js.min.js\",\n \"default\": \"./dist/hotkeys-js.js\"\n },\n \"./package.json\": \"./package.json\"\n },\n \"scripts\": {\n \"prepare\": \"npm run build:lib && husky install\",\n \"lint\": \"eslint src website\",\n \"type-check\": \"tsc --noEmit\",\n \"watch\": \"vite build --watch\",\n \"build:lib\": \"vite build\",\n \"build\": \"npm run type-check && npm run build:lib && npm run doc && npm run lint\",\n \"pretest\": \"npm run build\",\n \"test\": \"jest --coverage --detectOpenHandles\",\n \"test:watch\": \"jest --watch\",\n \"doc\": \"vite build --config website/vite.config.ts\",\n \"start\": \"vite --config website/vite.config.ts\"\n },\n \"files\": [\n \"dist\",\n \"doc\"\n ],\n \"keywords\": [\n \"hotkey\",\n \"hotkeys\",\n \"hotkeys-js\",\n \"hotkeysjs\",\n \"key\",\n \"keys\",\n \"keyboard\",\n \"shortcuts\",\n \"keypress\"\n ],\n \"author\": \"kenny wong \",\n \"license\": \"MIT\",\n \"homepage\": \"https://jaywcjlove.github.io/hotkeys-js\",\n \"funding\": \"https://jaywcjlove.github.io/#/sponsor\",\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/jaywcjlove/hotkeys-js.git\"\n },\n \"devDependencies\": {\n \"@eslint/js\": \"^9.39.1\",\n \"@rollup/plugin-terser\": \"^0.4.4\",\n \"@types/node\": \"^24.10.1\",\n \"@types/react\": \"^19.2.4\",\n \"@types/react-dom\": \"^19.2.3\",\n \"@uiw/react-github-corners\": \"^1.5.15\",\n \"@uiw/react-mac-keyboard\": \"^1.1.5\",\n \"@uiw/react-markdown-preview\": \"^5.0.3\",\n \"@uiw/react-shields\": \"^2.0.1\",\n \"@vitejs/plugin-react\": \"^5.1.1\",\n \"@wcj/dark-mode\": \"~1.1.0\",\n \"eslint\": \"^9.39.1\",\n \"eslint-plugin-import\": \"^2.32.0\",\n \"eslint-plugin-jsx-a11y\": \"^6.10.2\",\n \"eslint-plugin-react\": \"^7.37.5\",\n \"eslint-plugin-react-hooks\": \"^5.1.0\",\n \"globals\": \"^16.5.0\",\n \"husky\": \"^8.0.3\",\n \"jest\": \"^29.7.0\",\n \"jest-environment-jsdom\": \"^29.7.0\",\n \"lint-staged\": \"^15.2.0\",\n \"puppeteer\": \"~13.5.2\",\n \"react\": \"^19.2.0\",\n \"react-dom\": \"^19.2.0\",\n \"typescript\": \"^5.8.2\",\n \"typescript-eslint\": \"^8.46.4\",\n \"vite\": \"^5.1.0\",\n \"vite-plugin-dts\": \"^4.5.4\"\n },\n \"browserslist\": {\n \"production\": [\n \">0.2%\",\n \"not dead\",\n \"not op_mini all\"\n ],\n \"development\": [\n \"last 1 chrome version\",\n \"last 1 firefox version\",\n \"last 1 safari version\"\n ]\n },\n \"lint-staged\": {\n \"src/**/*.{js,ts}\": \"eslint\",\n \"website/**/*.{js,jsx,ts,tsx}\": \"eslint\"\n },\n \"overrides\": {\n \"react\": \"^19.2.0\",\n \"react-dom\": \"^19.2.0\"\n }\n}\n" }, { "path": "src/index.ts", "content": "import {\n KeyCodeInfo,\n HotkeysEvent,\n UnbindInfo,\n HotkeysOptions,\n KeyHandler,\n HotkeysInterface,\n SetScope,\n GetScope,\n GetPressedKeyCodes,\n GetPressedKeyString,\n GetAllKeyCodes,\n Filter,\n IsPressed,\n DeleteScope,\n Unbind,\n HotkeysAPI,\n} from './types';\nimport { addEvent, removeEvent, getMods, getKeys, compareArray, getLayoutIndependentKeyCode } from './utils';\nimport { _keyMap, _modifier, modifierMap, _mods, _handlers } from './var';\n\n/** Record the pressed keys */\nlet _downKeys: number[] = [];\n/** Whether the window has already listened to the focus event */\nlet winListendFocus: { listener: EventListener; capture: boolean } | null =\n null;\n/** Whether we already listen to fullscreen change (to clear stuck _downKeys) */\nlet winListendFullscreen: { fullscreen: EventListener; webkit: EventListener } | null = null;\n/** Default hotkey scope */\nlet _scope: string = 'all';\n/** Map to record elements with bound events */\nconst elementEventMap = new Map<\n HTMLElement | Document,\n {\n keydownListener: EventListener;\n keyupListenr: EventListener;\n capture: boolean;\n }\n>();\n\n/** Return key code */\nconst code = (x: string): number =>\n _keyMap[x.toLowerCase()] ||\n _modifier[x.toLowerCase()] ||\n x.toUpperCase().charCodeAt(0);\n\nconst getKey = (x: number): string | undefined =>\n Object.keys(_keyMap).find((k) => _keyMap[k] === x);\nconst getModifier = (x: number): string | undefined =>\n Object.keys(_modifier).find((k) => _modifier[k] === x);\n\n/** Set or get the current scope (defaults to 'all') */\nconst setScope: SetScope = (scope) => {\n _scope = scope || 'all';\n};\n/** Get the current scope */\nconst getScope: GetScope = () => {\n return _scope || 'all';\n};\n/** Get the key codes of the currently pressed keys */\nconst getPressedKeyCodes: GetPressedKeyCodes = () => {\n return _downKeys.slice(0);\n};\n\nconst getPressedKeyString: GetPressedKeyString = () => {\n return _downKeys.map(\n (c) => getKey(c) || getModifier(c) || String.fromCharCode(c)\n );\n};\n\nconst getAllKeyCodes: GetAllKeyCodes = () => {\n const result: KeyCodeInfo[] = [];\n Object.keys(_handlers).forEach((k) => {\n _handlers[k].forEach(({ key, scope, mods, shortcut }) => {\n result.push({\n scope,\n shortcut,\n mods,\n keys: key.split('+').map((v) => code(v)),\n });\n });\n });\n return result;\n};\n\n/** hotkey is effective only when filter return true */\nconst filter: Filter = (event) => {\n const target = (event.target || event.srcElement) as HTMLElement;\n const { tagName } = target;\n let flag = true;\n const isInput =\n tagName === 'INPUT' &&\n ![\n 'checkbox',\n 'radio',\n 'range',\n 'button',\n 'file',\n 'reset',\n 'submit',\n 'color',\n ].includes((target as HTMLInputElement).type);\n // ignore: isContentEditable === 'true', and