UNPKG

rx-hotkeys

Version:

Advanced Keyboard Shortcut Management library using rxjs

161 lines 4.89 kB
/** * Provides a set of common, standard string values for `KeyboardEvent.key`. * Using these values can help avoid typos and ensure consistency. * These are based on the MDN documentation: * https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_key_values * * All shortcut configurations should use values from this object. */ export declare const Keys: { readonly Unidentified: "Unidentified"; readonly Alt: "Alt"; readonly AltGraph: "AltGraph"; readonly CapsLock: "CapsLock"; readonly Control: "Control"; readonly Fn: "Fn"; readonly FnLock: "FnLock"; readonly Hyper: "Hyper"; readonly Meta: "Meta"; readonly NumLock: "NumLock"; readonly ScrollLock: "ScrollLock"; readonly Shift: "Shift"; readonly Super: "Super"; readonly Symbol: "Symbol"; readonly SymbolLock: "SymbolLock"; readonly Enter: "Enter"; readonly Tab: "Tab"; readonly Space: " "; readonly ArrowDown: "ArrowDown"; readonly ArrowLeft: "ArrowLeft"; readonly ArrowRight: "ArrowRight"; readonly ArrowUp: "ArrowUp"; readonly End: "End"; readonly Home: "Home"; readonly PageDown: "PageDown"; readonly PageUp: "PageUp"; readonly Backspace: "Backspace"; readonly Clear: "Clear"; readonly Copy: "Copy"; readonly CrSel: "CrSel"; readonly Cut: "Cut"; readonly Delete: "Delete"; readonly EraseEof: "EraseEof"; readonly ExSel: "ExSel"; readonly Insert: "Insert"; readonly Paste: "Paste"; readonly Redo: "Redo"; readonly Undo: "Undo"; readonly Accept: "Accept"; readonly Again: "Again"; readonly Attn: "Attn"; readonly Cancel: "Cancel"; readonly ContextMenu: "ContextMenu"; readonly Escape: "Escape"; readonly Execute: "Execute"; readonly Find: "Find"; readonly Finish: "Finish"; readonly Help: "Help"; readonly Pause: "Pause"; readonly Play: "Play"; readonly Props: "Props"; readonly Select: "Select"; readonly ZoomIn: "ZoomIn"; readonly ZoomOut: "ZoomOut"; readonly BrightnessDown: "BrightnessDown"; readonly BrightnessUp: "BrightnessUp"; readonly Eject: "Eject"; readonly LogOff: "LogOff"; readonly Power: "Power"; readonly PowerOff: "PowerOff"; readonly PrintScreen: "PrintScreen"; readonly Hibernate: "Hibernate"; readonly Standby: "Standby"; readonly WakeUp: "WakeUp"; readonly F1: "F1"; readonly F2: "F2"; readonly F3: "F3"; readonly F4: "F4"; readonly F5: "F5"; readonly F6: "F6"; readonly F7: "F7"; readonly F8: "F8"; readonly F9: "F9"; readonly F10: "F10"; readonly F11: "F11"; readonly F12: "F12"; readonly F13: "F13"; readonly F14: "F14"; readonly F15: "F15"; readonly F16: "F16"; readonly F17: "F17"; readonly F18: "F18"; readonly F19: "F19"; readonly F20: "F20"; readonly AppSwitch: "AppSwitch"; readonly Call: "Call"; readonly Camera: "Camera"; readonly EndCall: "EndCall"; readonly GoBack: "GoBack"; readonly GoHome: "GoHome"; readonly HeadsetHook: "HeadsetHook"; readonly MediaPlayPause: "MediaPlayPause"; readonly MediaStop: "MediaStop"; readonly MediaTrackNext: "MediaTrackNext"; readonly MediaTrackPrevious: "MediaTrackPrevious"; readonly AudioVolumeDown: "AudioVolumeDown"; readonly AudioVolumeUp: "AudioVolumeUp"; readonly AudioVolumeMute: "AudioVolumeMute"; readonly Decimal: "."; readonly KeypadMultiply: "*"; readonly KeypadAdd: "+"; readonly KeypadSubtract: "-"; readonly KeypadDivide: "/"; readonly A: "A"; readonly B: "B"; readonly C: "C"; readonly D: "D"; readonly E: "E"; readonly F: "F"; readonly G: "G"; readonly H: "H"; readonly I: "I"; readonly J: "J"; readonly K: "K"; readonly L: "L"; readonly M: "M"; readonly N: "N"; readonly O: "O"; readonly P: "P"; readonly Q: "Q"; readonly R: "R"; readonly S: "S"; readonly T: "T"; readonly U: "U"; readonly V: "V"; readonly W: "W"; readonly X: "X"; readonly Y: "Y"; readonly Z: "Z"; readonly Digit0: "0"; readonly Digit1: "1"; readonly Digit2: "2"; readonly Digit3: "3"; readonly Digit4: "4"; readonly Digit5: "5"; readonly Digit6: "6"; readonly Digit7: "7"; readonly Digit8: "8"; readonly Digit9: "9"; }; /** * Represents the set of allowed string literal values for keys, derived from the KeyValues object. * This ensures type safety when configuring shortcuts. */ export type StandardKey = typeof Keys[keyof typeof Keys]; /** * A map of common aliases for keys to their standard `StandardKey` value. * Used internally for parsing string-based shortcut definitions. * @internal */ export declare const KeyAliases: Record<string, StandardKey>; //# sourceMappingURL=keys.d.ts.map