Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
keypress-tool
Advanced tools
keypress-tool - npm Package Compare versions
Comparing version 1.0.10 to 2.0.0
| // Place your settings in this file to overwrite default and user settings. | ||
| { | ||
| "files.exclude": { | ||
| "**/.git": true, | ||
| "**/.DS_Store": true, | ||
| "**/*.js": true | ||
| }, | ||
| "editor.tabSize": 2, | ||
| "editor.insertSpaces": true | ||
| "files.exclude": { | ||
| "**/.git": true, | ||
| "**/.DS_Store": true, | ||
| "**/*.js": true | ||
| }, | ||
| "editor.tabSize": 2, | ||
| "editor.insertSpaces": true, | ||
| "editor.detectIndentation": false | ||
| } |
@@ -5,3 +5,3 @@ /** | ||
| export function isInputElement(el: HTMLElement): boolean { | ||
| return el.tagName === 'INPUT' || | ||
| return el.tagName === 'INPUT' || | ||
| el.tagName === 'TEXTAREA' || | ||
@@ -8,0 +8,0 @@ el.tagName === 'SELECT' || |
@@ -7,56 +7,56 @@ import { isInputElement } from './DOMHelpers'; | ||
| export enum KeyCode { | ||
| Backspace = 8, | ||
| Tab = 9, | ||
| Clear = 12, | ||
| Enter = 13, | ||
| Return = 13, | ||
| Esc = 27, | ||
| Space = 32, | ||
| Left = 37, | ||
| Up = 38, | ||
| Right = 39, | ||
| Down = 40, | ||
| Del = 46, | ||
| Home = 36, | ||
| End = 35, | ||
| PageUp = 33, | ||
| PageDown = 34, | ||
| // TODO: F1-F12 | ||
| ',' = 188, | ||
| '.' = 190, | ||
| '/' = 191, | ||
| '`' = 192, | ||
| '-' = 189, | ||
| '=' = 187, | ||
| ';' = 186, | ||
| '\'' = 222, | ||
| '[' = 219, | ||
| ']' = 221, | ||
| '\\' = 220, | ||
| A = 65, | ||
| B = 66, | ||
| C = 67, | ||
| D = 68, | ||
| E = 69, | ||
| F = 70, | ||
| G = 71, | ||
| H = 72, | ||
| I = 73, | ||
| J = 74, | ||
| K = 75, | ||
| L = 76, | ||
| M = 77, | ||
| N = 78, | ||
| O = 79, | ||
| P = 80, | ||
| Q = 81, | ||
| R = 82, | ||
| S = 83, | ||
| T = 84, | ||
| U = 85, | ||
| V = 86, | ||
| W = 87, | ||
| X = 88, | ||
| Y = 89, | ||
| Z = 90, | ||
| Backspace = 8, | ||
| Tab = 9, | ||
| Clear = 12, | ||
| Enter = 13, | ||
| Return = 13, | ||
| Esc = 27, | ||
| Space = 32, | ||
| Left = 37, | ||
| Up = 38, | ||
| Right = 39, | ||
| Down = 40, | ||
| Del = 46, | ||
| Home = 36, | ||
| End = 35, | ||
| PageUp = 33, | ||
| PageDown = 34, | ||
| // TODO: F1-F12 | ||
| ',' = 188, | ||
| '.' = 190, | ||
| '/' = 191, | ||
| '`' = 192, | ||
| '-' = 189, | ||
| '=' = 187, | ||
| ';' = 186, | ||
| '\'' = 222, | ||
| '[' = 219, | ||
| ']' = 221, | ||
| '\\' = 220, | ||
| A = 65, | ||
| B = 66, | ||
| C = 67, | ||
| D = 68, | ||
| E = 69, | ||
| F = 70, | ||
| G = 71, | ||
| H = 72, | ||
| I = 73, | ||
| J = 74, | ||
| K = 75, | ||
| L = 76, | ||
| M = 77, | ||
| N = 78, | ||
| O = 79, | ||
| P = 80, | ||
| Q = 81, | ||
| R = 82, | ||
| S = 83, | ||
| T = 84, | ||
| U = 85, | ||
| V = 86, | ||
| W = 87, | ||
| X = 88, | ||
| Y = 89, | ||
| Z = 90, | ||
| } | ||
@@ -67,4 +67,4 @@ | ||
| interface IListener { | ||
| (ev: Event): void; | ||
| inputEl?: boolean; | ||
| (ev: Event): void; | ||
| inputEl?: boolean; | ||
| } | ||
@@ -90,71 +90,71 @@ | ||
| listeners: IListener[] = []; | ||
| keyName: keyof typeof KeyCode; | ||
| keyCode: KeyCode; | ||
| options: Set<option>; | ||
| preventDefault: boolean; | ||
| listeners: IListener[] = []; | ||
| keyName: keyof typeof KeyCode; | ||
| keyCode: KeyCode; | ||
| options: Set<option>; | ||
| preventDefault: boolean; | ||
| constructor(char: keyof typeof KeyCode, options: Set<option>) { | ||
| this.keyName = char; | ||
| this.keyCode = KeyCode[char]; | ||
| this.options = options; | ||
| this.preventDefault = !options.has('executeDefault'); | ||
| } | ||
| constructor(char: keyof typeof KeyCode, options: Set<option>) { | ||
| this.keyName = char; | ||
| this.keyCode = KeyCode[char]; | ||
| this.options = options; | ||
| this.preventDefault = !options.has('executeDefault'); | ||
| } | ||
| addListener(listener: IListener, inputEl?: boolean) { | ||
| if (this.listeners.indexOf(listener) > -1) { | ||
| throw new Error('This listener is already listening. You might have a memory leak in your code.'); | ||
| } | ||
| addListener(listener: IListener, inputEl?: boolean) { | ||
| if (this.listeners.indexOf(listener) > -1) { | ||
| throw new Error('This listener is already listening. You might have a memory leak in your code.'); | ||
| } | ||
| // Save inputEl boolean on the function | ||
| if (inputEl != null) { | ||
| listener.inputEl = inputEl; | ||
| } | ||
| // Save inputEl boolean on the function | ||
| if (inputEl != null) { | ||
| listener.inputEl = inputEl; | ||
| } | ||
| // Save listener | ||
| this.listeners.push(listener); | ||
| } | ||
| // Save listener | ||
| this.listeners.push(listener); | ||
| } | ||
| removeListener(listener: IListener) { | ||
| let index = this.listeners.indexOf(listener); | ||
| if (index === -1) { | ||
| return; | ||
| } | ||
| removeListener(listener: IListener) { | ||
| let index = this.listeners.indexOf(listener); | ||
| if (index === -1) { | ||
| return; | ||
| } | ||
| // Remove listener | ||
| this.listeners.splice(index, 1); | ||
| } | ||
| // Remove listener | ||
| this.listeners.splice(index, 1); | ||
| } | ||
| toString() { | ||
| let m = this.options; | ||
| if (isMac) { | ||
| return (m.has('ctrl') ? '⌃' : '') + | ||
| (m.has('alt') ? '⌥' : '') + | ||
| (m.has('shift') ? '⇧' : '') + | ||
| (m.has('meta') ? '⌘' : '') + | ||
| this.keyName; | ||
| } else { | ||
| return (m.has('meta') ? 'Win+' : '') + | ||
| (m.has('ctrl') ? 'Ctrl+' : '') + | ||
| (m.has('alt') ? 'Alt+' : '') + | ||
| (m.has('shift') ? 'Shift+' : '') + | ||
| this.keyName; | ||
| } | ||
| } | ||
| toString() { | ||
| let m = this.options; | ||
| if (isMac) { | ||
| return (m.has('ctrl') ? '⌃' : '') + | ||
| (m.has('alt') ? '⌥' : '') + | ||
| (m.has('shift') ? '⇧' : '') + | ||
| (m.has('meta') ? '⌘' : '') + | ||
| this.keyName; | ||
| } else { | ||
| return (m.has('meta') ? 'Win+' : '') + | ||
| (m.has('ctrl') ? 'Ctrl+' : '') + | ||
| (m.has('alt') ? 'Alt+' : '') + | ||
| (m.has('shift') ? 'Shift+' : '') + | ||
| this.keyName; | ||
| } | ||
| } | ||
| static hashCode(keyCode: KeyCode, options: Set<option>) { | ||
| return keyCode + '-' + | ||
| (options.has('ctrl') ? '1' : '0') + | ||
| (options.has('meta') ? '1' : '0') + | ||
| (options.has('shift') ? '1' : '0') + | ||
| (options.has('alt') ? '1' : '0'); | ||
| } | ||
| static hashCode(keyCode: KeyCode, options: Set<option>) { | ||
| return keyCode + '-' + | ||
| (options.has('ctrl') ? '1' : '0') + | ||
| (options.has('meta') ? '1' : '0') + | ||
| (options.has('shift') ? '1' : '0') + | ||
| (options.has('alt') ? '1' : '0'); | ||
| } | ||
| static hashCodeFromEvent(ev: KeyboardEvent) { | ||
| return ev.keyCode + '-' + | ||
| (ev.ctrlKey ? '1' : '0') + | ||
| (ev.metaKey ? '1' : '0') + | ||
| (ev.shiftKey ? '1' : '0') + | ||
| (ev.altKey ? '1' : '0'); | ||
| } | ||
| static hashCodeFromEvent(ev: KeyboardEvent) { | ||
| return ev.keyCode + '-' + | ||
| (ev.ctrlKey ? '1' : '0') + | ||
| (ev.metaKey ? '1' : '0') + | ||
| (ev.shiftKey ? '1' : '0') + | ||
| (ev.altKey ? '1' : '0'); | ||
| } | ||
@@ -167,57 +167,57 @@ } | ||
| export default function KeyPress(char: keyof typeof KeyCode, ...options: option[]) { | ||
| let m = new Set(options); | ||
| let m = new Set(options); | ||
| // Do some processing for OS X | ||
| if (isMac && m.has('ctrl')) { | ||
| m.delete('ctrl'); | ||
| m.add('meta'); | ||
| } | ||
| if (m.has('macctrl')) { | ||
| m.add('ctrl'); | ||
| } | ||
| // Do some processing for OS X | ||
| if (isMac && m.has('ctrl')) { | ||
| m.delete('ctrl'); | ||
| m.add('meta'); | ||
| } | ||
| if (m.has('macctrl')) { | ||
| m.add('ctrl'); | ||
| } | ||
| // Compute hash for this key combination | ||
| let hashCode = ListenerBucket.hashCode(KeyCode[char], m); | ||
| let bucket = buckets[hashCode]; | ||
| if (bucket == null) { | ||
| bucket = buckets[hashCode] = new ListenerBucket(char, m); | ||
| } else { | ||
| // Update preventDefault, because only one of them is possible | ||
| bucket.preventDefault = !m.has('executeDefault'); | ||
| } | ||
| // Compute hash for this key combination | ||
| let hashCode = ListenerBucket.hashCode(KeyCode[char], m); | ||
| let bucket = buckets[hashCode]; | ||
| if (bucket == null) { | ||
| bucket = buckets[hashCode] = new ListenerBucket(char, m); | ||
| } else { | ||
| // Update preventDefault, because only one of them is possible | ||
| bucket.preventDefault = !m.has('executeDefault'); | ||
| } | ||
| return bucket; | ||
| return bucket; | ||
| } | ||
| function handleKey(this: Window, ev: KeyboardEvent) { | ||
| let hash = ListenerBucket.hashCodeFromEvent(ev); | ||
| let bucket = buckets[hash]; | ||
| if (bucket == null || bucket.listeners.length === 0) { | ||
| return; | ||
| } | ||
| let el = ev.currentTarget as HTMLElement; | ||
| let listeners = bucket.listeners.filter(lnr => lnr.inputEl || !isInputElement(el)); | ||
| if (listeners.length === 0) { | ||
| return; | ||
| } | ||
| let hash = ListenerBucket.hashCodeFromEvent(ev); | ||
| let bucket = buckets[hash]; | ||
| if (bucket == null || bucket.listeners.length === 0) { | ||
| return; | ||
| } | ||
| let el = ev.currentTarget as HTMLElement; | ||
| let listeners = bucket.listeners.filter(lnr => lnr.inputEl || !isInputElement(el)); | ||
| if (listeners.length === 0) { | ||
| return; | ||
| } | ||
| if (bucket.preventDefault) { | ||
| ev.stopPropagation(); | ||
| ev.preventDefault(); | ||
| } | ||
| for (let listener of listeners) { | ||
| listener.call(this, ev); | ||
| } | ||
| if (bucket.preventDefault) { | ||
| ev.stopPropagation(); | ||
| ev.preventDefault(); | ||
| } | ||
| for (let listener of listeners) { | ||
| listener.call(this, ev); | ||
| } | ||
| } | ||
| export function enable() { | ||
| if (!isBrowser) { return; } | ||
| addEventListener('keydown', handleKey); | ||
| if (!isBrowser) { return; } | ||
| addEventListener('keydown', handleKey); | ||
| } | ||
| export function disable() { | ||
| if (!isBrowser) { return; } | ||
| removeEventListener('keydown', handleKey); | ||
| if (!isBrowser) { return; } | ||
| removeEventListener('keydown', handleKey); | ||
| } | ||
@@ -224,0 +224,0 @@ |
| { | ||
| "name": "keypress-tool", | ||
| "version": "1.0.10", | ||
| "version": "2.0.0", | ||
| "description": "Create custom keyboard shortcuts (in the browser)", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
@@ -20,3 +20,3 @@ # keypress-tool | ||
| KeyPress('A', 'shift').addListener(ev => { | ||
| console.log('Key combination pressed'); | ||
| console.log('Key combination pressed'); | ||
| }); | ||
@@ -28,3 +28,3 @@ | ||
| function handleEvent(event) { | ||
| console.log('Key combination pressed'); | ||
| console.log('Key combination pressed'); | ||
| } | ||
@@ -46,3 +46,3 @@ | ||
| Tab, Enter, Space, Left, Up, Right, Down, ; = , - . / \` \[ \] ' | ||
| Tab, Enter, Space, Left, Up, Right, Down, ; = , - . / \` \[ \] ' | ||
@@ -49,0 +49,0 @@ See also: |
| import KeyPress from '../keypress-tool'; | ||
| describe('KeyPress wrapper', () => { | ||
| it('returns same bucket with same options', () => { | ||
| let a = KeyPress('A', 'ctrl'); | ||
| let b = KeyPress('A', 'ctrl'); | ||
| expect(a).toBe(b); | ||
| }); | ||
| it('can add listeners', () => { | ||
| let a = KeyPress('A', 'ctrl'); | ||
| a.addListener(function() { | ||
| console.log('Success'); | ||
| }); | ||
| expect(a.listeners.length).toBe(1); | ||
| }); | ||
| it('returns same bucket with same options', () => { | ||
| let a = KeyPress('A', 'ctrl'); | ||
| let b = KeyPress('A', 'ctrl'); | ||
| expect(a).toBe(b); | ||
| }); | ||
| it('can add listeners', () => { | ||
| let a = KeyPress('A', 'ctrl'); | ||
| a.addListener(function() { | ||
| console.log('Success'); | ||
| }); | ||
| expect(a.listeners.length).toBe(1); | ||
| }); | ||
| }); |
| { | ||
| "compilerOptions": { | ||
| "lib": [ | ||
| "es2015", "dom" | ||
| ], | ||
| "strict": true, | ||
| "noImplicitAny": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "types": [] | ||
| }, | ||
| "include": [ | ||
| "*.ts" | ||
| ] | ||
| "compilerOptions": { | ||
| "lib": [ | ||
| "es2015", "dom" | ||
| ], | ||
| "strict": true, | ||
| "noImplicitAny": true, | ||
| "noUnusedLocals": true, | ||
| "noUnusedParameters": true, | ||
| "types": [] | ||
| }, | ||
| "include": [ | ||
| "*.ts" | ||
| ] | ||
| } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.53%
17031
- Lines of code
- increased by0.2%
497
Worsened metrics
- Number of package files
- decreased by-6.67%
14
No dependency changes