@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/esm/appui-react/keyboardshortcut/InternalKeyboardShortcut.js

@@ -1,108 +1,109 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import { ConditionalBooleanValue } from "@itwin/appui-abstract";
-import { CursorInformation } from "../cursor/CursorInformation";
-import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu";
-import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut";
-import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
-/** Keyboard Shortcut Manager
- * @internal
- */
-export class InternalKeyboardShortcutManager {
-    /** Initialize the Keyboard Shortcut manager
-     * @internal
-    */
-    static initialize() {
-        SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);
-    }
-    /** Loads Keyboard Shortcuts into the managed list */
-    static loadShortcuts(shortcutList) {
-        shortcutList.forEach((shortcutProps) => {
-            this.loadShortcut(shortcutProps);
-        });
-    }
-    /** Loads a Keyboard Shortcut into the managed list */
-    static loadShortcut(shortcutProps) {
-        const shortcut = new KeyboardShortcut(shortcutProps);
-        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
-    }
-    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
-    static processKey(keyboardKey, isAltKeyPressed = false, isCtrlKeyPressed = false, isShiftKeyPressed = false) {
-        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
-        const shortcut = this.getShortcut(keyMapKey);
-        if (shortcut) {
-            shortcut.itemPicked();
-            return true;
-        }
-        return false;
-    }
-    /** Returns the managed list of Keyboard Shortcuts */
-    static get shortcutContainer() {
-        return this._shortcuts;
-    }
-    /** Returns a Keyboard Shortcut from the managed lists */
-    static getShortcut(keyMapKey) {
-        return this._shortcuts.findKey(keyMapKey);
-    }
-    /** Determines if focus is set to Home */
-    static get isFocusOnHome() {
-        const element = document.activeElement;
-        return element && element === document.body;
-    }
-    /** Sets focus to Home */
-    static setFocusToHome() {
-        const element = document.activeElement;
-        if (element && element !== document.body) {
-            element.blur();
-            document.body.focus();
-        }
-    }
-    /** Displays the Keyboard Shortcuts menu at the cursor */
-    static displayMenu() {
-        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
-            this._shortcuts.showShortcutsMenu();
-        }
-    }
-    /** Closes the Keyboard Shortcuts menu */
-    static closeMenu() {
-        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
-            menuVisible: false,
-            menuX: 0,
-            menuY: 0,
-            shortcuts: undefined,
-        });
-    }
-    /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX() { return CursorInformation.cursorX; }
-    /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY() { return CursorInformation.cursorY; }
-}
-InternalKeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
-InternalKeyboardShortcutManager._handleSyncUiEvent = (args) => {
-    const updateBooleanValue = (booleanValue) => {
-        if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
-            booleanValue.refresh();
-    };
-    const handleForSyncIds = (shortcut) => {
-        if (shortcut.isDisabled instanceof ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isDisabled);
-        if (shortcut.isHidden instanceof ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isHidden);
-    };
-    InternalKeyboardShortcutManager._traverseShortcuts(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);
-};
-InternalKeyboardShortcutManager._traverseShortcuts = (shortcuts, callback) => {
-    shortcuts.forEach((shortcut) => {
-        callback(shortcut);
-        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
-            const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
-            InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);
-        }
-    });
-};
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { ConditionalBooleanValue } from "@itwin/appui-abstract";
+import { CursorInformation } from "../cursor/CursorInformation";
+import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu";
+import { KeyboardShortcut, KeyboardShortcutContainer } from "./KeyboardShortcut";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+/** Keyboard Shortcut Manager
+ * @internal
+ */
+class InternalKeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @internal
+    */
+    static initialize() {
+        SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);
+    }
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadShortcuts(shortcutList) {
+        shortcutList.forEach((shortcutProps) => {
+            this.loadShortcut(shortcutProps);
+        });
+    }
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadShortcut(shortcutProps) {
+        const shortcut = new KeyboardShortcut(shortcutProps);
+        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
+    }
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey, isAltKeyPressed = false, isCtrlKeyPressed = false, isShiftKeyPressed = false) {
+        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
+        const shortcut = this.getShortcut(keyMapKey);
+        if (shortcut) {
+            shortcut.itemPicked();
+            return true;
+        }
+        return false;
+    }
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer() {
+        return this._shortcuts;
+    }
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey) {
+        return this._shortcuts.findKey(keyMapKey);
+    }
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome() {
+        const element = document.activeElement;
+        return element && element === document.body;
+    }
+    /** Sets focus to Home */
+    static setFocusToHome() {
+        const element = document.activeElement;
+        if (element && element !== document.body) {
+            element.blur();
+            document.body.focus();
+        }
+    }
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayMenu() {
+        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
+            this._shortcuts.showShortcutsMenu();
+        }
+    }
+    /** Closes the Keyboard Shortcuts menu */
+    static closeMenu() {
+        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
+            menuVisible: false,
+            menuX: 0,
+            menuY: 0,
+            shortcuts: undefined,
+        });
+    }
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX() { return CursorInformation.cursorX; }
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY() { return CursorInformation.cursorY; }
+}
+InternalKeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
+InternalKeyboardShortcutManager._handleSyncUiEvent = (args) => {
+    const updateBooleanValue = (booleanValue) => {
+        if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
+            booleanValue.refresh();
+    };
+    const handleForSyncIds = (shortcut) => {
+        if (shortcut.isDisabled instanceof ConditionalBooleanValue)
+            updateBooleanValue(shortcut.isDisabled);
+        if (shortcut.isHidden instanceof ConditionalBooleanValue)
+            updateBooleanValue(shortcut.isHidden);
+    };
+    InternalKeyboardShortcutManager._traverseShortcuts(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);
+};
+InternalKeyboardShortcutManager._traverseShortcuts = (shortcuts, callback) => {
+    shortcuts.forEach((shortcut) => {
+        callback(shortcut);
+        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
+            const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
+            InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);
+        }
+    });
+};
+export { InternalKeyboardShortcutManager };
 //# sourceMappingURL=InternalKeyboardShortcut.js.map

package/lib/esm/appui-react/keyboardshortcut/InternalKeyboardShortcut.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAmB,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAIxE;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAI1C;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IACtG,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,aAAa,CAAC,YAAqC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,YAAY,CAAC,aAAoC;QAC7D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QAEjI,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,OAAO,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,IAAI,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE;YACxC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;SACvB;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,SAAS;QACrB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAhF1D,0CAAU,GAA8B,IAAI,yBAAyB,EAAE,CAAC;AAkFxE,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC;YACpF,YAAY,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,QAA0B,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,UAAU,YAAY,uBAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,uBAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,+BAA+B,CAAC,kBAAkB,CAAC,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACnJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAAC,SAA6B,EAAE,QAAwB,EAAE,EAAE;IAC9F,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAClF,+BAA+B,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SAC9E;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module KeyboardShortcut\r\n */\r\n\r\nimport { ConditionalBooleanValue, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { CursorInformation } from \"../cursor/CursorInformation\";\r\nimport { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\r\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\r\nimport { KeyboardShortcut, KeyboardShortcutContainer } from \"./KeyboardShortcut\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\r\n\r\n/** Keyboard Shortcut Manager\r\n * @internal\r\n */\r\nexport class InternalKeyboardShortcutManager {\r\n\r\n  private static _shortcuts: KeyboardShortcutContainer = new KeyboardShortcutContainer();\r\n\r\n  /** Initialize the Keyboard Shortcut manager\r\n   * @internal\r\n  */\r\n  public static initialize(): void {\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);\r\n  }\r\n\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  public static loadShortcuts(shortcutList: KeyboardShortcutProps[]) {\r\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\r\n      this.loadShortcut(shortcutProps);\r\n    });\r\n  }\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  public static loadShortcut(shortcutProps: KeyboardShortcutProps) {\r\n    const shortcut = new KeyboardShortcut(shortcutProps);\r\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n  }\r\n\r\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n  public static processKey(keyboardKey: string, isAltKeyPressed: boolean = false, isCtrlKeyPressed: boolean = false, isShiftKeyPressed: boolean = false): boolean {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\r\n\r\n    const shortcut = this.getShortcut(keyMapKey);\r\n    if (shortcut) {\r\n      shortcut.itemPicked();\r\n      return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n\r\n  /** Returns the managed list of Keyboard Shortcuts */\r\n  public static get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Returns a Keyboard Shortcut from the managed lists */\r\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(keyMapKey);\r\n  }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public static get isFocusOnHome(): boolean {\r\n    const element = document.activeElement as HTMLElement;\r\n    return element && element === document.body;\r\n  }\r\n\r\n  /** Sets focus to Home */\r\n  public static setFocusToHome(): void {\r\n    const element = document.activeElement as HTMLElement;\r\n    if (element && element !== document.body) {\r\n      element.blur();\r\n      document.body.focus();\r\n    }\r\n  }\r\n\r\n  /** Displays the Keyboard Shortcuts menu at the cursor */\r\n  public static displayMenu(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    }\r\n  }\r\n\r\n  /** Closes the Keyboard Shortcuts menu */\r\n  public static closeMenu(): void {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: false,\r\n      menuX: 0,\r\n      menuY: 0,\r\n      shortcuts: undefined,\r\n    });\r\n  }\r\n\r\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n  public static get cursorX(): number { return CursorInformation.cursorX; }\r\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n  public static get cursorY(): number { return CursorInformation.cursorY; }\r\n\r\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\r\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))\r\n        booleanValue.refresh();\r\n    };\r\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\r\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isDisabled);\r\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isHidden);\r\n    };\r\n\r\n    InternalKeyboardShortcutManager._traverseShortcuts(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);\r\n  };\r\n\r\n  private static _traverseShortcuts = (shortcuts: KeyboardShortcut[], callback: OnShortcutFunc) => {\r\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\r\n      callback(shortcut);\r\n\r\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\r\n        const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\r\n        InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);\r\n      }\r\n    });\r\n  };\r\n\r\n}\r\n"]}
+{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAmB,MAAM,uBAAuB,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAIxE;;GAEG;AACH,MAAa,+BAA+B;IAI1C;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,+BAA+B,CAAC,kBAAkB,CAAC,CAAC;IACtG,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,aAAa,CAAC,YAAqC;QAC/D,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,YAAY,CAAC,aAAoC;QAC7D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;QAEjI,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,OAAO,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,CAAC;IAC9C,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,aAA4B,CAAC;QACtD,IAAI,OAAO,IAAI,OAAO,KAAK,QAAQ,CAAC,IAAI,EAAE;YACxC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;SACvB;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,SAAS;QACrB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,SAAS;SACrB,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAhF1D,0CAAU,GAA8B,IAAI,yBAAyB,EAAE,CAAC;AAkFxE,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,YAAY,CAAC;YACpF,YAAY,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,QAA0B,EAAE,EAAE;QACtD,IAAI,QAAQ,CAAC,UAAU,YAAY,uBAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,uBAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,+BAA+B,CAAC,kBAAkB,CAAC,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACnJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAAC,SAA6B,EAAE,QAAwB,EAAE,EAAE;IAC9F,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE;YAC9D,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAClF,+BAA+B,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SAC9E;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;SA5GS,+BAA+B","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module KeyboardShortcut\r\n */\r\n\r\nimport { ConditionalBooleanValue, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { CursorInformation } from \"../cursor/CursorInformation\";\r\nimport { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\r\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\r\nimport { KeyboardShortcut, KeyboardShortcutContainer } from \"./KeyboardShortcut\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\r\n\r\n/** Keyboard Shortcut Manager\r\n * @internal\r\n */\r\nexport class InternalKeyboardShortcutManager {\r\n\r\n  private static _shortcuts: KeyboardShortcutContainer = new KeyboardShortcutContainer();\r\n\r\n  /** Initialize the Keyboard Shortcut manager\r\n   * @internal\r\n  */\r\n  public static initialize(): void {\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(InternalKeyboardShortcutManager._handleSyncUiEvent);\r\n  }\r\n\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  public static loadShortcuts(shortcutList: KeyboardShortcutProps[]) {\r\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\r\n      this.loadShortcut(shortcutProps);\r\n    });\r\n  }\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  public static loadShortcut(shortcutProps: KeyboardShortcutProps) {\r\n    const shortcut = new KeyboardShortcut(shortcutProps);\r\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n  }\r\n\r\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\r\n  public static processKey(keyboardKey: string, isAltKeyPressed: boolean = false, isCtrlKeyPressed: boolean = false, isShiftKeyPressed: boolean = false): boolean {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\r\n\r\n    const shortcut = this.getShortcut(keyMapKey);\r\n    if (shortcut) {\r\n      shortcut.itemPicked();\r\n      return true;\r\n    }\r\n\r\n    return false;\r\n  }\r\n\r\n  /** Returns the managed list of Keyboard Shortcuts */\r\n  public static get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Returns a Keyboard Shortcut from the managed lists */\r\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(keyMapKey);\r\n  }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public static get isFocusOnHome(): boolean {\r\n    const element = document.activeElement as HTMLElement;\r\n    return element && element === document.body;\r\n  }\r\n\r\n  /** Sets focus to Home */\r\n  public static setFocusToHome(): void {\r\n    const element = document.activeElement as HTMLElement;\r\n    if (element && element !== document.body) {\r\n      element.blur();\r\n      document.body.focus();\r\n    }\r\n  }\r\n\r\n  /** Displays the Keyboard Shortcuts menu at the cursor */\r\n  public static displayMenu(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    }\r\n  }\r\n\r\n  /** Closes the Keyboard Shortcuts menu */\r\n  public static closeMenu(): void {\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: false,\r\n      menuX: 0,\r\n      menuY: 0,\r\n      shortcuts: undefined,\r\n    });\r\n  }\r\n\r\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n  public static get cursorX(): number { return CursorInformation.cursorX; }\r\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n  public static get cursorY(): number { return CursorInformation.cursorY; }\r\n\r\n  private static _handleSyncUiEvent = (args: UiSyncEventArgs) => {\r\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\r\n      if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))\r\n        booleanValue.refresh();\r\n    };\r\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\r\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isDisabled);\r\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\r\n        updateBooleanValue(shortcut.isHidden);\r\n    };\r\n\r\n    InternalKeyboardShortcutManager._traverseShortcuts(InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);\r\n  };\r\n\r\n  private static _traverseShortcuts = (shortcuts: KeyboardShortcut[], callback: OnShortcutFunc) => {\r\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\r\n      callback(shortcut);\r\n\r\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\r\n        const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\r\n        InternalKeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);\r\n      }\r\n    });\r\n  };\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts

@@ -1,97 +1,97 @@
-/** @packageDocumentation
- * @module KeyboardShortcut
- */
-import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
-import { ItemDefBase } from "../shared/ItemDefBase";
-import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
-/** Keyboard Shortcut used to execute an action
- * @public
- */
-export declare class KeyboardShortcut extends ItemDefBase {
-    private _key;
-    private _item?;
-    private _shortcuts;
-    private _isAltKeyRequired;
-    private _isCtrlKeyRequired;
-    private _isShiftKeyRequired;
-    private _isFunctionKey;
-    private _isSpecialKey;
-    constructor(props: KeyboardShortcutProps);
-    /** Returns the id for this shortcut */
-    get id(): string;
-    /** Returns the shortcut container */
-    get shortcutContainer(): KeyboardShortcutContainer;
-    /** Finds a shortcut with a given key in the shortcut's container */
-    getShortcut(mapKey: string): KeyboardShortcut | undefined;
-    /** Returns the shortcut's key map key used as the id */
-    get keyMapKey(): string;
-    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
-    get item(): ActionButtonItemDef | undefined;
-    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
-    itemPicked(): void;
-    /** Gets the keyboard key */
-    get key(): string;
-    /** Gets whether the Alt key required. */
-    get isAltKeyRequired(): boolean;
-    /** Gets whether the Ctrl key required. */
-    get isCtrlKeyRequired(): boolean;
-    /** Gets whether the Shift key required. */
-    get isShiftKeyRequired(): boolean;
-    /** Gets whether this is a Function key. */
-    get isFunctionKey(): boolean;
-    /** Gets whether this is a Special key. */
-    get isSpecialKey(): boolean;
-}
-/** Keyboard Shortcut Container
- * @public
- */
-export declare class KeyboardShortcutContainer {
-    private _keyMap;
-    private _keyArray;
-    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
-    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
-    /** Finds a Keyboard Shortcut associated with a given key */
-    findKey(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if any Keyboard Shortcuts are available in this container */
-    areKeyboardShortcutsAvailable(): boolean;
-    /** Empties any Keyboard Shortcuts from this container */
-    emptyData(): void;
-    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
-    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
-    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
-    /** Displays a menu for the Keyboard Shortcuts in this container */
-    showShortcutsMenu(): void;
-}
-/** Keyboard Shortcut Manager
- * @public
- * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
- */
-export declare class KeyboardShortcutManager {
-    /** Initialize the Keyboard Shortcut manager
-     * @deprecated in 3.7. This is called internally.
-    */
-    static initialize(): void;
-    /** Loads Keyboard Shortcuts into the managed list */
-    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
-    /** Loads a Keyboard Shortcut into the managed list */
-    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
-    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
-    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
-    /** Returns the managed list of Keyboard Shortcuts */
-    static get shortcutContainer(): KeyboardShortcutContainer;
-    /** Returns a Keyboard Shortcut from the managed lists */
-    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
-    /** Determines if focus is set to Home */
-    static get isFocusOnHome(): boolean;
-    /** Sets focus to Home */
-    static setFocusToHome(): void;
-    /** Displays the Keyboard Shortcuts menu at the cursor */
-    static displayShortcutsMenu(): void;
-    /** Closes the Keyboard Shortcuts menu */
-    static closeShortcutsMenu(): void;
-    /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX(): number;
-    /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY(): number;
-}
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
+import { ItemDefBase } from "../shared/ItemDefBase";
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
+/** Keyboard Shortcut used to execute an action
+ * @public
+ */
+export declare class KeyboardShortcut extends ItemDefBase {
+    private _key;
+    private _item?;
+    private _shortcuts;
+    private _isAltKeyRequired;
+    private _isCtrlKeyRequired;
+    private _isShiftKeyRequired;
+    private _isFunctionKey;
+    private _isSpecialKey;
+    constructor(props: KeyboardShortcutProps);
+    /** Returns the id for this shortcut */
+    get id(): string;
+    /** Returns the shortcut container */
+    get shortcutContainer(): KeyboardShortcutContainer;
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey: string): KeyboardShortcut | undefined;
+    /** Returns the shortcut's key map key used as the id */
+    get keyMapKey(): string;
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    get item(): ActionButtonItemDef | undefined;
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked(): void;
+    /** Gets the keyboard key */
+    get key(): string;
+    /** Gets whether the Alt key required. */
+    get isAltKeyRequired(): boolean;
+    /** Gets whether the Ctrl key required. */
+    get isCtrlKeyRequired(): boolean;
+    /** Gets whether the Shift key required. */
+    get isShiftKeyRequired(): boolean;
+    /** Gets whether this is a Function key. */
+    get isFunctionKey(): boolean;
+    /** Gets whether this is a Special key. */
+    get isSpecialKey(): boolean;
+}
+/** Keyboard Shortcut Container
+ * @public
+ */
+export declare class KeyboardShortcutContainer {
+    private _keyMap;
+    private _keyArray;
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined;
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable(): boolean;
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData(): void;
+    getAvailableKeyboardShortcuts(): KeyboardShortcut[];
+    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
+    static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string;
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu(): void;
+}
+/** Keyboard Shortcut Manager
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
+ */
+export declare class KeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @deprecated in 3.7. This is called internally.
+    */
+    static initialize(): void;
+    /** Loads Keyboard Shortcuts into the managed list */
+    static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]): void;
+    /** Loads a Keyboard Shortcut into the managed list */
+    static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps): void;
+    /** Processes a keystroke and invokes a matching Keyboard Shortcut */
+    static processKey(keyboardKey: string, isAltKeyPressed?: boolean, isCtrlKeyPressed?: boolean, isShiftKeyPressed?: boolean): boolean;
+    /** Returns the managed list of Keyboard Shortcuts */
+    static get shortcutContainer(): KeyboardShortcutContainer;
+    /** Returns a Keyboard Shortcut from the managed lists */
+    static getShortcut(keyMapKey: string): KeyboardShortcut | undefined;
+    /** Determines if focus is set to Home */
+    static get isFocusOnHome(): boolean;
+    /** Sets focus to Home */
+    static setFocusToHome(): void;
+    /** Displays the Keyboard Shortcuts menu at the cursor */
+    static displayShortcutsMenu(): void;
+    /** Closes the Keyboard Shortcuts menu */
+    static closeShortcutsMenu(): void;
+    /** Returns the cursor X position, which is mouseEvent.pageX. */
+    static get cursorX(): number;
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY(): number;
+}
 //# sourceMappingURL=KeyboardShortcut.d.ts.map