@itwin/appui-react 4.0.0-dev.8 → 4.0.0-dev.9

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

@@ -0,0 +1,112 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalKeyboardShortcutManager = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const CursorInformation_1 = require("../cursor/CursorInformation");
+const KeyboardShortcutMenu_1 = require("./KeyboardShortcutMenu");
+const KeyboardShortcut_1 = require("./KeyboardShortcut");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+/** Keyboard Shortcut Manager
+ * @internal
+ */
+class InternalKeyboardShortcutManager {
+    /** Initialize the Keyboard Shortcut manager
+     * @internal
+    */
+    static initialize() {
+        SyncUiEventDispatcher_1.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_1.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 = KeyboardShortcut_1.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_1.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_1.CursorInformation.cursorX; }
+    /** Returns the cursor Y position, which is mouseEvent.pageY. */
+    static get cursorY() { return CursorInformation_1.CursorInformation.cursorY; }
+}
+exports.InternalKeyboardShortcutManager = InternalKeyboardShortcutManager;
+InternalKeyboardShortcutManager._shortcuts = new KeyboardShortcut_1.KeyboardShortcutContainer();
+InternalKeyboardShortcutManager._handleSyncUiEvent = (args) => {
+    const updateBooleanValue = (booleanValue) => {
+        if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
+            booleanValue.refresh();
+    };
+    const handleForSyncIds = (shortcut) => {
+        if (shortcut.isDisabled instanceof appui_abstract_1.ConditionalBooleanValue)
+            updateBooleanValue(shortcut.isDisabled);
+        if (shortcut.isHidden instanceof appui_abstract_1.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);
+        }
+    });
+};
+//# sourceMappingURL=InternalKeyboardShortcut.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalKeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/InternalKeyboardShortcut.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAiF;AACjF,mEAAgE;AAEhE,iEAA8D;AAC9D,yDAAiF;AACjF,2EAAwE;AAIxE;;GAEG;AACH,MAAa,+BAA+B;IAI1C;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,6CAAqB,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,mCAAgB,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,4CAAyB,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,2CAAoB,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,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAlF3E,0EA8GC;AA5GgB,0CAAU,GAA8B,IAAI,4CAAyB,EAAE,CAAC;AAkFxE,kDAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,6CAAqB,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,wCAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,wCAAuB;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"]}

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

@@ -1,29 +1,9 @@
 /** @packageDocumentation
  * @module KeyboardShortcut
  */
-import { FunctionKey, SpecialKey } from "@itwin/appui-abstract";
 import { ActionButtonItemDef } from "../shared/ActionButtonItemDef";
 import { ItemDefBase } from "../shared/ItemDefBase";
-import { ItemProps } from "../shared/ItemProps";
-/** Properties for a Keyboard Shortcut
- * @public
- */
-export interface KeyboardShortcutProps extends ItemProps {
-    /** The key that invokes the shortcut.
-     * This is either an alphanumeric key, a function key or a special key.
-     */
-    key: string | FunctionKey | SpecialKey;
-    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */
-    item?: ActionButtonItemDef;
-    /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */
-    shortcuts?: KeyboardShortcutProps[];
-    /** Indicates whether the Alt key required. Default - false */
-    isAltKeyRequired?: boolean;
-    /** Indicates whether the Ctrl key required. Default - false */
-    isCtrlKeyRequired?: boolean;
-    /** Indicates whether the Shift key required. Default - false */
-    isShiftKeyRequired?: boolean;
-}
+import { KeyboardShortcutProps } from "../framework/FrameworkKeyboardShortcuts";
 /** Keyboard Shortcut used to execute an action
  * @public
  */
@@ -84,10 +64,12 @@ export declare class KeyboardShortcutContainer {
 }
 /** Keyboard Shortcut Manager
  * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
  */
 export declare class KeyboardShortcutManager {
-    private static _shortcuts;
-    /** Initialize the Keyboard Shortcut manager */
+    /** 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;
@@ -111,7 +93,5 @@ export declare class KeyboardShortcutManager {
     static get cursorX(): number;
     /** Returns the cursor Y position, which is mouseEvent.pageY. */
     static get cursorY(): number;
-    private static _handleSyncUiEvent;
-    private static _traverseShortcuts;
 }
 //# sourceMappingURL=KeyboardShortcut.d.ts.map

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAA2B,WAAW,EAAE,UAAU,EAA4B,MAAM,uBAAuB,CAAC;AAEnH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAKhD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,SAAS;IACtD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,WAAW,GAAG,UAAU,CAAC;IAEvC,yGAAyG;IACzG,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,sFAAsF;IACtF,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAEpC,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,+DAA+D;IAC/D,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAsB;IACpC,OAAO,CAAC,UAAU,CAA4B;IAE9C,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,aAAa,CAAkB;gBAE3B,KAAK,EAAE,qBAAqB;IA2CxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAA2B;IAElD,qCAAqC;IACrC,IAAW,iBAAiB,IAAI,yBAAyB,CAExD;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIhE,wDAAwD;IACxD,IAAW,SAAS,IAAI,MAAM,CAG7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAYzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAAsB;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAAmC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAAoC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAAgC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAA+B;CAElE;AAED;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAAsE;IACrF,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAwBjG,4DAA4D;IACrD,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/D,2EAA2E;IACpE,6BAA6B,IAAI,OAAO;IAI/C,yDAAyD;IAClD,SAAS,IAAI,IAAI;IAKjB,6BAA6B,IAAI,gBAAgB,EAAE;IAI1D,4FAA4F;WAC9E,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM;IAahJ,mEAAmE;IAC5D,iBAAiB;CASzB;AAID;;GAEG;AACH,qBAAa,uBAAuB;IAElC,OAAO,CAAC,MAAM,CAAC,UAAU,CAA8D;IAEvF,+CAA+C;WACjC,UAAU,IAAI,IAAI;IAIhC,qDAAqD;WACvC,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAMzE,sDAAsD;WACxC,oBAAoB,CAAC,aAAa,EAAE,qBAAqB;IAKvE,qEAAqE;WACvD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,EAAE,gBAAgB,GAAE,OAAe,EAAE,iBAAiB,GAAE,OAAe,GAAG,OAAO;IAY/J,qDAAqD;IACrD,WAAkB,iBAAiB,IAAI,yBAAyB,CAE/D;IAED,yDAAyD;WAC3C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1E,yCAAyC;IACzC,WAAkB,aAAa,IAAI,OAAO,CAGzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAQpC,yDAAyD;WAC3C,oBAAoB,IAAI,IAAI;IAM1C,yCAAyC;WAC3B,kBAAkB,IAAI,IAAI;IASxC,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAAsC;IACzE,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAAsC;IAEzE,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAa/B;IAEF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAS/B;CAEH"}
+{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAKhF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAE/C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAsB;IACpC,OAAO,CAAC,UAAU,CAA4B;IAE9C,OAAO,CAAC,iBAAiB,CAAkB;IAC3C,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,mBAAmB,CAAkB;IAC7C,OAAO,CAAC,cAAc,CAAkB;IACxC,OAAO,CAAC,aAAa,CAAkB;gBAE3B,KAAK,EAAE,qBAAqB;IA2CxC,uCAAuC;IACvC,IAAW,EAAE,IAAI,MAAM,CAA2B;IAElD,qCAAqC;IACrC,IAAW,iBAAiB,IAAI,yBAAyB,CAExD;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAIhE,wDAAwD;IACxD,IAAW,SAAS,IAAI,MAAM,CAG7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAYzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAAsB;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAAmC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAAoC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAAqC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAAgC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAA+B;CAElE;AAED;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAAsE;IACrF,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,gBAAgB,GAAG,gBAAgB,GAAG,SAAS;IAwBjG,4DAA4D;IACrD,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/D,2EAA2E;IACpE,6BAA6B,IAAI,OAAO;IAI/C,yDAAyD;IAClD,SAAS,IAAI,IAAI;IAKjB,6BAA6B,IAAI,gBAAgB,EAAE;IAI1D,4FAA4F;WAC9E,iBAAiB,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,kBAAkB,EAAE,OAAO,GAAG,MAAM;IAahJ,mEAAmE;IAC5D,iBAAiB;CASzB;AAED;;;GAGG;AACH,qBAAa,uBAAuB;IAClC;;MAEE;WACY,UAAU,IAAI,IAAI;IAIhC,qDAAqD;WACvC,qBAAqB,CAAC,YAAY,EAAE,qBAAqB,EAAE;IAIzE,sDAAsD;WACxC,oBAAoB,CAAC,aAAa,EAAE,qBAAqB;IAIvE,qEAAqE;WACvD,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,OAAe,EAAE,gBAAgB,GAAE,OAAe,EAAE,iBAAiB,GAAE,OAAe,GAAG,OAAO;IAI/J,qDAAqD;IACrD,WAAkB,iBAAiB,IAAI,yBAAyB,CAE/D;IAED,yDAAyD;WAC3C,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1E,yCAAyC;IACzC,WAAkB,aAAa,IAAI,OAAO,CAEzC;IAED,yBAAyB;WACX,cAAc,IAAI,IAAI;IAIpC,yDAAyD;WAC3C,oBAAoB,IAAI,IAAI;IAI1C,yCAAyC;WAC3B,kBAAkB,IAAI,IAAI;IAIxC,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAA6B;IAChE,gEAAgE;IAChE,WAAkB,OAAO,IAAI,MAAM,CAA6B;CACjE"}

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js

@@ -9,11 +9,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeyboardShortcutManager = exports.KeyboardShortcutContainer = exports.KeyboardShortcut = void 0;
 const appui_abstract_1 = require("@itwin/appui-abstract");
-const CursorInformation_1 = require("../cursor/CursorInformation");
 const ItemDefBase_1 = require("../shared/ItemDefBase");
 const UiFramework_1 = require("../UiFramework");
 const KeyboardShortcutMenu_1 = require("./KeyboardShortcutMenu");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const InternalKeyboardShortcut_1 = require("./InternalKeyboardShortcut");
 /** Keyboard Shortcut used to execute an action
  * @public
  */
@@ -169,8 +168,8 @@ class KeyboardShortcutContainer {
         const offset = 8;
         KeyboardShortcutMenu_1.KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
             menuVisible: true,
-            menuX: KeyboardShortcutManager.cursorX - offset,
-            menuY: KeyboardShortcutManager.cursorY - offset,
+            menuX: UiFramework_1.UiFramework.keyboardShortcuts.cursorX - offset,
+            menuY: UiFramework_1.UiFramework.keyboardShortcuts.cursorY - offset,
             shortcuts: this.getAvailableKeyboardShortcuts(),
         });
     }
@@ -178,96 +177,55 @@ class KeyboardShortcutContainer {
 exports.KeyboardShortcutContainer = KeyboardShortcutContainer;
 /** Keyboard Shortcut Manager
  * @public
+ * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.
  */
 class KeyboardShortcutManager {
-    /** Initialize the Keyboard Shortcut manager */
+    /** Initialize the Keyboard Shortcut manager
+     * @deprecated in 3.7. This is called internally.
+    */
     static initialize() {
-        SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener(KeyboardShortcutManager._handleSyncUiEvent);
+        InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.initialize();
     }
     /** Loads Keyboard Shortcuts into the managed list */
     static loadKeyboardShortcuts(shortcutList) {
-        shortcutList.forEach((shortcutProps) => {
-            this.loadKeyboardShortcut(shortcutProps);
-        });
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.loadShortcuts(shortcutList);
     }
     /** Loads a Keyboard Shortcut into the managed list */
     static loadKeyboardShortcut(shortcutProps) {
-        const shortcut = new KeyboardShortcut(shortcutProps);
-        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.loadShortcut(shortcutProps);
     }
     /** 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;
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.processKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);
     }
     /** Returns the managed list of Keyboard Shortcuts */
     static get shortcutContainer() {
-        return this._shortcuts;
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.shortcutContainer;
     }
     /** Returns a Keyboard Shortcut from the managed lists */
     static getShortcut(keyMapKey) {
-        return this._shortcuts.findKey(keyMapKey);
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.getShortcut(keyMapKey);
     }
     /** Determines if focus is set to Home */
     static get isFocusOnHome() {
-        const element = document.activeElement;
-        return element && element === document.body;
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.isFocusOnHome;
     }
     /** Sets focus to Home */
     static setFocusToHome() {
-        const element = document.activeElement;
-        if (element && element !== document.body) {
-            element.blur();
-            document.body.focus();
-        }
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.setFocusToHome();
     }
     /** Displays the Keyboard Shortcuts menu at the cursor */
     static displayShortcutsMenu() {
-        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
-            this._shortcuts.showShortcutsMenu();
-        }
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.displayMenu();
     }
     /** Closes the Keyboard Shortcuts menu */
     static closeShortcutsMenu() {
-        KeyboardShortcutMenu_1.KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
-            menuVisible: false,
-            menuX: 0,
-            menuY: 0,
-            shortcuts: undefined,
-        });
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.closeMenu();
     }
     /** Returns the cursor X position, which is mouseEvent.pageX. */
-    static get cursorX() { return CursorInformation_1.CursorInformation.cursorX; }
+    static get cursorX() { return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.cursorX; }
     /** Returns the cursor Y position, which is mouseEvent.pageY. */
-    static get cursorY() { return CursorInformation_1.CursorInformation.cursorY; }
+    static get cursorY() { return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager.cursorY; }
 }
 exports.KeyboardShortcutManager = KeyboardShortcutManager;
-KeyboardShortcutManager._shortcuts = new KeyboardShortcutContainer();
-KeyboardShortcutManager._handleSyncUiEvent = (args) => {
-    const updateBooleanValue = (booleanValue) => {
-        if (SyncUiEventDispatcher_1.SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, booleanValue.syncEventIds))
-            booleanValue.refresh();
-    };
-    const handleForSyncIds = (shortcut) => {
-        if (shortcut.isDisabled instanceof appui_abstract_1.ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isDisabled);
-        if (shortcut.isHidden instanceof appui_abstract_1.ConditionalBooleanValue)
-            updateBooleanValue(shortcut.isHidden);
-    };
-    KeyboardShortcutManager._traverseShortcuts(KeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(), handleForSyncIds);
-};
-KeyboardShortcutManager._traverseShortcuts = (shortcuts, callback) => {
-    shortcuts.forEach((shortcut) => {
-        callback(shortcut);
-        if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {
-            const childShortcuts = shortcut.shortcutContainer.getAvailableKeyboardShortcuts();
-            KeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);
-        }
-    });
-};
 //# sourceMappingURL=KeyboardShortcut.js.map

package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAmH;AACnH,mEAAgE;AAEhE,uDAAoD;AAEpD,gDAA6C;AAC7C,iEAA8D;AAC9D,2EAAwE;AAwBxE;;GAEG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAY/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,4BAAW;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,2BAAU;YACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,KAAK;gBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;SACvC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;SAC/H;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElD,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACnJ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBACZ,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,KAAc,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,KAAc,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;CAElE;AAzGD,4CAyGC;AAED;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAA4B,CAAC;QAC7E,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAuExE,CAAC;IArEC,oFAAoF;IAC7E,WAAW,CAAC,SAAiB,EAAE,UAA4B;QAChE,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,IAAI,QAAQ;YACV,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAAC,WAAmB,EAAE,gBAAyB,EAAE,iBAA0B,EAAE,kBAA2B;QACrI,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAClB,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACjC,IAAI,kBAAkB;YACpB,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACnC,IAAI,iBAAiB;YACnB,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAElC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,2CAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,uBAAuB,CAAC,OAAO,GAAG,MAAM;YAC/C,KAAK,EAAE,uBAAuB,CAAC,OAAO,GAAG,MAAM;YAC/C,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAzED,8DAyEC;AAID;;GAEG;AACH,MAAa,uBAAuB;IAIlC,+CAA+C;IACxC,MAAM,CAAC,UAAU;QACtB,6CAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC;IAC9F,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,YAAY,CAAC,OAAO,CAAC,CAAC,aAAoC,EAAE,EAAE;YAC5D,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,aAAoC;QACrE,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,oBAAoB;QAChC,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;IACH,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB;QAC9B,2CAAoB,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,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACzE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,qCAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;;AAhF3E,0DA4GC;AA1GgB,kCAAU,GAA8B,IAAI,yBAAyB,EAAE,CAAC;AAgFxE,0CAAkB,GAAG,CAAC,IAAqB,EAAE,EAAE;IAC5D,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IAAI,6CAAqB,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,wCAAuB;YACxD,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,QAAQ,YAAY,wCAAuB;YACtD,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC,CAAC;IAEF,uBAAuB,CAAC,kBAAkB,CAAC,uBAAuB,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,gBAAgB,CAAC,CAAC;AACnI,CAAC,CAAC;AAEa,0CAAkB,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,uBAAuB,CAAC,kBAAkB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;SACtE;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, FunctionKey, SpecialKey, UiError, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { CursorInformation } from \"../cursor/CursorInformation\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { ItemProps } from \"../shared/ItemProps\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\n\r\n/** Properties for a Keyboard Shortcut\r\n * @public\r\n */\r\nexport interface KeyboardShortcutProps extends ItemProps {\r\n  /** The key that invokes the shortcut.\r\n   * This is either an alphanumeric key, a function key or a special key.\r\n   */\r\n  key: string | FunctionKey | SpecialKey;\r\n\r\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified. */\r\n  item?: ActionButtonItemDef;\r\n  /** Nested array of shortcut props. Either 'item' or 'shortcuts' must be specified. */\r\n  shortcuts?: KeyboardShortcutProps[];\r\n\r\n  /** Indicates whether the Alt key required. Default - false */\r\n  isAltKeyRequired?: boolean;\r\n  /** Indicates whether the Ctrl key required. Default - false */\r\n  isCtrlKeyRequired?: boolean;\r\n  /** Indicates whether the Shift key required. Default - false */\r\n  isShiftKeyRequired?: boolean;\r\n}\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport class KeyboardShortcut extends ItemDefBase {\r\n\r\n  private _key: string;\r\n  private _item?: ActionButtonItemDef;\r\n  private _shortcuts: KeyboardShortcutContainer;\r\n\r\n  private _isAltKeyRequired: boolean = false;\r\n  private _isCtrlKeyRequired: boolean = false;\r\n  private _isShiftKeyRequired: boolean = false;\r\n  private _isFunctionKey: boolean = false;\r\n  private _isSpecialKey: boolean = false;\r\n\r\n  constructor(props: KeyboardShortcutProps) {\r\n    super(props);\r\n\r\n    this._key = props.key;\r\n\r\n    if (this._key in FunctionKey)\r\n      this._isFunctionKey = true;\r\n    if (this._key in SpecialKey)\r\n      this._isSpecialKey = true;\r\n\r\n    this._shortcuts = new KeyboardShortcutContainer();\r\n\r\n    if (props.item) {\r\n      this._item = props.item;\r\n\r\n      // Copy over icon, label & tooltip from the item\r\n      if (!this.iconSpec)\r\n        this.iconSpec = this._item.iconSpec;\r\n      if (!this.label)\r\n        this.setLabel(this._item.label);\r\n      if (!this.tooltip)\r\n        this.setTooltip(this._item.tooltip);\r\n      if (this.isDisabled === undefined)\r\n        this.isDisabled = this._item.isDisabled;\r\n      if (this.isHidden === undefined)\r\n        this.isHidden = this._item.isHidden;\r\n    } else if (props.shortcuts) {\r\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\r\n        const shortcut = new KeyboardShortcut(childProps);\r\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n      });\r\n    } else {\r\n      throw new UiError(UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);\r\n    }\r\n\r\n    if (props.isAltKeyRequired !== undefined)\r\n      this._isAltKeyRequired = props.isAltKeyRequired;\r\n    if (props.isCtrlKeyRequired !== undefined)\r\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\r\n    if (props.isShiftKeyRequired !== undefined)\r\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\r\n  }\r\n\r\n  /** Returns the id for this shortcut */\r\n  public get id(): string { return this.keyMapKey; }\r\n\r\n  /** Returns the shortcut container */\r\n  public get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Finds a shortcut with a given key in the shortcut's container */\r\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(mapKey);\r\n  }\r\n\r\n  /** Returns the shortcut's key map key used as the id */\r\n  public get keyMapKey(): string {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n  public get item(): ActionButtonItemDef | undefined {\r\n    return this._item;\r\n  }\r\n\r\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n  public itemPicked(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    } else {\r\n      setTimeout(() => {\r\n        // istanbul ignore else\r\n        if (this._item)\r\n          this._item.execute();\r\n      });\r\n    }\r\n  }\r\n\r\n  /** Gets the keyboard key */\r\n  public get key(): string { return this._key; }\r\n  /** Gets whether the Alt key required. */\r\n  public get isAltKeyRequired(): boolean { return this._isAltKeyRequired; }\r\n  /** Gets whether the Ctrl key required. */\r\n  public get isCtrlKeyRequired(): boolean { return this._isCtrlKeyRequired; }\r\n  /** Gets whether the Shift key required. */\r\n  public get isShiftKeyRequired(): boolean { return this._isShiftKeyRequired; }\r\n  /** Gets whether this is a Function key. */\r\n  public get isFunctionKey(): boolean { return this._isFunctionKey; }\r\n  /** Gets whether this is a Special key. */\r\n  public get isSpecialKey(): boolean { return this._isSpecialKey; }\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport class KeyboardShortcutContainer {\r\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<string, KeyboardShortcut>();\r\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\r\n\r\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n  public registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined {\r\n    let shortcut: KeyboardShortcut | undefined;\r\n\r\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\r\n      shortcut = inShortcut;\r\n      this._keyArray.push(shortcut);\r\n    } else {\r\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\r\n        return value.keyMapKey === keyMapKey;\r\n      });\r\n      // istanbul ignore else\r\n      if (index >= 0) {\r\n        shortcut = inShortcut;\r\n        this._keyArray[index] = shortcut;\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (shortcut)\r\n      this._keyMap.set(keyMapKey, shortcut);\r\n\r\n    return shortcut;\r\n  }\r\n\r\n  /** Finds a Keyboard Shortcut associated with a given key */\r\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._keyMap.get(keyMapKey);\r\n  }\r\n\r\n  /** Determines if any Keyboard Shortcuts are available in this container */\r\n  public areKeyboardShortcutsAvailable(): boolean {\r\n    return this._keyMap.size !== 0;\r\n  }\r\n\r\n  /** Empties any Keyboard Shortcuts from this container */\r\n  public emptyData(): void {\r\n    this._keyMap.clear();\r\n    this._keyArray.length = 0;\r\n  }\r\n\r\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\r\n    return this._keyArray.slice();\r\n  }\r\n\r\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\r\n  public static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string {\r\n    let keyMapKey = keyboardKey;\r\n\r\n    if (isAltKeyRequired)\r\n      keyMapKey = `Alt+${keyMapKey}`;\r\n    if (isShiftKeyRequired)\r\n      keyMapKey = `Shift+${keyMapKey}`;\r\n    if (isCtrlKeyRequired)\r\n      keyMapKey = `Ctrl+${keyMapKey}`;\r\n\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Displays a menu for the Keyboard Shortcuts in this container */\r\n  public showShortcutsMenu() {\r\n    const offset = 8;\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: true,\r\n      menuX: KeyboardShortcutManager.cursorX - offset,\r\n      menuY: KeyboardShortcutManager.cursorY - offset,\r\n      shortcuts: this.getAvailableKeyboardShortcuts(),\r\n    });\r\n  }\r\n}\r\n\r\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\r\n\r\n/** Keyboard Shortcut Manager\r\n * @public\r\n */\r\nexport class KeyboardShortcutManager {\r\n\r\n  private static _shortcuts: KeyboardShortcutContainer = new KeyboardShortcutContainer();\r\n\r\n  /** Initialize the Keyboard Shortcut manager */\r\n  public static initialize(): void {\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(KeyboardShortcutManager._handleSyncUiEvent);\r\n  }\r\n\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]) {\r\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\r\n      this.loadKeyboardShortcut(shortcutProps);\r\n    });\r\n  }\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  public static loadKeyboardShortcut(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 displayShortcutsMenu(): 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 closeShortcutsMenu(): 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    KeyboardShortcutManager._traverseShortcuts(KeyboardShortcutManager._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        KeyboardShortcutManager._traverseShortcuts(childShortcuts, callback);\r\n      }\r\n    });\r\n  };\r\n\r\n}\r\n"]}
+{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../../src/appui-react/keyboardshortcut/KeyboardShortcut.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAyE;AAEzE,uDAAoD;AAEpD,gDAA6C;AAC7C,iEAA8D;AAC9D,yEAAyF;AAEzF;;GAEG;AACH,MAAa,gBAAiB,SAAQ,yBAAW;IAY/C,YAAY,KAA4B;QACtC,KAAK,CAAC,KAAK,CAAC,CAAC;QAPP,sBAAiB,GAAY,KAAK,CAAC;QACnC,uBAAkB,GAAY,KAAK,CAAC;QACpC,wBAAmB,GAAY,KAAK,CAAC;QACrC,mBAAc,GAAY,KAAK,CAAC;QAChC,kBAAa,GAAY,KAAK,CAAC;QAKrC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC;QAEtB,IAAI,IAAI,CAAC,IAAI,IAAI,4BAAW;YAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,IAAI,IAAI,CAAC,IAAI,IAAI,2BAAU;YACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE;YACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAChB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACtC,IAAI,CAAC,IAAI,CAAC,KAAK;gBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,CAAC,OAAO;gBACf,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;gBAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;gBAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;SACvC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE;YAC1B,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,UAAiC,EAAE,EAAE;gBAC5D,MAAM,QAAQ,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAC5D,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uDAAuD,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;SAC/H;QAED,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS;YACtC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAClD,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS;YACvC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpD,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS;YACxC,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IACxD,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElD,qCAAqC;IACrC,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,oEAAoE;IAC7D,WAAW,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,wDAAwD;IACxD,IAAW,SAAS;QAClB,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACnJ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,wEAAwE;IACxE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,uFAAuF;IAChF,UAAU;QACf,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE;YACnD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;SACrC;aAAM;YACL,UAAU,CAAC,GAAG,EAAE;gBACd,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK;oBACZ,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG,KAAa,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,yCAAyC;IACzC,IAAW,gBAAgB,KAAc,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACzE,0CAA0C;IAC1C,IAAW,iBAAiB,KAAc,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3E,2CAA2C;IAC3C,IAAW,kBAAkB,KAAc,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7E,2CAA2C;IAC3C,IAAW,aAAa,KAAc,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IACnE,0CAA0C;IAC1C,IAAW,YAAY,KAAc,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;CAElE;AAzGD,4CAyGC;AAED;;GAEG;AACH,MAAa,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAA4B,CAAC;QAC7E,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAuExE,CAAC;IArEC,oFAAoF;IAC7E,WAAW,CAAC,SAAiB,EAAE,UAA4B;QAChE,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE;YACtD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAC/B;aAAM;YACL,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,KAAuB,EAAE,EAAE;gBACjE,OAAO,KAAK,CAAC,SAAS,KAAK,SAAS,CAAC;YACvC,CAAC,CAAC,CAAC;YACH,uBAAuB;YACvB,IAAI,KAAK,IAAI,CAAC,EAAE;gBACd,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;aAClC;SACF;QAED,uBAAuB;QACvB,IAAI,QAAQ;YACV,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAExC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,4DAA4D;IACrD,OAAO,CAAC,SAAiB;QAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,2EAA2E;IACpE,6BAA6B;QAClC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,CAAC;IACjC,CAAC;IAED,yDAAyD;IAClD,SAAS;QACd,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAC5B,CAAC;IAEM,6BAA6B;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,iBAAiB,CAAC,WAAmB,EAAE,gBAAyB,EAAE,iBAA0B,EAAE,kBAA2B;QACrI,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAClB,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACjC,IAAI,kBAAkB;YACpB,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACnC,IAAI,iBAAiB;YACnB,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAElC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,2CAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,yBAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,KAAK,EAAE,yBAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AAzED,8DAyEC;AAED;;;GAGG;AACH,MAAa,uBAAuB;IAClC;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,0DAAQ,CAAC,UAAU,EAAE,CAAC;IACxB,CAAC;IAED,qDAAqD;IAC9C,MAAM,CAAC,qBAAqB,CAAC,YAAqC;QACvE,OAAO,0DAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,oBAAoB,CAAC,aAAoC;QACrE,OAAO,0DAAQ,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,UAAU,CAAC,WAAmB,EAAE,kBAA2B,KAAK,EAAE,mBAA4B,KAAK,EAAE,oBAA6B,KAAK;QACnJ,OAAO,0DAAQ,CAAC,UAAU,CAAC,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,CAAC,CAAC;IAChG,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,iBAAiB;QACjC,OAAO,0DAAQ,CAAC,iBAAiB,CAAC;IACpC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW,CAAC,SAAiB;QACzC,OAAO,0DAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,yCAAyC;IAClC,MAAM,KAAK,aAAa;QAC7B,OAAO,0DAAQ,CAAC,aAAa,CAAC;IAChC,CAAC;IAED,yBAAyB;IAClB,MAAM,CAAC,cAAc;QAC1B,OAAO,0DAAQ,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,oBAAoB;QAChC,OAAO,0DAAQ,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,yCAAyC;IAClC,MAAM,CAAC,kBAAkB;QAC9B,OAAO,0DAAQ,CAAC,SAAS,EAAE,CAAC;IAC9B,CAAC;IAED,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,0DAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IAChE,gEAAgE;IACzD,MAAM,KAAK,OAAO,KAAa,OAAO,0DAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;CACjE;AAzDD,0DAyDC","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 { FunctionKey, SpecialKey, UiError } from \"@itwin/appui-abstract\";\r\nimport { ActionButtonItemDef } from \"../shared/ActionButtonItemDef\";\r\nimport { ItemDefBase } from \"../shared/ItemDefBase\";\r\nimport { KeyboardShortcutProps } from \"../framework/FrameworkKeyboardShortcuts\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu\";\r\nimport { InternalKeyboardShortcutManager as internal } from \"./InternalKeyboardShortcut\";\r\n\r\n/** Keyboard Shortcut used to execute an action\r\n * @public\r\n */\r\nexport class KeyboardShortcut extends ItemDefBase {\r\n\r\n  private _key: string;\r\n  private _item?: ActionButtonItemDef;\r\n  private _shortcuts: KeyboardShortcutContainer;\r\n\r\n  private _isAltKeyRequired: boolean = false;\r\n  private _isCtrlKeyRequired: boolean = false;\r\n  private _isShiftKeyRequired: boolean = false;\r\n  private _isFunctionKey: boolean = false;\r\n  private _isSpecialKey: boolean = false;\r\n\r\n  constructor(props: KeyboardShortcutProps) {\r\n    super(props);\r\n\r\n    this._key = props.key;\r\n\r\n    if (this._key in FunctionKey)\r\n      this._isFunctionKey = true;\r\n    if (this._key in SpecialKey)\r\n      this._isSpecialKey = true;\r\n\r\n    this._shortcuts = new KeyboardShortcutContainer();\r\n\r\n    if (props.item) {\r\n      this._item = props.item;\r\n\r\n      // Copy over icon, label & tooltip from the item\r\n      if (!this.iconSpec)\r\n        this.iconSpec = this._item.iconSpec;\r\n      if (!this.label)\r\n        this.setLabel(this._item.label);\r\n      if (!this.tooltip)\r\n        this.setTooltip(this._item.tooltip);\r\n      if (this.isDisabled === undefined)\r\n        this.isDisabled = this._item.isDisabled;\r\n      if (this.isHidden === undefined)\r\n        this.isHidden = this._item.isHidden;\r\n    } else if (props.shortcuts) {\r\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\r\n        const shortcut = new KeyboardShortcut(childProps);\r\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\r\n      });\r\n    } else {\r\n      throw new UiError(UiFramework.loggerCategory(this), `Either 'item' or 'shortcuts' must be specified for '${props.key}' key.`);\r\n    }\r\n\r\n    if (props.isAltKeyRequired !== undefined)\r\n      this._isAltKeyRequired = props.isAltKeyRequired;\r\n    if (props.isCtrlKeyRequired !== undefined)\r\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\r\n    if (props.isShiftKeyRequired !== undefined)\r\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\r\n  }\r\n\r\n  /** Returns the id for this shortcut */\r\n  public get id(): string { return this.keyMapKey; }\r\n\r\n  /** Returns the shortcut container */\r\n  public get shortcutContainer(): KeyboardShortcutContainer {\r\n    return this._shortcuts;\r\n  }\r\n\r\n  /** Finds a shortcut with a given key in the shortcut's container */\r\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\r\n    return this._shortcuts.findKey(mapKey);\r\n  }\r\n\r\n  /** Returns the shortcut's key map key used as the id */\r\n  public get keyMapKey(): string {\r\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\r\n  public get item(): ActionButtonItemDef | undefined {\r\n    return this._item;\r\n  }\r\n\r\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\r\n  public itemPicked(): void {\r\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\r\n      this._shortcuts.showShortcutsMenu();\r\n    } else {\r\n      setTimeout(() => {\r\n        // istanbul ignore else\r\n        if (this._item)\r\n          this._item.execute();\r\n      });\r\n    }\r\n  }\r\n\r\n  /** Gets the keyboard key */\r\n  public get key(): string { return this._key; }\r\n  /** Gets whether the Alt key required. */\r\n  public get isAltKeyRequired(): boolean { return this._isAltKeyRequired; }\r\n  /** Gets whether the Ctrl key required. */\r\n  public get isCtrlKeyRequired(): boolean { return this._isCtrlKeyRequired; }\r\n  /** Gets whether the Shift key required. */\r\n  public get isShiftKeyRequired(): boolean { return this._isShiftKeyRequired; }\r\n  /** Gets whether this is a Function key. */\r\n  public get isFunctionKey(): boolean { return this._isFunctionKey; }\r\n  /** Gets whether this is a Special key. */\r\n  public get isSpecialKey(): boolean { return this._isSpecialKey; }\r\n\r\n}\r\n\r\n/** Keyboard Shortcut Container\r\n * @public\r\n */\r\nexport class KeyboardShortcutContainer {\r\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<string, KeyboardShortcut>();\r\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\r\n\r\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\r\n  public registerKey(keyMapKey: string, inShortcut: KeyboardShortcut): KeyboardShortcut | undefined {\r\n    let shortcut: KeyboardShortcut | undefined;\r\n\r\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\r\n      shortcut = inShortcut;\r\n      this._keyArray.push(shortcut);\r\n    } else {\r\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\r\n        return value.keyMapKey === keyMapKey;\r\n      });\r\n      // istanbul ignore else\r\n      if (index >= 0) {\r\n        shortcut = inShortcut;\r\n        this._keyArray[index] = shortcut;\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (shortcut)\r\n      this._keyMap.set(keyMapKey, shortcut);\r\n\r\n    return shortcut;\r\n  }\r\n\r\n  /** Finds a Keyboard Shortcut associated with a given key */\r\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\r\n    return this._keyMap.get(keyMapKey);\r\n  }\r\n\r\n  /** Determines if any Keyboard Shortcuts are available in this container */\r\n  public areKeyboardShortcutsAvailable(): boolean {\r\n    return this._keyMap.size !== 0;\r\n  }\r\n\r\n  /** Empties any Keyboard Shortcuts from this container */\r\n  public emptyData(): void {\r\n    this._keyMap.clear();\r\n    this._keyArray.length = 0;\r\n  }\r\n\r\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\r\n    return this._keyArray.slice();\r\n  }\r\n\r\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\r\n  public static generateKeyMapKey(keyboardKey: string, isAltKeyRequired: boolean, isCtrlKeyRequired: boolean, isShiftKeyRequired: boolean): string {\r\n    let keyMapKey = keyboardKey;\r\n\r\n    if (isAltKeyRequired)\r\n      keyMapKey = `Alt+${keyMapKey}`;\r\n    if (isShiftKeyRequired)\r\n      keyMapKey = `Shift+${keyMapKey}`;\r\n    if (isCtrlKeyRequired)\r\n      keyMapKey = `Ctrl+${keyMapKey}`;\r\n\r\n    return keyMapKey;\r\n  }\r\n\r\n  /** Displays a menu for the Keyboard Shortcuts in this container */\r\n  public showShortcutsMenu() {\r\n    const offset = 8;\r\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\r\n      menuVisible: true,\r\n      menuX: UiFramework.keyboardShortcuts.cursorX - offset,\r\n      menuY: UiFramework.keyboardShortcuts.cursorY - offset,\r\n      shortcuts: this.getAvailableKeyboardShortcuts(),\r\n    });\r\n  }\r\n}\r\n\r\n/** Keyboard Shortcut Manager\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.keyboardShortcuts` property.\r\n */\r\nexport class KeyboardShortcutManager {\r\n  /** Initialize the Keyboard Shortcut manager\r\n   * @deprecated in 3.7. This is called internally.\r\n  */\r\n  public static initialize(): void {\r\n    internal.initialize();\r\n  }\r\n\r\n  /** Loads Keyboard Shortcuts into the managed list */\r\n  public static loadKeyboardShortcuts(shortcutList: KeyboardShortcutProps[]) {\r\n    return internal.loadShortcuts(shortcutList);\r\n  }\r\n\r\n  /** Loads a Keyboard Shortcut into the managed list */\r\n  public static loadKeyboardShortcut(shortcutProps: KeyboardShortcutProps) {\r\n    return internal.loadShortcut(shortcutProps);\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    return internal.processKey(keyboardKey, isAltKeyPressed, isCtrlKeyPressed, isShiftKeyPressed);\r\n  }\r\n\r\n  /** Returns the managed list of Keyboard Shortcuts */\r\n  public static get shortcutContainer(): KeyboardShortcutContainer {\r\n    return internal.shortcutContainer;\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 internal.getShortcut(keyMapKey);\r\n  }\r\n\r\n  /** Determines if focus is set to Home */\r\n  public static get isFocusOnHome(): boolean {\r\n    return internal.isFocusOnHome;\r\n  }\r\n\r\n  /** Sets focus to Home */\r\n  public static setFocusToHome(): void {\r\n    return internal.setFocusToHome();\r\n  }\r\n\r\n  /** Displays the Keyboard Shortcuts menu at the cursor */\r\n  public static displayShortcutsMenu(): void {\r\n    return internal.displayMenu();\r\n  }\r\n\r\n  /** Closes the Keyboard Shortcuts menu */\r\n  public static closeShortcutsMenu(): void {\r\n    return internal.closeMenu();\r\n  }\r\n\r\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\r\n  public static get cursorX(): number { return internal.cursorX; }\r\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\r\n  public static get cursorY(): number { return internal.cursorY; }\r\n}\r\n\r\n"]}

package/lib/cjs/appui-react/messages/ActivityMessage.d.ts

@@ -2,44 +2,9 @@
  * @module Notification
  */
 /// <reference types="react" />
-import { ActivityMessageEventArgs } from "../messages/MessageManager";
-import { ToasterSettings } from "@itwin/itwinui-react/cjs/core/Toast/Toaster";
-/** Properties for a [[ActivityMessage]]
- * @deprecated in 3.5. Props of a deprecated component.
- * @public
- */
-export interface ActivityMessageProps {
-    activityMessageInfo: ActivityMessageEventArgs;
-    cancelActivityMessage: () => void;
-    dismissActivityMessage: () => void;
-}
-/** Activity Message React component
- * @public
- * @deprecated in 3.3.
- */
-export declare function ActivityMessage(props: ActivityMessageProps): JSX.Element;
-interface CustomActivityMessageProps {
-    cancelActivityMessage?: () => void;
-    dismissActivityMessage?: () => void;
-    activityMessageInfo?: ActivityMessageEventArgs;
-    settings?: ToasterSettings;
-}
-/**
- * Hook to render an Activity message.
- * @internal
- */
-export declare function useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings }: CustomActivityMessageProps): void;
 /**
  * Component wrapping the `useActivityMessage` hook to use in class components.
  * @internal
  */
-export declare function CustomActivityMessageRenderer({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings }: CustomActivityMessageProps): JSX.Element;
-/**
- * Component used to show and update activity message content.
- * @internal
- */
-export declare function CustomActivityMessageContent({ initialActivityMessageInfo }: {
-    initialActivityMessageInfo: ActivityMessageEventArgs;
-}): JSX.Element;
-export {};
+export declare function ActivityMessageRenderer(): JSX.Element;
 //# sourceMappingURL=ActivityMessage.d.ts.map

package/lib/cjs/appui-react/messages/ActivityMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActivityMessage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAcH,OAAO,EAAE,wBAAwB,EAAkB,MAAM,4BAA4B,CAAC;AAGtF,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAC;AAE9E;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB,EAAE,wBAAwB,CAAC;IAC9C,qBAAqB,EAAE,MAAM,IAAI,CAAC;IAClC,sBAAsB,EAAE,MAAM,IAAI,CAAC;CACpC;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,eA0C1D;AAED,UAAU,0BAA0B;IAClC,qBAAqB,CAAC,EAAE,MAAM,IAAI,CAAC;IACnC,sBAAsB,CAAC,EAAE,MAAM,IAAI,CAAC;IACpC,mBAAmB,CAAC,EAAE,wBAAwB,CAAC;IAC/C,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAAC,EAAE,0BAA0B,QAkB5I;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAAC,EAAE,0BAA0B,eAIvJ;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,EAAC,0BAA0B,EAAC,EAAE;IAAC,0BAA0B,EAAE,wBAAwB,CAAA;CAAC,eAqBhI"}
+{"version":3,"file":"ActivityMessage.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAsCH;;;GAGG;AACH,wBAAgB,uBAAuB,gBAoBtC"}

package/lib/cjs/appui-react/messages/ActivityMessage.js

@@ -7,73 +7,60 @@
  * @module Notification
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomActivityMessageContent = exports.CustomActivityMessageRenderer = exports.useActivityMessage = exports.ActivityMessage = void 0;
+exports.ActivityMessageRenderer = void 0;
 const React = require("react");
 const core_react_1 = require("@itwin/core-react");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
 const itwinui_react_1 = require("@itwin/itwinui-react");
 const UiFramework_1 = require("../UiFramework");
 const MessageManager_1 = require("../messages/MessageManager");
-const MessageLabel_1 = require("./MessageLabel");
-const HollowIcon_1 = require("./HollowIcon");
-/** Activity Message React component
- * @public
- * @deprecated in 3.3.
- */
-function ActivityMessage(props) {
-    const messageDetails = props.activityMessageInfo.details;
-    const [percentCompleteLabel] = React.useState(UiFramework_1.UiFramework.translate("activityCenter.percentComplete"));
-    const [cancelLabel] = React.useState(core_react_1.UiCore.translate("dialog.cancel"));
-    return (React.createElement(appui_layout_react_1.Message // eslint-disable-line deprecation/deprecation
-    , { status: appui_layout_react_1.Status.Information, icon: React.createElement(HollowIcon_1.HollowIcon, { iconSpec: "icon-info-hollow" }) },
-        React.createElement(appui_layout_react_1.MessageLayout, { buttons: (messageDetails && messageDetails.supportsCancellation) ? (React.createElement("div", null,
-                React.createElement(appui_layout_react_1.MessageHyperlink, { onClick: props.cancelActivityMessage }, cancelLabel),
-                React.createElement("span", null, "\u00A0"),
-                React.createElement(appui_layout_react_1.MessageButton, { onClick: props.dismissActivityMessage },
-                    React.createElement(core_react_1.Icon, { iconSpec: "icon-close" })))) : (React.createElement(appui_layout_react_1.MessageButton, { onClick: props.dismissActivityMessage },
-                React.createElement(core_react_1.Icon, { iconSpec: "icon-close" }))), progress: (messageDetails && messageDetails.showProgressBar) &&
-                React.createElement(appui_layout_react_1.MessageProgress, { status: appui_layout_react_1.Status.Information, progress: props.activityMessageInfo.percentage }) },
-            React.createElement("div", null,
-                React.createElement(MessageLabel_1.MessageLabel, { message: props.activityMessageInfo.message, className: "uifw-statusbar-message-brief" }),
-                (messageDetails && messageDetails.showPercentInMessage) &&
-                    React.createElement(itwinui_react_1.Small, null, props.activityMessageInfo.percentage + percentCompleteLabel)))));
-}
-exports.ActivityMessage = ActivityMessage;
 /**
  * Hook to render an Activity message.
  * @internal
  */
-function useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings }) {
+function useActivityMessage({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage }) {
     const [cancelLabel] = React.useState(core_react_1.UiCore.translate("dialog.cancel"));
     const recentToast = React.useRef();
     React.useEffect(() => {
-        itwinui_react_1.toaster.setSettings(settings !== null && settings !== void 0 ? settings : { placement: "top" });
-    }, [settings]);
+        itwinui_react_1.toaster.setSettings({ placement: "bottom" });
+    }, []);
     React.useEffect(() => {
         var _a, _b;
         if (activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.restored) {
-            recentToast.current = itwinui_react_1.toaster.informational(React.createElement(CustomActivityMessageContent, { initialActivityMessageInfo: activityMessageInfo }), { onRemove: dismissActivityMessage, type: "persisting", link: ((_a = activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.supportsCancellation) && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined });
+            recentToast.current = itwinui_react_1.toaster.informational(React.createElement(ActivityMessageContent, { initialActivityMessageInfo: activityMessageInfo }), { onRemove: dismissActivityMessage, type: "persisting", link: ((_a = activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.supportsCancellation) && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined });
         }
         if (!activityMessageInfo) {
             (_b = recentToast.current) === null || _b === void 0 ? void 0 : _b.close();
         }
     }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);
 }
-exports.useActivityMessage = useActivityMessage;
 /**
  * Component wrapping the `useActivityMessage` hook to use in class components.
  * @internal
  */
-function CustomActivityMessageRenderer({ activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings }) {
-    useActivityMessage({ activityMessageInfo, cancelActivityMessage, dismissActivityMessage, settings });
+function ActivityMessageRenderer() {
+    const [activityMessageInfo, setActivityMessageInfo] = React.useState();
+    React.useEffect(() => {
+        return MessageManager_1.MessageManager.onActivityMessageUpdatedEvent.addListener((args) => {
+            setActivityMessageInfo(args);
+        });
+    }, []);
+    React.useEffect(() => {
+        return MessageManager_1.MessageManager.onActivityMessageCancelledEvent.addListener(() => {
+            setActivityMessageInfo(undefined);
+        });
+    }, []);
+    const cancelActivityMessage = React.useCallback(() => {
+        MessageManager_1.MessageManager.endActivityMessage(false);
+    }, []);
+    useActivityMessage({ activityMessageInfo, cancelActivityMessage });
     return React.createElement(React.Fragment, null);
 }
-exports.CustomActivityMessageRenderer = CustomActivityMessageRenderer;
+exports.ActivityMessageRenderer = ActivityMessageRenderer;
 /**
  * Component used to show and update activity message content.
  * @internal
  */
-function CustomActivityMessageContent({ initialActivityMessageInfo }) {
+function ActivityMessageContent({ initialActivityMessageInfo }) {
     var _a, _b;
     const [percentCompleteLabel] = React.useState(UiFramework_1.UiFramework.translate("activityCenter.percentComplete"));
     const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);
@@ -84,10 +71,10 @@ function CustomActivityMessageContent({ initialActivityMessageInfo }) {
         return MessageManager_1.MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);
     }, []);
     return (React.createElement(React.Fragment, null,
-        activityMessageInfo.message && React.createElement(itwinui_react_1.Text, null, activityMessageInfo.message),
+        activityMessageInfo.message && React.createElement(itwinui_react_1.Text, null,
+            React.createElement(React.Fragment, null, activityMessageInfo.message.reactNode || activityMessageInfo.message)),
         !!((_a = activityMessageInfo.details) === null || _a === void 0 ? void 0 : _a.showPercentInMessage) &&
             React.createElement(itwinui_react_1.Small, null, `${activityMessageInfo.percentage} ${percentCompleteLabel}`),
         ((_b = activityMessageInfo.details) === null || _b === void 0 ? void 0 : _b.showProgressBar) && React.createElement(itwinui_react_1.ProgressLinear, { value: activityMessageInfo === null || activityMessageInfo === void 0 ? void 0 : activityMessageInfo.percentage })));
 }
-exports.CustomActivityMessageContent = CustomActivityMessageContent;
 //# sourceMappingURL=ActivityMessage.js.map