@quantabit/hotkey-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 QuantaBit Team
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ # @quantabit/hotkey-sdk
2
+
3
+ > Keyboard shortcut and hotkey management
4
+
5
+ ## Features
6
+ - **useHotkey** — Single shortcut: `useHotkey('mod+s', save)`
7
+ - **useHotkeys** — Batch: `useHotkeys([{combo:'mod+k',handler:search}])`
8
+ - **HotkeyDisplay** — Render `⌘S` / `Ctrl+S` (auto Mac/Win)
9
+ - **formatHotkey** — Format combo string for display
10
+ - Auto-ignores input/textarea focus
11
+
12
+ ```jsx
13
+ import { useHotkey, HotkeyDisplay } from '@quantabit/hotkey-sdk';
14
+ useHotkey('mod+s', () => save(), { preventDefault: true });
15
+ <HotkeyDisplay combo="mod+k" /> // renders ⌘K on Mac
16
+ ```
17
+
18
+ ## License
19
+ MIT
20
+
21
+
22
+
23
+ ---
24
+
25
+ ## 🌐 Brand & Links
26
+ - Official Mainnet: [QuantaBit Chain](https://qbitchain.io/)
27
+ - Developer Platform: [Developer Platform](https://developer.quantabit.io/)
28
+ - Open Platform: [Open Platform](https://open.quantabit.io/)
29
+ - Payment Platform: [Pay Platform](https://pay.qbitwallet.io/)
30
+ - Feedback: [Feedback](https://xwin.live/qbit)
package/dist/index.cjs ADDED
@@ -0,0 +1,142 @@
1
+ 'use strict';
2
+
3
+ var React = require('react');
4
+
5
+ /**
6
+ * 快捷键解析/格式化工具
7
+ */
8
+ const isMac = typeof navigator !== 'undefined' && /Mac|iPhone|iPad/.test(navigator.platform);
9
+ const MOD_MAP = {
10
+ ctrl: isMac ? '⌃' : 'Ctrl',
11
+ alt: isMac ? '⌥' : 'Alt',
12
+ shift: isMac ? '⇧' : 'Shift',
13
+ meta: isMac ? '⌘' : 'Win'};
14
+ const KEY_MAP = {
15
+ arrowup: '↑',
16
+ arrowdown: '↓',
17
+ arrowleft: '←',
18
+ arrowright: '→',
19
+ escape: 'Esc',
20
+ enter: '↩',
21
+ backspace: '⌫',
22
+ delete: '⌦',
23
+ tab: '⇥',
24
+ space: 'Space'
25
+ };
26
+ function parseHotkey(combo) {
27
+ const parts = combo.toLowerCase().split('+').map(s => s.trim());
28
+ const mods = {
29
+ ctrl: false,
30
+ alt: false,
31
+ shift: false,
32
+ meta: false
33
+ };
34
+ let key = '';
35
+ parts.forEach(p => {
36
+ if (p === 'ctrl' || p === 'control') mods.ctrl = true;else if (p === 'alt' || p === 'option') mods.alt = true;else if (p === 'shift') mods.shift = true;else if (p === 'meta' || p === 'cmd' || p === 'command' || p === 'win') mods.meta = true;else if (p === 'mod') {
37
+ if (isMac) mods.meta = true;else mods.ctrl = true;
38
+ } else key = p;
39
+ });
40
+ return {
41
+ ...mods,
42
+ key
43
+ };
44
+ }
45
+ function formatHotkey(combo) {
46
+ const {
47
+ ctrl,
48
+ alt,
49
+ shift,
50
+ meta,
51
+ key
52
+ } = parseHotkey(combo);
53
+ const parts = [];
54
+ if (ctrl) parts.push(MOD_MAP.ctrl);
55
+ if (alt) parts.push(MOD_MAP.alt);
56
+ if (shift) parts.push(MOD_MAP.shift);
57
+ if (meta) parts.push(MOD_MAP.meta);
58
+ const display = KEY_MAP[key] || key.toUpperCase();
59
+ parts.push(display);
60
+ return isMac ? parts.join('') : parts.join(' + ');
61
+ }
62
+ function isInputElement(el) {
63
+ if (!el) return false;
64
+ const tag = el.tagName;
65
+ return tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT' || el.isContentEditable;
66
+ }
67
+
68
+ function useHotkey(combo, callback, opts = {}) {
69
+ const {
70
+ enabled = true,
71
+ preventDefault = true,
72
+ ignoreInput = true
73
+ } = opts;
74
+ const parsed = parseHotkey(combo);
75
+ const handler = React.useCallback(e => {
76
+ if (!enabled) return;
77
+ if (ignoreInput && isInputElement(e.target)) return;
78
+ const match = e.key.toLowerCase() === parsed.key && e.ctrlKey === parsed.ctrl && e.altKey === parsed.alt && e.shiftKey === parsed.shift && e.metaKey === parsed.meta;
79
+ if (match) {
80
+ if (preventDefault) e.preventDefault();
81
+ callback(e);
82
+ }
83
+ }, [combo, callback, enabled, preventDefault, ignoreInput]);
84
+ React.useEffect(() => {
85
+ document.addEventListener('keydown', handler);
86
+ return () => document.removeEventListener('keydown', handler);
87
+ }, [handler]);
88
+ }
89
+
90
+ function useHotkeys(bindings = [], opts = {}) {
91
+ bindings.forEach(({
92
+ combo,
93
+ handler
94
+ }) => useHotkey(combo, handler, opts));
95
+ }
96
+
97
+ function HotkeyDisplay({
98
+ combo,
99
+ size = 'small',
100
+ className = ''
101
+ }) {
102
+ const display = formatHotkey(combo);
103
+ const sz = {
104
+ small: {
105
+ font: 11,
106
+ pad: '2px 5px'
107
+ },
108
+ medium: {
109
+ font: 12,
110
+ pad: '3px 7px'
111
+ },
112
+ large: {
113
+ font: 13,
114
+ pad: '4px 8px'
115
+ }
116
+ };
117
+ const s = sz[size] || sz.small;
118
+ return /*#__PURE__*/React.createElement("kbd", {
119
+ className: `qhk-key ${className}`,
120
+ style: {
121
+ display: 'inline-flex',
122
+ gap: 2,
123
+ fontSize: s.font,
124
+ fontFamily: 'SF Mono,Menlo,monospace',
125
+ padding: s.pad,
126
+ borderRadius: 4,
127
+ background: 'rgba(128,128,128,0.08)',
128
+ color: '#71717a',
129
+ border: '1px solid rgba(128,128,128,0.12)',
130
+ lineHeight: 1.2,
131
+ fontWeight: 500
132
+ }
133
+ }, display);
134
+ }
135
+
136
+ exports.HotkeyDisplay = HotkeyDisplay;
137
+ exports.formatHotkey = formatHotkey;
138
+ exports.isInputElement = isInputElement;
139
+ exports.parseHotkey = parseHotkey;
140
+ exports.useHotkey = useHotkey;
141
+ exports.useHotkeys = useHotkeys;
142
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.cjs","sources":["../src/utils/hotkey.js","../src/hooks/useHotkey.js","../src/hooks/useHotkeys.js","../src/components/HotkeyDisplay.jsx"],"sourcesContent":["/**\n * 快捷键解析/格式化工具\n */\nconst isMac=typeof navigator!=='undefined'&&/Mac|iPhone|iPad/.test(navigator.platform);\nconst MOD_MAP={ctrl:isMac?'⌃':'Ctrl',alt:isMac?'⌥':'Alt',shift:isMac?'⇧':'Shift',meta:isMac?'⌘':'Win',mod:isMac?'⌘':'Ctrl'};\nconst KEY_MAP={arrowup:'↑',arrowdown:'↓',arrowleft:'←',arrowright:'→',escape:'Esc',enter:'↩',backspace:'⌫',delete:'⌦',tab:'⇥',space:'Space'};\n\nexport function parseHotkey(combo){\n const parts=combo.toLowerCase().split('+').map(s=>s.trim());\n const mods={ctrl:false,alt:false,shift:false,meta:false};\n let key='';\n parts.forEach(p=>{if(p==='ctrl'||p==='control')mods.ctrl=true;\n else if(p==='alt'||p==='option')mods.alt=true;\n else if(p==='shift')mods.shift=true;\n else if(p==='meta'||p==='cmd'||p==='command'||p==='win')mods.meta=true;\n else if(p==='mod'){if(isMac)mods.meta=true;else mods.ctrl=true;}\n else key=p;});\n return{...mods,key};\n}\n\nexport function formatHotkey(combo){\n const{ctrl,alt,shift,meta,key}=parseHotkey(combo);\n const parts=[];\n if(ctrl)parts.push(MOD_MAP.ctrl);if(alt)parts.push(MOD_MAP.alt);\n if(shift)parts.push(MOD_MAP.shift);if(meta)parts.push(MOD_MAP.meta);\n const display=KEY_MAP[key]||key.toUpperCase();parts.push(display);\n return isMac?parts.join(''):parts.join(' + ');\n}\n\nexport function isInputElement(el){\n if(!el)return false;\n const tag=el.tagName;\n return tag==='INPUT'||tag==='TEXTAREA'||tag==='SELECT'||el.isContentEditable;\n}\n","import{useEffect,useCallback}from'react';\nimport{parseHotkey,isInputElement}from'../utils/hotkey';\nexport function useHotkey(combo,callback,opts={}){\n const{enabled=true,preventDefault=true,ignoreInput=true}=opts;\n const parsed=parseHotkey(combo);\n const handler=useCallback(e=>{if(!enabled)return;\n if(ignoreInput&&isInputElement(e.target))return;\n const match=e.key.toLowerCase()===parsed.key&&e.ctrlKey===parsed.ctrl&&e.altKey===parsed.alt&&e.shiftKey===parsed.shift&&e.metaKey===parsed.meta;\n if(match){if(preventDefault)e.preventDefault();callback(e);}\n },[combo,callback,enabled,preventDefault,ignoreInput]);\n useEffect(()=>{document.addEventListener('keydown',handler);return()=>document.removeEventListener('keydown',handler);},[handler]);\n}\n","import{useHotkey}from'./useHotkey';\nexport function useHotkeys(bindings=[],opts={}){\n bindings.forEach(({combo,handler})=>useHotkey(combo,handler,opts));\n}\n","import React from'react';\nimport{formatHotkey}from'../utils/hotkey';\nexport function HotkeyDisplay({combo,size='small',className=''}){\n const display=formatHotkey(combo);\n const sz={small:{font:11,pad:'2px 5px'},medium:{font:12,pad:'3px 7px'},large:{font:13,pad:'4px 8px'}};\n const s=sz[size]||sz.small;\n return(<kbd className={`qhk-key ${className}`}\n style={{display:'inline-flex',gap:2,fontSize:s.font,fontFamily:'SF Mono,Menlo,monospace',padding:s.pad,\n borderRadius:4,background:'rgba(128,128,128,0.08)',color:'#71717a',border:'1px solid rgba(128,128,128,0.12)',\n lineHeight:1.2,fontWeight:500}}>{display}</kbd>);\n}\n"],"names":["isMac","navigator","test","platform","MOD_MAP","ctrl","alt","shift","meta","KEY_MAP","arrowup","arrowdown","arrowleft","arrowright","escape","enter","backspace","delete","tab","space","parseHotkey","combo","parts","toLowerCase","split","map","s","trim","mods","key","forEach","p","formatHotkey","push","display","toUpperCase","join","isInputElement","el","tag","tagName","isContentEditable","useHotkey","callback","opts","enabled","preventDefault","ignoreInput","parsed","handler","useCallback","e","target","match","ctrlKey","altKey","shiftKey","metaKey","useEffect","document","addEventListener","removeEventListener","useHotkeys","bindings","HotkeyDisplay","size","className","sz","small","font","pad","medium","large","React","createElement","style","gap","fontSize","fontFamily","padding","borderRadius","background","color","border","lineHeight","fontWeight"],"mappings":";;;;AAAA;AACA;AACA;AACA,MAAMA,KAAK,GAAC,OAAOC,SAAS,KAAG,WAAW,IAAE,iBAAiB,CAACC,IAAI,CAACD,SAAS,CAACE,QAAQ,CAAC;AACtF,MAAMC,OAAO,GAAC;AAACC,EAAAA,IAAI,EAACL,KAAK,GAAC,GAAG,GAAC,MAAM;AAACM,EAAAA,GAAG,EAACN,KAAK,GAAC,GAAG,GAAC,KAAK;AAACO,EAAAA,KAAK,EAACP,KAAK,GAAC,GAAG,GAAC,OAAO;AAACQ,EAAAA,IAAI,EAACR,KAAK,GAAC,GAAG,GAAC,KAA0B,CAAC;AAC3H,MAAMS,OAAO,GAAC;AAACC,EAAAA,OAAO,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,UAAU,EAAC,GAAG;AAACC,EAAAA,MAAM,EAAC,KAAK;AAACC,EAAAA,KAAK,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,MAAM,EAAC,GAAG;AAACC,EAAAA,GAAG,EAAC,GAAG;AAACC,EAAAA,KAAK,EAAC;AAAO,CAAC;AAErI,SAASC,WAAWA,CAACC,KAAK,EAAC;EAChC,MAAMC,KAAK,GAACD,KAAK,CAACE,WAAW,EAAE,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,CAACC,CAAC,IAAEA,CAAC,CAACC,IAAI,EAAE,CAAC;AAC3D,EAAA,MAAMC,IAAI,GAAC;AAACvB,IAAAA,IAAI,EAAC,KAAK;AAACC,IAAAA,GAAG,EAAC,KAAK;AAACC,IAAAA,KAAK,EAAC,KAAK;AAACC,IAAAA,IAAI,EAAC;GAAM;EACxD,IAAIqB,GAAG,GAAC,EAAE;AACVP,EAAAA,KAAK,CAACQ,OAAO,CAACC,CAAC,IAAE;AAAC,IAAA,IAAGA,CAAC,KAAG,MAAM,IAAEA,CAAC,KAAG,SAAS,EAACH,IAAI,CAACvB,IAAI,GAAC,IAAI,CAAC,KACvD,IAAG0B,CAAC,KAAG,KAAK,IAAEA,CAAC,KAAG,QAAQ,EAACH,IAAI,CAACtB,GAAG,GAAC,IAAI,CAAC,KACzC,IAAGyB,CAAC,KAAG,OAAO,EAACH,IAAI,CAACrB,KAAK,GAAC,IAAI,CAAC,KAC/B,IAAGwB,CAAC,KAAG,MAAM,IAAEA,CAAC,KAAG,KAAK,IAAEA,CAAC,KAAG,SAAS,IAAEA,CAAC,KAAG,KAAK,EAACH,IAAI,CAACpB,IAAI,GAAC,IAAI,CAAC,KAClE,IAAGuB,CAAC,KAAG,KAAK,EAAC;AAAC,MAAA,IAAG/B,KAAK,EAAC4B,IAAI,CAACpB,IAAI,GAAC,IAAI,CAAC,KAAKoB,IAAI,CAACvB,IAAI,GAAC,IAAI;IAAC,CAAC,MAC3DwB,GAAG,GAACE,CAAC;AAAC,EAAA,CAAC,CAAC;EACf,OAAM;AAAC,IAAA,GAAGH,IAAI;AAACC,IAAAA;GAAI;AACrB;AAEO,SAASG,YAAYA,CAACX,KAAK,EAAC;EACjC,MAAK;IAAChB,IAAI;IAACC,GAAG;IAACC,KAAK;IAACC,IAAI;AAACqB,IAAAA;AAAG,GAAC,GAACT,WAAW,CAACC,KAAK,CAAC;EACjD,MAAMC,KAAK,GAAC,EAAE;EACd,IAAGjB,IAAI,EAACiB,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACC,IAAI,CAAC;EAAC,IAAGC,GAAG,EAACgB,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACE,GAAG,CAAC;EAC/D,IAAGC,KAAK,EAACe,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACG,KAAK,CAAC;EAAC,IAAGC,IAAI,EAACc,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACI,IAAI,CAAC;EACnE,MAAM0B,OAAO,GAACzB,OAAO,CAACoB,GAAG,CAAC,IAAEA,GAAG,CAACM,WAAW,EAAE;AAACb,EAAAA,KAAK,CAACW,IAAI,CAACC,OAAO,CAAC;AACjE,EAAA,OAAOlC,KAAK,GAACsB,KAAK,CAACc,IAAI,CAAC,EAAE,CAAC,GAACd,KAAK,CAACc,IAAI,CAAC,KAAK,CAAC;AAC/C;AAEO,SAASC,cAAcA,CAACC,EAAE,EAAC;AAChC,EAAA,IAAG,CAACA,EAAE,EAAC,OAAO,KAAK;AACnB,EAAA,MAAMC,GAAG,GAACD,EAAE,CAACE,OAAO;AACpB,EAAA,OAAOD,GAAG,KAAG,OAAO,IAAEA,GAAG,KAAG,UAAU,IAAEA,GAAG,KAAG,QAAQ,IAAED,EAAE,CAACG,iBAAiB;AAC9E;;AC/BO,SAASC,SAASA,CAACrB,KAAK,EAACsB,QAAQ,EAACC,IAAI,GAAC,EAAE,EAAC;EAC/C,MAAK;AAACC,IAAAA,OAAO,GAAC,IAAI;AAACC,IAAAA,cAAc,GAAC,IAAI;AAACC,IAAAA,WAAW,GAAC;AAAI,GAAC,GAACH,IAAI;AAC7D,EAAA,MAAMI,MAAM,GAAC5B,WAAW,CAACC,KAAK,CAAC;AAC/B,EAAA,MAAM4B,OAAO,GAACC,iBAAW,CAACC,CAAC,IAAE;IAAC,IAAG,CAACN,OAAO,EAAC;IACxC,IAAGE,WAAW,IAAEV,cAAc,CAACc,CAAC,CAACC,MAAM,CAAC,EAAC;IACzC,MAAMC,KAAK,GAACF,CAAC,CAACtB,GAAG,CAACN,WAAW,EAAE,KAAGyB,MAAM,CAACnB,GAAG,IAAEsB,CAAC,CAACG,OAAO,KAAGN,MAAM,CAAC3C,IAAI,IAAE8C,CAAC,CAACI,MAAM,KAAGP,MAAM,CAAC1C,GAAG,IAAE6C,CAAC,CAACK,QAAQ,KAAGR,MAAM,CAACzC,KAAK,IAAE4C,CAAC,CAACM,OAAO,KAAGT,MAAM,CAACxC,IAAI;AAChJ,IAAA,IAAG6C,KAAK,EAAC;AAAC,MAAA,IAAGP,cAAc,EAACK,CAAC,CAACL,cAAc,EAAE;MAACH,QAAQ,CAACQ,CAAC,CAAC;AAAC,IAAA;AAC7D,EAAA,CAAC,EAAC,CAAC9B,KAAK,EAACsB,QAAQ,EAACE,OAAO,EAACC,cAAc,EAACC,WAAW,CAAC,CAAC;AACtDW,EAAAA,eAAS,CAAC,MAAI;AAACC,IAAAA,QAAQ,CAACC,gBAAgB,CAAC,SAAS,EAACX,OAAO,CAAC;IAAC,OAAM,MAAIU,QAAQ,CAACE,mBAAmB,CAAC,SAAS,EAACZ,OAAO,CAAC;AAAC,EAAA,CAAC,EAAC,CAACA,OAAO,CAAC,CAAC;AACpI;;ACVO,SAASa,UAAUA,CAACC,QAAQ,GAAC,EAAE,EAACnB,IAAI,GAAC,EAAE,EAAC;EAC7CmB,QAAQ,CAACjC,OAAO,CAAC,CAAC;IAACT,KAAK;AAAC4B,IAAAA;GAAQ,KAAGP,SAAS,CAACrB,KAAK,EAAC4B,OAAO,EAACL,IAAI,CAAC,CAAC;AACpE;;ACDO,SAASoB,aAAaA,CAAC;EAAC3C,KAAK;AAAC4C,EAAAA,IAAI,GAAC,OAAO;AAACC,EAAAA,SAAS,GAAC;AAAE,CAAC,EAAC;AAC9D,EAAA,MAAMhC,OAAO,GAACF,YAAY,CAACX,KAAK,CAAC;AACjC,EAAA,MAAM8C,EAAE,GAAC;AAACC,IAAAA,KAAK,EAAC;AAACC,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;KAAU;AAACC,IAAAA,MAAM,EAAC;AAACF,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;KAAU;AAACE,IAAAA,KAAK,EAAC;AAACH,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;AAAS;GAAE;EACrG,MAAM5C,CAAC,GAACyC,EAAE,CAACF,IAAI,CAAC,IAAEE,EAAE,CAACC,KAAK;EAC1B,oBAAOK,KAAA,CAAAC,aAAA,CAAA,KAAA,EAAA;IAAKR,SAAS,EAAE,CAAA,QAAA,EAAWA,SAAS,CAAA,CAAG;AAC5CS,IAAAA,KAAK,EAAE;AAACzC,MAAAA,OAAO,EAAC,aAAa;AAAC0C,MAAAA,GAAG,EAAC,CAAC;MAACC,QAAQ,EAACnD,CAAC,CAAC2C,IAAI;AAACS,MAAAA,UAAU,EAAC,yBAAyB;MAACC,OAAO,EAACrD,CAAC,CAAC4C,GAAG;AACpGU,MAAAA,YAAY,EAAC,CAAC;AAACC,MAAAA,UAAU,EAAC,wBAAwB;AAACC,MAAAA,KAAK,EAAC,SAAS;AAACC,MAAAA,MAAM,EAAC,kCAAkC;AAC5GC,MAAAA,UAAU,EAAC,GAAG;AAACC,MAAAA,UAAU,EAAC;AAAG;AAAE,GAAA,EAAEnD,OAAa,CAAC;AACrD;;;;;;;;;"}
@@ -0,0 +1,135 @@
1
+ import React, { useCallback, useEffect } from 'react';
2
+
3
+ /**
4
+ * 快捷键解析/格式化工具
5
+ */
6
+ const isMac = typeof navigator !== 'undefined' && /Mac|iPhone|iPad/.test(navigator.platform);
7
+ const MOD_MAP = {
8
+ ctrl: isMac ? '⌃' : 'Ctrl',
9
+ alt: isMac ? '⌥' : 'Alt',
10
+ shift: isMac ? '⇧' : 'Shift',
11
+ meta: isMac ? '⌘' : 'Win'};
12
+ const KEY_MAP = {
13
+ arrowup: '↑',
14
+ arrowdown: '↓',
15
+ arrowleft: '←',
16
+ arrowright: '→',
17
+ escape: 'Esc',
18
+ enter: '↩',
19
+ backspace: '⌫',
20
+ delete: '⌦',
21
+ tab: '⇥',
22
+ space: 'Space'
23
+ };
24
+ function parseHotkey(combo) {
25
+ const parts = combo.toLowerCase().split('+').map(s => s.trim());
26
+ const mods = {
27
+ ctrl: false,
28
+ alt: false,
29
+ shift: false,
30
+ meta: false
31
+ };
32
+ let key = '';
33
+ parts.forEach(p => {
34
+ if (p === 'ctrl' || p === 'control') mods.ctrl = true;else if (p === 'alt' || p === 'option') mods.alt = true;else if (p === 'shift') mods.shift = true;else if (p === 'meta' || p === 'cmd' || p === 'command' || p === 'win') mods.meta = true;else if (p === 'mod') {
35
+ if (isMac) mods.meta = true;else mods.ctrl = true;
36
+ } else key = p;
37
+ });
38
+ return {
39
+ ...mods,
40
+ key
41
+ };
42
+ }
43
+ function formatHotkey(combo) {
44
+ const {
45
+ ctrl,
46
+ alt,
47
+ shift,
48
+ meta,
49
+ key
50
+ } = parseHotkey(combo);
51
+ const parts = [];
52
+ if (ctrl) parts.push(MOD_MAP.ctrl);
53
+ if (alt) parts.push(MOD_MAP.alt);
54
+ if (shift) parts.push(MOD_MAP.shift);
55
+ if (meta) parts.push(MOD_MAP.meta);
56
+ const display = KEY_MAP[key] || key.toUpperCase();
57
+ parts.push(display);
58
+ return isMac ? parts.join('') : parts.join(' + ');
59
+ }
60
+ function isInputElement(el) {
61
+ if (!el) return false;
62
+ const tag = el.tagName;
63
+ return tag === 'INPUT' || tag === 'TEXTAREA' || tag === 'SELECT' || el.isContentEditable;
64
+ }
65
+
66
+ function useHotkey(combo, callback, opts = {}) {
67
+ const {
68
+ enabled = true,
69
+ preventDefault = true,
70
+ ignoreInput = true
71
+ } = opts;
72
+ const parsed = parseHotkey(combo);
73
+ const handler = useCallback(e => {
74
+ if (!enabled) return;
75
+ if (ignoreInput && isInputElement(e.target)) return;
76
+ const match = e.key.toLowerCase() === parsed.key && e.ctrlKey === parsed.ctrl && e.altKey === parsed.alt && e.shiftKey === parsed.shift && e.metaKey === parsed.meta;
77
+ if (match) {
78
+ if (preventDefault) e.preventDefault();
79
+ callback(e);
80
+ }
81
+ }, [combo, callback, enabled, preventDefault, ignoreInput]);
82
+ useEffect(() => {
83
+ document.addEventListener('keydown', handler);
84
+ return () => document.removeEventListener('keydown', handler);
85
+ }, [handler]);
86
+ }
87
+
88
+ function useHotkeys(bindings = [], opts = {}) {
89
+ bindings.forEach(({
90
+ combo,
91
+ handler
92
+ }) => useHotkey(combo, handler, opts));
93
+ }
94
+
95
+ function HotkeyDisplay({
96
+ combo,
97
+ size = 'small',
98
+ className = ''
99
+ }) {
100
+ const display = formatHotkey(combo);
101
+ const sz = {
102
+ small: {
103
+ font: 11,
104
+ pad: '2px 5px'
105
+ },
106
+ medium: {
107
+ font: 12,
108
+ pad: '3px 7px'
109
+ },
110
+ large: {
111
+ font: 13,
112
+ pad: '4px 8px'
113
+ }
114
+ };
115
+ const s = sz[size] || sz.small;
116
+ return /*#__PURE__*/React.createElement("kbd", {
117
+ className: `qhk-key ${className}`,
118
+ style: {
119
+ display: 'inline-flex',
120
+ gap: 2,
121
+ fontSize: s.font,
122
+ fontFamily: 'SF Mono,Menlo,monospace',
123
+ padding: s.pad,
124
+ borderRadius: 4,
125
+ background: 'rgba(128,128,128,0.08)',
126
+ color: '#71717a',
127
+ border: '1px solid rgba(128,128,128,0.12)',
128
+ lineHeight: 1.2,
129
+ fontWeight: 500
130
+ }
131
+ }, display);
132
+ }
133
+
134
+ export { HotkeyDisplay, formatHotkey, isInputElement, parseHotkey, useHotkey, useHotkeys };
135
+ //# sourceMappingURL=index.esm.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.esm.js","sources":["../src/utils/hotkey.js","../src/hooks/useHotkey.js","../src/hooks/useHotkeys.js","../src/components/HotkeyDisplay.jsx"],"sourcesContent":["/**\n * 快捷键解析/格式化工具\n */\nconst isMac=typeof navigator!=='undefined'&&/Mac|iPhone|iPad/.test(navigator.platform);\nconst MOD_MAP={ctrl:isMac?'⌃':'Ctrl',alt:isMac?'⌥':'Alt',shift:isMac?'⇧':'Shift',meta:isMac?'⌘':'Win',mod:isMac?'⌘':'Ctrl'};\nconst KEY_MAP={arrowup:'↑',arrowdown:'↓',arrowleft:'←',arrowright:'→',escape:'Esc',enter:'↩',backspace:'⌫',delete:'⌦',tab:'⇥',space:'Space'};\n\nexport function parseHotkey(combo){\n const parts=combo.toLowerCase().split('+').map(s=>s.trim());\n const mods={ctrl:false,alt:false,shift:false,meta:false};\n let key='';\n parts.forEach(p=>{if(p==='ctrl'||p==='control')mods.ctrl=true;\n else if(p==='alt'||p==='option')mods.alt=true;\n else if(p==='shift')mods.shift=true;\n else if(p==='meta'||p==='cmd'||p==='command'||p==='win')mods.meta=true;\n else if(p==='mod'){if(isMac)mods.meta=true;else mods.ctrl=true;}\n else key=p;});\n return{...mods,key};\n}\n\nexport function formatHotkey(combo){\n const{ctrl,alt,shift,meta,key}=parseHotkey(combo);\n const parts=[];\n if(ctrl)parts.push(MOD_MAP.ctrl);if(alt)parts.push(MOD_MAP.alt);\n if(shift)parts.push(MOD_MAP.shift);if(meta)parts.push(MOD_MAP.meta);\n const display=KEY_MAP[key]||key.toUpperCase();parts.push(display);\n return isMac?parts.join(''):parts.join(' + ');\n}\n\nexport function isInputElement(el){\n if(!el)return false;\n const tag=el.tagName;\n return tag==='INPUT'||tag==='TEXTAREA'||tag==='SELECT'||el.isContentEditable;\n}\n","import{useEffect,useCallback}from'react';\nimport{parseHotkey,isInputElement}from'../utils/hotkey';\nexport function useHotkey(combo,callback,opts={}){\n const{enabled=true,preventDefault=true,ignoreInput=true}=opts;\n const parsed=parseHotkey(combo);\n const handler=useCallback(e=>{if(!enabled)return;\n if(ignoreInput&&isInputElement(e.target))return;\n const match=e.key.toLowerCase()===parsed.key&&e.ctrlKey===parsed.ctrl&&e.altKey===parsed.alt&&e.shiftKey===parsed.shift&&e.metaKey===parsed.meta;\n if(match){if(preventDefault)e.preventDefault();callback(e);}\n },[combo,callback,enabled,preventDefault,ignoreInput]);\n useEffect(()=>{document.addEventListener('keydown',handler);return()=>document.removeEventListener('keydown',handler);},[handler]);\n}\n","import{useHotkey}from'./useHotkey';\nexport function useHotkeys(bindings=[],opts={}){\n bindings.forEach(({combo,handler})=>useHotkey(combo,handler,opts));\n}\n","import React from'react';\nimport{formatHotkey}from'../utils/hotkey';\nexport function HotkeyDisplay({combo,size='small',className=''}){\n const display=formatHotkey(combo);\n const sz={small:{font:11,pad:'2px 5px'},medium:{font:12,pad:'3px 7px'},large:{font:13,pad:'4px 8px'}};\n const s=sz[size]||sz.small;\n return(<kbd className={`qhk-key ${className}`}\n style={{display:'inline-flex',gap:2,fontSize:s.font,fontFamily:'SF Mono,Menlo,monospace',padding:s.pad,\n borderRadius:4,background:'rgba(128,128,128,0.08)',color:'#71717a',border:'1px solid rgba(128,128,128,0.12)',\n lineHeight:1.2,fontWeight:500}}>{display}</kbd>);\n}\n"],"names":["isMac","navigator","test","platform","MOD_MAP","ctrl","alt","shift","meta","KEY_MAP","arrowup","arrowdown","arrowleft","arrowright","escape","enter","backspace","delete","tab","space","parseHotkey","combo","parts","toLowerCase","split","map","s","trim","mods","key","forEach","p","formatHotkey","push","display","toUpperCase","join","isInputElement","el","tag","tagName","isContentEditable","useHotkey","callback","opts","enabled","preventDefault","ignoreInput","parsed","handler","useCallback","e","target","match","ctrlKey","altKey","shiftKey","metaKey","useEffect","document","addEventListener","removeEventListener","useHotkeys","bindings","HotkeyDisplay","size","className","sz","small","font","pad","medium","large","React","createElement","style","gap","fontSize","fontFamily","padding","borderRadius","background","color","border","lineHeight","fontWeight"],"mappings":";;AAAA;AACA;AACA;AACA,MAAMA,KAAK,GAAC,OAAOC,SAAS,KAAG,WAAW,IAAE,iBAAiB,CAACC,IAAI,CAACD,SAAS,CAACE,QAAQ,CAAC;AACtF,MAAMC,OAAO,GAAC;AAACC,EAAAA,IAAI,EAACL,KAAK,GAAC,GAAG,GAAC,MAAM;AAACM,EAAAA,GAAG,EAACN,KAAK,GAAC,GAAG,GAAC,KAAK;AAACO,EAAAA,KAAK,EAACP,KAAK,GAAC,GAAG,GAAC,OAAO;AAACQ,EAAAA,IAAI,EAACR,KAAK,GAAC,GAAG,GAAC,KAA0B,CAAC;AAC3H,MAAMS,OAAO,GAAC;AAACC,EAAAA,OAAO,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,UAAU,EAAC,GAAG;AAACC,EAAAA,MAAM,EAAC,KAAK;AAACC,EAAAA,KAAK,EAAC,GAAG;AAACC,EAAAA,SAAS,EAAC,GAAG;AAACC,EAAAA,MAAM,EAAC,GAAG;AAACC,EAAAA,GAAG,EAAC,GAAG;AAACC,EAAAA,KAAK,EAAC;AAAO,CAAC;AAErI,SAASC,WAAWA,CAACC,KAAK,EAAC;EAChC,MAAMC,KAAK,GAACD,KAAK,CAACE,WAAW,EAAE,CAACC,KAAK,CAAC,GAAG,CAAC,CAACC,GAAG,CAACC,CAAC,IAAEA,CAAC,CAACC,IAAI,EAAE,CAAC;AAC3D,EAAA,MAAMC,IAAI,GAAC;AAACvB,IAAAA,IAAI,EAAC,KAAK;AAACC,IAAAA,GAAG,EAAC,KAAK;AAACC,IAAAA,KAAK,EAAC,KAAK;AAACC,IAAAA,IAAI,EAAC;GAAM;EACxD,IAAIqB,GAAG,GAAC,EAAE;AACVP,EAAAA,KAAK,CAACQ,OAAO,CAACC,CAAC,IAAE;AAAC,IAAA,IAAGA,CAAC,KAAG,MAAM,IAAEA,CAAC,KAAG,SAAS,EAACH,IAAI,CAACvB,IAAI,GAAC,IAAI,CAAC,KACvD,IAAG0B,CAAC,KAAG,KAAK,IAAEA,CAAC,KAAG,QAAQ,EAACH,IAAI,CAACtB,GAAG,GAAC,IAAI,CAAC,KACzC,IAAGyB,CAAC,KAAG,OAAO,EAACH,IAAI,CAACrB,KAAK,GAAC,IAAI,CAAC,KAC/B,IAAGwB,CAAC,KAAG,MAAM,IAAEA,CAAC,KAAG,KAAK,IAAEA,CAAC,KAAG,SAAS,IAAEA,CAAC,KAAG,KAAK,EAACH,IAAI,CAACpB,IAAI,GAAC,IAAI,CAAC,KAClE,IAAGuB,CAAC,KAAG,KAAK,EAAC;AAAC,MAAA,IAAG/B,KAAK,EAAC4B,IAAI,CAACpB,IAAI,GAAC,IAAI,CAAC,KAAKoB,IAAI,CAACvB,IAAI,GAAC,IAAI;IAAC,CAAC,MAC3DwB,GAAG,GAACE,CAAC;AAAC,EAAA,CAAC,CAAC;EACf,OAAM;AAAC,IAAA,GAAGH,IAAI;AAACC,IAAAA;GAAI;AACrB;AAEO,SAASG,YAAYA,CAACX,KAAK,EAAC;EACjC,MAAK;IAAChB,IAAI;IAACC,GAAG;IAACC,KAAK;IAACC,IAAI;AAACqB,IAAAA;AAAG,GAAC,GAACT,WAAW,CAACC,KAAK,CAAC;EACjD,MAAMC,KAAK,GAAC,EAAE;EACd,IAAGjB,IAAI,EAACiB,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACC,IAAI,CAAC;EAAC,IAAGC,GAAG,EAACgB,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACE,GAAG,CAAC;EAC/D,IAAGC,KAAK,EAACe,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACG,KAAK,CAAC;EAAC,IAAGC,IAAI,EAACc,KAAK,CAACW,IAAI,CAAC7B,OAAO,CAACI,IAAI,CAAC;EACnE,MAAM0B,OAAO,GAACzB,OAAO,CAACoB,GAAG,CAAC,IAAEA,GAAG,CAACM,WAAW,EAAE;AAACb,EAAAA,KAAK,CAACW,IAAI,CAACC,OAAO,CAAC;AACjE,EAAA,OAAOlC,KAAK,GAACsB,KAAK,CAACc,IAAI,CAAC,EAAE,CAAC,GAACd,KAAK,CAACc,IAAI,CAAC,KAAK,CAAC;AAC/C;AAEO,SAASC,cAAcA,CAACC,EAAE,EAAC;AAChC,EAAA,IAAG,CAACA,EAAE,EAAC,OAAO,KAAK;AACnB,EAAA,MAAMC,GAAG,GAACD,EAAE,CAACE,OAAO;AACpB,EAAA,OAAOD,GAAG,KAAG,OAAO,IAAEA,GAAG,KAAG,UAAU,IAAEA,GAAG,KAAG,QAAQ,IAAED,EAAE,CAACG,iBAAiB;AAC9E;;AC/BO,SAASC,SAASA,CAACrB,KAAK,EAACsB,QAAQ,EAACC,IAAI,GAAC,EAAE,EAAC;EAC/C,MAAK;AAACC,IAAAA,OAAO,GAAC,IAAI;AAACC,IAAAA,cAAc,GAAC,IAAI;AAACC,IAAAA,WAAW,GAAC;AAAI,GAAC,GAACH,IAAI;AAC7D,EAAA,MAAMI,MAAM,GAAC5B,WAAW,CAACC,KAAK,CAAC;AAC/B,EAAA,MAAM4B,OAAO,GAACC,WAAW,CAACC,CAAC,IAAE;IAAC,IAAG,CAACN,OAAO,EAAC;IACxC,IAAGE,WAAW,IAAEV,cAAc,CAACc,CAAC,CAACC,MAAM,CAAC,EAAC;IACzC,MAAMC,KAAK,GAACF,CAAC,CAACtB,GAAG,CAACN,WAAW,EAAE,KAAGyB,MAAM,CAACnB,GAAG,IAAEsB,CAAC,CAACG,OAAO,KAAGN,MAAM,CAAC3C,IAAI,IAAE8C,CAAC,CAACI,MAAM,KAAGP,MAAM,CAAC1C,GAAG,IAAE6C,CAAC,CAACK,QAAQ,KAAGR,MAAM,CAACzC,KAAK,IAAE4C,CAAC,CAACM,OAAO,KAAGT,MAAM,CAACxC,IAAI;AAChJ,IAAA,IAAG6C,KAAK,EAAC;AAAC,MAAA,IAAGP,cAAc,EAACK,CAAC,CAACL,cAAc,EAAE;MAACH,QAAQ,CAACQ,CAAC,CAAC;AAAC,IAAA;AAC7D,EAAA,CAAC,EAAC,CAAC9B,KAAK,EAACsB,QAAQ,EAACE,OAAO,EAACC,cAAc,EAACC,WAAW,CAAC,CAAC;AACtDW,EAAAA,SAAS,CAAC,MAAI;AAACC,IAAAA,QAAQ,CAACC,gBAAgB,CAAC,SAAS,EAACX,OAAO,CAAC;IAAC,OAAM,MAAIU,QAAQ,CAACE,mBAAmB,CAAC,SAAS,EAACZ,OAAO,CAAC;AAAC,EAAA,CAAC,EAAC,CAACA,OAAO,CAAC,CAAC;AACpI;;ACVO,SAASa,UAAUA,CAACC,QAAQ,GAAC,EAAE,EAACnB,IAAI,GAAC,EAAE,EAAC;EAC7CmB,QAAQ,CAACjC,OAAO,CAAC,CAAC;IAACT,KAAK;AAAC4B,IAAAA;GAAQ,KAAGP,SAAS,CAACrB,KAAK,EAAC4B,OAAO,EAACL,IAAI,CAAC,CAAC;AACpE;;ACDO,SAASoB,aAAaA,CAAC;EAAC3C,KAAK;AAAC4C,EAAAA,IAAI,GAAC,OAAO;AAACC,EAAAA,SAAS,GAAC;AAAE,CAAC,EAAC;AAC9D,EAAA,MAAMhC,OAAO,GAACF,YAAY,CAACX,KAAK,CAAC;AACjC,EAAA,MAAM8C,EAAE,GAAC;AAACC,IAAAA,KAAK,EAAC;AAACC,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;KAAU;AAACC,IAAAA,MAAM,EAAC;AAACF,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;KAAU;AAACE,IAAAA,KAAK,EAAC;AAACH,MAAAA,IAAI,EAAC,EAAE;AAACC,MAAAA,GAAG,EAAC;AAAS;GAAE;EACrG,MAAM5C,CAAC,GAACyC,EAAE,CAACF,IAAI,CAAC,IAAEE,EAAE,CAACC,KAAK;EAC1B,oBAAOK,KAAA,CAAAC,aAAA,CAAA,KAAA,EAAA;IAAKR,SAAS,EAAE,CAAA,QAAA,EAAWA,SAAS,CAAA,CAAG;AAC5CS,IAAAA,KAAK,EAAE;AAACzC,MAAAA,OAAO,EAAC,aAAa;AAAC0C,MAAAA,GAAG,EAAC,CAAC;MAACC,QAAQ,EAACnD,CAAC,CAAC2C,IAAI;AAACS,MAAAA,UAAU,EAAC,yBAAyB;MAACC,OAAO,EAACrD,CAAC,CAAC4C,GAAG;AACpGU,MAAAA,YAAY,EAAC,CAAC;AAACC,MAAAA,UAAU,EAAC,wBAAwB;AAACC,MAAAA,KAAK,EAAC,SAAS;AAACC,MAAAA,MAAM,EAAC,kCAAkC;AAC5GC,MAAAA,UAAU,EAAC,GAAG;AAACC,MAAAA,UAAU,EAAC;AAAG;AAAE,GAAA,EAAEnD,OAAa,CAAC;AACrD;;;;"}
package/package.json ADDED
@@ -0,0 +1,67 @@
1
+ {
2
+ "name": "@quantabit/hotkey-sdk",
3
+ "version": "1.0.0",
4
+ "type": "module",
5
+ "description": "Keyboard shortcut and hotkey management",
6
+ "main": "dist/index.cjs",
7
+ "module": "dist/index.esm.js",
8
+ "types": "types/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "types": "./types/index.d.ts",
12
+ "import": "./dist/index.esm.js",
13
+ "require": "./dist/index.cjs"
14
+ }
15
+ },
16
+ "files": [
17
+ "dist",
18
+ "types",
19
+ "README.md",
20
+ "LICENSE"
21
+ ],
22
+ "scripts": {
23
+ "build": "rollup -c",
24
+ "dev": "rollup -c -w",
25
+ "test": "jest --passWithNoTests",
26
+ "prepublishOnly": "npm run build"
27
+ },
28
+ "repository": {
29
+ "type": "git",
30
+ "url": "https://github.com/quantabit-chain/qbit-sdk.git",
31
+ "directory": "packages/hotkey-sdk"
32
+ },
33
+ "keywords": [
34
+ "hotkey",
35
+ "keyboard",
36
+ "shortcut",
37
+ "react"
38
+ ],
39
+ "author": "QuantaBit Team",
40
+ "license": "MIT",
41
+ "engines": {
42
+ "node": ">=18.0.0"
43
+ },
44
+ "peerDependencies": {
45
+ "react": ">=17.0.0",
46
+ "react-dom": ">=17.0.0"
47
+ },
48
+ "dependencies": {
49
+ "@quantabit/sdk-config": "^1.0.6"
50
+ },
51
+ "publishConfig": {
52
+ "access": "public"
53
+ },
54
+ "homepage": "https://github.com/quantabit-chain/qbit-sdk/tree/main/packages/hotkey-sdk",
55
+ "bugs": {
56
+ "url": "https://github.com/quantabit-chain/qbit-sdk/issues"
57
+ },
58
+ "sideEffects": false,
59
+ "qbit": {
60
+ "privacy": {
61
+ "level": "functional",
62
+ "dataCollection": "Feature-related data for personalization. Requires user consent.",
63
+ "gdprCompliant": true,
64
+ "ccpaCompliant": true
65
+ }
66
+ }
67
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * @quantabit/hotkey-sdk TypeScript Type Definitions
3
+ *
4
+ * Auto-generated type stubs. Enhance with specific types as the SDK matures.
5
+ */
6
+
7
+ import { FC, ReactNode } from 'react';
8
+
9
+ // ============ Components ============
10
+
11
+ export interface HotkeyDisplayProps {
12
+ className?: string;
13
+ style?: React.CSSProperties;
14
+ [key: string]: any;
15
+ }
16
+
17
+ export declare const HotkeyDisplay: FC<HotkeyDisplayProps>;
18
+
19
+ // ============ Hooks ============
20
+
21
+ export interface UseHotkeyReturn {
22
+ data: any;
23
+ loading: boolean;
24
+ error: string | null;
25
+ [key: string]: any;
26
+ }
27
+
28
+ export declare function useHotkey(...args: any[]): UseHotkeyReturn;
29
+
30
+ export interface UseHotkeysReturn {
31
+ data: any;
32
+ loading: boolean;
33
+ error: string | null;
34
+ [key: string]: any;
35
+ }
36
+
37
+ export declare function useHotkeys(...args: any[]): UseHotkeysReturn;
38
+
39
+ // ============ Functions & Utilities ============
40
+
41
+ export declare function parseHotkey(...args: any[]): any;
42
+ export declare function formatHotkey(...args: any[]): any;
43
+ export declare function isInputElement(...args: any[]): any;
44
+