2.0.14

license

@@ -1,4 +1,5 @@
 Copyright (c) 2020 Lossless GmbH (hello@lossless.com)
+Copyright (c) 2017 Nathan Friend (ts-keycode-enum)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "@designestate/dees-domtools",
-  "version": "2.0.7",
+  "version": "2.0.14",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@designestate/dees-domtools",
-      "version": "2.0.7",
+      "version": "2.0.14",
       "license": "MIT",
       "dependencies": {
         "@apiglobal/typedrequest": "^2.0.3",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@designestate/dees-domtools",
-  "version": "2.0.7",
+  "version": "2.0.14",
   "private": false,
   "description": "tools to simplify complex css structures",
   "main": "dist_ts/index.js",

ts/domtools.classes.domtools.ts

@@ -6,12 +6,17 @@ import { TViewport } from './domtools.css.breakpoints.js';
 import { Scroller } from './domtools.classes.scroller.js';
 import { WebSetup } from '@pushrocks/websetup';
 import { ThemeManager } from './domtools.classes.thememanager.js';
+import { Keyboard } from './domtools.classes.keyboard.js';
 
 export interface IDomToolsState {
   virtualViewport: TViewport;
   jwt: string;
 }
 
+export interface IDomToolsContructorOptions {
+  ignoreGlobal?: boolean;
+}
+
 export class DomTools {
   // ======
   // STATIC
@@ -19,10 +24,10 @@ export class DomTools {
   /**
    * setups domtools
    */
-  public static async setupDomTools() {
+  public static async setupDomTools(optionsArg: IDomToolsContructorOptions = {}) {
     let domToolsInstance: DomTools;
-    if (!globalThis.deesDomTools) {
+    if (!globalThis.deesDomTools && !optionsArg.ignoreGlobal) {
-      globalThis.deesDomTools = new DomTools();
+      globalThis.deesDomTools = new DomTools(optionsArg);
       domToolsInstance = globalThis.deesDomTools;
 
       // lets make sure the dom is ready
@@ -35,6 +40,8 @@ export class DomTools {
       };
       document.addEventListener('readystatechange', readyStateChangedFunc);
       domToolsInstance.domToolsReady.resolve();
+    } else if (optionsArg.ignoreGlobal) {
+      domToolsInstance = new DomTools(optionsArg);
     } else {
       domToolsInstance = globalThis.deesDomTools;
     }
@@ -74,7 +81,7 @@ export class DomTools {
   public smartstate = new plugins.smartstate.Smartstate();
   public domToolsStatePart = this.smartstate.getStatePart<IDomToolsState>('domtools', {
     virtualViewport: 'native',
-    jwt: null
+    jwt: null,
   });
 
   public router = new plugins.smartrouter.SmartRouter({
@@ -91,24 +98,13 @@ export class DomTools {
     /* some options */
   }); // TODO: switch to scroller class
   public themeManager = new ThemeManager(this);
-
+  public keyboard = new Keyboard(document.body);
-  /* private actionSetVirtualViewport = this.domToolsStatePart.createAction<TViewport>(
-    async (statePart, payload) => {
-      const currentState = statePart.getState();
-      currentState.virtualViewport = payload;
-      return currentState;
-    }
-  );
-
-  public setVirtualViewport(environmentArg: TViewport) {
-    this.domToolsStatePart.dispatchAction(this.actionSetVirtualViewport, environmentArg);
-  } */
 
   public domToolsReady = plugins.smartpromise.defer();
   public domReady = plugins.smartpromise.defer();
   public globalStylesReady = plugins.smartpromise.defer();
 
-  constructor() {}
+  constructor(optionsArg: IDomToolsContructorOptions) {}
 
   private runOnceTrackerStringMap = new Stringmap();
   private runOnceResultMap = new FastMap();

ts/domtools.classes.keyboard.ts

@@ -0,0 +1,223 @@
+import * as plugins from './domtools.plugins.js';
+
+export enum Key {
+  Backspace = 8,
+  Tab = 9,
+  Enter = 13,
+  Shift = 16,
+  Ctrl = 17,
+  Alt = 18,
+  PauseBreak = 19,
+  CapsLock = 20,
+  Escape = 27,
+  Space = 32,
+  PageUp = 33,
+  PageDown = 34,
+  End = 35,
+  Home = 36,
+
+  LeftArrow = 37,
+  UpArrow = 38,
+  RightArrow = 39,
+  DownArrow = 40,
+
+  Insert = 45,
+  Delete = 46,
+
+  Zero = 48,
+  ClosedParen = Zero,
+  One = 49,
+  ExclamationMark = One,
+  Two = 50,
+  AtSign = Two,
+  Three = 51,
+  PoundSign = Three,
+  Hash = PoundSign,
+  Four = 52,
+  DollarSign = Four,
+  Five = 53,
+  PercentSign = Five,
+  Six = 54,
+  Caret = Six,
+  Hat = Caret,
+  Seven = 55,
+  Ampersand = Seven,
+  Eight = 56,
+  Star = Eight,
+  Asterik = Star,
+  Nine = 57,
+  OpenParen = Nine,
+
+  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,
+
+  LeftWindowKey = 91,
+  RightWindowKey = 92,
+  SelectKey = 93,
+
+  Numpad0 = 96,
+  Numpad1 = 97,
+  Numpad2 = 98,
+  Numpad3 = 99,
+  Numpad4 = 100,
+  Numpad5 = 101,
+  Numpad6 = 102,
+  Numpad7 = 103,
+  Numpad8 = 104,
+  Numpad9 = 105,
+
+  Multiply = 106,
+  Add = 107,
+  Subtract = 109,
+  DecimalPoint = 110,
+  Divide = 111,
+
+  F1 = 112,
+  F2 = 113,
+  F3 = 114,
+  F4 = 115,
+  F5 = 116,
+  F6 = 117,
+  F7 = 118,
+  F8 = 119,
+  F9 = 120,
+  F10 = 121,
+  F11 = 122,
+  F12 = 123,
+
+  NumLock = 144,
+  ScrollLock = 145,
+
+  SemiColon = 186,
+  Equals = 187,
+  Comma = 188,
+  Dash = 189,
+  Period = 190,
+  UnderScore = Dash,
+  PlusSign = Equals,
+  ForwardSlash = 191,
+  Tilde = 192,
+  GraveAccent = Tilde,
+
+  OpenBracket = 219,
+  ClosedBracket = 221,
+  Quote = 222,
+}
+
+type KeyCombo = Array<Key>;
+
+export class Keyboard {
+  private mapCombosToHandlers = new Map<number[], plugins.smartrx.rxjs.Subject<KeyboardEvent>>();
+  private pressedKeys = new Set<Key>();
+
+  constructor(private domNode: Element | Document) {
+    this.startListening();
+  }
+
+  public keyEnum = Key;
+
+  public on(keys: Key[] | KeyCombo[]) {
+    const combos = this.toCombos(keys);
+    const subject = new plugins.smartrx.rxjs.Subject<KeyboardEvent>();
+    combos.forEach((combo) => {
+      this.registerComboCallback(combo, subject);
+    });
+    return subject;
+  }
+
+  public startListening() {
+    this.domNode.addEventListener('keydown', this.handleKeyDown);
+    this.domNode.addEventListener('keyup', this.handleKeyUp);
+  }
+
+  public stopListening() {
+    this.domNode.removeEventListener('keydown', this.handleKeyDown);
+    this.domNode.removeEventListener('keyup', this.handleKeyUp);
+  }
+
+  public clear() {
+    this.stopListening();
+    this.mapCombosToHandlers.clear();
+    this.pressedKeys.clear();
+  }
+
+  private handleKeyDown = (event: KeyboardEvent) => {
+    this.pressedKeys.add(event.keyCode);
+
+    this.mapCombosToHandlers.forEach((subjectArg, comboArg) => {
+      if (this.isComboPressed(comboArg)) {
+        subjectArg.next(event);
+      }
+    });
+  };
+
+  private handleKeyUp = (event: KeyboardEvent) => {
+    this.pressedKeys.delete(event.keyCode);
+  };
+
+  private isComboPressed(combo: number[]) {
+    let result = true;
+
+    combo.forEach((key) => {
+      if (!this.pressedKeys.has(key)) {
+        result = false;
+      }
+    });
+
+    return result;
+  }
+
+  private registerComboCallback(
+    comboArg: Array<Key>,
+    subjectArg: plugins.smartrx.rxjs.Subject<KeyboardEvent>
+  ) {
+    if (!this.mapCombosToHandlers.has(comboArg)) {
+      this.mapCombosToHandlers.set(comboArg, subjectArg);
+    } else {
+      const subject = this.mapCombosToHandlers.get(comboArg);
+      return subject;
+    }
+  }
+
+  private toCombos(keys: KeyCombo[] | Key[]) {
+    if (keys.length === 0) {
+      return [];
+    }
+
+    const isKeys = !Array.isArray(keys[0]);
+    let combos: KeyCombo[] = [];
+
+    if (isKeys) {
+      combos = (keys as Key[]).map((key) => [key]);
+    } else {
+      combos = keys as KeyCombo[];
+      combos = combos.filter((combo) => combo.length > 0);
+    }
+
+    return combos;
+  }
+}

ts/domtools.css.breakpoints.ts

@@ -10,6 +10,17 @@ export const phone = 400;
 
 export type TViewport = 'native' | 'desktop' | 'tablet' | 'phablet' | 'phone';
 
+export const cssForDesktop = (cssArg: CSSResult) => {
+  return unsafeCSS(`
+    @container wccToolsViewport (min-width: ${desktop}px) {
+      ${cssArg.cssText}
+    }
+    @media (min-width: ${desktop}px) {
+      ${cssArg.cssText}
+    }
+  `);
+};
+
 export const cssForNotebook = (cssArg: CSSResult) => {
   return unsafeCSS(`
     @container wccToolsViewport (max-width: ${notebook}px) {

ts/domtools.elementbasic.ts

@@ -1,5 +1,5 @@
 import * as plugins from './domtools.plugins.js';
-import { DomTools } from './domtools.classes.domtools.js';
+import { DomTools, IDomToolsContructorOptions } from './domtools.classes.domtools.js';
 import { scrollBarStyles, globalBaseStyles } from './domtools.css.basestyles.js';
 
 import { html, LitElement, css, unsafeCSS } from 'lit';
@@ -40,8 +40,8 @@ export const styles = html`
  * a basic setup for elements
  * makes sure everything is in check
  */
-export const setup = async (elementArg?: LitElement): Promise<DomTools> => {
+export const setup = async (elementArg?: LitElement, optionsArg: IDomToolsContructorOptions = {}): Promise<DomTools> => {
-  const domTools = await DomTools.setupDomTools();
+  const domTools = await DomTools.setupDomTools(optionsArg);
 
   if (elementArg) {
     // lets do something with the element

ts/index.ts

@@ -5,7 +5,7 @@ import * as breakpoints from './domtools.css.breakpoints.js';
 import * as css from './domtools.css.js';
 
 export { css, breakpoints, elementBasic };
-export { DomTools } from './domtools.classes.domtools.js';
+export { DomTools, IDomToolsContructorOptions } from './domtools.classes.domtools.js';
 export { TypedRequest } from '@apiglobal/typedrequest';
 export { IWebSetupConstructorOptions } from '@pushrocks/websetup';
 export { rxjs } from '@pushrocks/smartrx';