@itwin/appui-react 4.17.1 → 5.0.0-dev.2

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

@@ -0,0 +1,112 @@
+/*---------------------------------------------------------------------------------------------
+ * 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.js";
+import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu.js";
+import { KeyboardShortcut, KeyboardShortcutContainer, } from "./KeyboardShortcut.js";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher.js";
+/** 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);
+        }
+    });
+};
+//# sourceMappingURL=InternalKeyboardShortcut.js.map

package/lib/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;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EACL,gBAAgB,EAChB,yBAAyB,GAC1B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAQ3E;;GAEG;AACH,MAAM,OAAO,+BAA+B;IAI1C;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAC7C,+BAA+B,CAAC,kBAAkB,CACnD,CAAC;IACJ,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,CACtB,WAAmB,EACnB,kBAA2B,KAAK,EAChC,mBAA4B,KAAK,EACjC,oBAA6B,KAAK;QAElC,MAAM,SAAS,GAAG,yBAAyB,CAAC,iBAAiB,CAC3D,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,iBAAiB,CAClB,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,QAAQ,EAAE,CAAC;YACb,QAAQ,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QACd,CAAC;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,CAAC;YACzC,OAAO,CAAC,IAAI,EAAE,CAAC;YACf,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,CAAC;IACH,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,WAAW;QACvB,IAAI,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;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;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IACD,gEAAgE;IACzD,MAAM,KAAK,OAAO;QACvB,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;;AAjGc,0CAAU,GACvB,IAAI,yBAAyB,EAAE,CAAC;AAkGnB,kDAAkB,GAE7B,CAAC,IAAI,EAAE,EAAE;IACX,MAAM,kBAAkB,GAAG,CAAC,YAAqC,EAAE,EAAE;QACnE,IACE,qBAAqB,CAAC,kBAAkB,CACtC,IAAI,CAAC,QAAQ,EACb,YAAY,CAAC,YAAY,CAC1B;YAED,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,CAChD,+BAA+B,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAC1E,gBAAgB,CACjB,CAAC;AACJ,CAAC,CAAC;AAEa,kDAAkB,GAAG,CAClC,SAA6B,EAC7B,QAAwB,EACxB,EAAE;IACF,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,EAAE;QAC/C,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEnB,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE,CAAC;YAC/D,MAAM,cAAc,GAClB,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,+BAA+B,CAAC,kBAAkB,CAChD,cAAc,EACd,QAAQ,CACT,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\n\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\nimport { CursorInformation } from \"../cursor/CursorInformation.js\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu.js\";\nimport {\n  KeyboardShortcut,\n  KeyboardShortcutContainer,\n} from \"./KeyboardShortcut.js\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher.js\";\nimport type { KeyboardShortcutProps } from \"./KeyboardShortcutProps.js\";\nimport type { ListenerType } from \"@itwin/core-react/internal\";\n\n/* eslint-disable deprecation/deprecation */\n\ntype OnShortcutFunc = (shortcut: KeyboardShortcut) => void;\n\n/** Keyboard Shortcut Manager\n * @internal\n */\nexport class InternalKeyboardShortcutManager {\n  private static _shortcuts: KeyboardShortcutContainer =\n    new KeyboardShortcutContainer();\n\n  /** Initialize the Keyboard Shortcut manager\n   * @internal\n   */\n  public static initialize(): void {\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(\n      InternalKeyboardShortcutManager._handleSyncUiEvent\n    );\n  }\n\n  /** Loads Keyboard Shortcuts into the managed list */\n  public static loadShortcuts(shortcutList: KeyboardShortcutProps[]) {\n    shortcutList.forEach((shortcutProps: KeyboardShortcutProps) => {\n      this.loadShortcut(shortcutProps);\n    });\n  }\n\n  /** Loads a Keyboard Shortcut into the managed list */\n  public static loadShortcut(shortcutProps: KeyboardShortcutProps) {\n    const shortcut = new KeyboardShortcut(shortcutProps);\n    this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n  }\n\n  /** Processes a keystroke and invokes a matching Keyboard Shortcut */\n  public static processKey(\n    keyboardKey: string,\n    isAltKeyPressed: boolean = false,\n    isCtrlKeyPressed: boolean = false,\n    isShiftKeyPressed: boolean = false\n  ): boolean {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      keyboardKey,\n      isAltKeyPressed,\n      isCtrlKeyPressed,\n      isShiftKeyPressed\n    );\n\n    const shortcut = this.getShortcut(keyMapKey);\n    if (shortcut) {\n      shortcut.itemPicked();\n      return true;\n    }\n\n    return false;\n  }\n\n  /** Returns the managed list of Keyboard Shortcuts */\n  public static get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Returns a Keyboard Shortcut from the managed lists */\n  public static getShortcut(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(keyMapKey);\n  }\n\n  /** Determines if focus is set to Home */\n  public static get isFocusOnHome(): boolean {\n    const element = document.activeElement as HTMLElement;\n    return element && element === document.body;\n  }\n\n  /** Sets focus to Home */\n  public static setFocusToHome(): void {\n    const element = document.activeElement as HTMLElement;\n    if (element && element !== document.body) {\n      element.blur();\n      document.body.focus();\n    }\n  }\n\n  /** Displays the Keyboard Shortcuts menu at the cursor */\n  public static displayMenu(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    }\n  }\n\n  /** Closes the Keyboard Shortcuts menu */\n  public static closeMenu(): void {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: false,\n      menuX: 0,\n      menuY: 0,\n      shortcuts: undefined,\n    });\n  }\n\n  /** Returns the cursor X position, which is mouseEvent.pageX. */\n  public static get cursorX(): number {\n    return CursorInformation.cursorX;\n  }\n  /** Returns the cursor Y position, which is mouseEvent.pageY. */\n  public static get cursorY(): number {\n    return CursorInformation.cursorY;\n  }\n\n  private static _handleSyncUiEvent: ListenerType<\n    typeof SyncUiEventDispatcher.onSyncUiEvent\n  > = (args) => {\n    const updateBooleanValue = (booleanValue: ConditionalBooleanValue) => {\n      if (\n        SyncUiEventDispatcher.hasEventOfInterest(\n          args.eventIds,\n          booleanValue.syncEventIds\n        )\n      )\n        booleanValue.refresh();\n    };\n    const handleForSyncIds = (shortcut: KeyboardShortcut) => {\n      if (shortcut.isDisabled instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isDisabled);\n      if (shortcut.isHidden instanceof ConditionalBooleanValue)\n        updateBooleanValue(shortcut.isHidden);\n    };\n\n    InternalKeyboardShortcutManager._traverseShortcuts(\n      InternalKeyboardShortcutManager._shortcuts.getAvailableKeyboardShortcuts(),\n      handleForSyncIds\n    );\n  };\n\n  private static _traverseShortcuts = (\n    shortcuts: KeyboardShortcut[],\n    callback: OnShortcutFunc\n  ) => {\n    shortcuts.forEach((shortcut: KeyboardShortcut) => {\n      callback(shortcut);\n\n      if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n        const childShortcuts =\n          shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n        InternalKeyboardShortcutManager._traverseShortcuts(\n          childShortcuts,\n          callback\n        );\n      }\n    });\n  };\n}\n"]}

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

@@ -0,0 +1,68 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef.js";
+import { ItemDefBase } from "../shared/ItemDefBase.js";
+import type { KeyboardShortcutProps } from "./KeyboardShortcutProps.js";
+/** Keyboard Shortcut used to execute an action
+ * @public
+ * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.
+ */
+export declare class KeyboardShortcut extends ItemDefBase {
+    private _key;
+    private _item?;
+    private _shortcuts;
+    private _execute?;
+    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
+ * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.
+ */
+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;
+}
+//# sourceMappingURL=KeyboardShortcut.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcut.d.ts","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcut.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAGvD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAgDxE;;;GAGG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAC,CAAsB;IACpC,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,QAAQ,CAAC,CAAa;IAE9B,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,CAEtB;IAED,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,CAQ7B;IAED,wEAAwE;IACxE,IAAW,IAAI,IAAI,mBAAmB,GAAG,SAAS,CAEjD;IAED,uFAAuF;IAChF,UAAU,IAAI,IAAI;IAWzB,4BAA4B;IAC5B,IAAW,GAAG,IAAI,MAAM,CAEvB;IACD,yCAAyC;IACzC,IAAW,gBAAgB,IAAI,OAAO,CAErC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB,IAAI,OAAO,CAEtC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IACD,2CAA2C;IAC3C,IAAW,aAAa,IAAI,OAAO,CAElC;IACD,0CAA0C;IAC1C,IAAW,YAAY,IAAI,OAAO,CAEjC;CACF;AAED;;;GAGG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,OAAO,CAGX;IACJ,OAAO,CAAC,SAAS,CAAqD;IAEtE,oFAAoF;IAC7E,WAAW,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,gBAAgB,GAC3B,gBAAgB,GAAG,SAAS;IAqB/B,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,CAC7B,WAAW,EAAE,MAAM,EACnB,gBAAgB,EAAE,OAAO,EACzB,iBAAiB,EAAE,OAAO,EAC1B,kBAAkB,EAAE,OAAO,GAC1B,MAAM;IAUT,mEAAmE;IAC5D,iBAAiB;CASzB"}

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

@@ -0,0 +1,234 @@
+/*---------------------------------------------------------------------------------------------
+ * 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 * as React from "react";
+import { UiError } from "@itwin/appui-abstract";
+import { ItemDefBase } from "../shared/ItemDefBase.js";
+import { UiFramework } from "../UiFramework.js";
+import { KeyboardShortcutMenu } from "./KeyboardShortcutMenu.js";
+/* eslint-disable deprecation/deprecation */
+var FunctionKey;
+(function (FunctionKey) {
+    FunctionKey["F1"] = "F1";
+    FunctionKey["F2"] = "F2";
+    FunctionKey["F3"] = "F3";
+    FunctionKey["F4"] = "F4";
+    FunctionKey["F5"] = "F5";
+    FunctionKey["F6"] = "F6";
+    FunctionKey["F7"] = "F7";
+    FunctionKey["F8"] = "F8";
+    FunctionKey["F9"] = "F9";
+    FunctionKey["F10"] = "F10";
+    FunctionKey["F11"] = "F11";
+    FunctionKey["F12"] = "F12";
+})(FunctionKey || (FunctionKey = {}));
+var SpecialKey;
+(function (SpecialKey) {
+    SpecialKey["Home"] = "Home";
+    SpecialKey["End"] = "End";
+    SpecialKey["PageUp"] = "PageUp";
+    SpecialKey["PageDown"] = "PageDown";
+    SpecialKey["Escape"] = "Escape";
+    SpecialKey["Delete"] = "Delete";
+    SpecialKey["Insert"] = "Insert";
+    SpecialKey["Tab"] = "Tab";
+    SpecialKey["ArrowLeft"] = "ArrowLeft";
+    SpecialKey["ArrowRight"] = "ArrowRight";
+    SpecialKey["ArrowUp"] = "ArrowUp";
+    SpecialKey["ArrowDown"] = "ArrowDown";
+    SpecialKey["Enter"] = "Enter";
+    SpecialKey["Return"] = "Enter";
+    SpecialKey["Space"] = " ";
+    SpecialKey["Backspace"] = "Backspace";
+    SpecialKey["Clear"] = "Clear";
+    SpecialKey["Divide"] = "Divide";
+    SpecialKey["Multiply"] = "Multiply";
+    SpecialKey["Subtract"] = "Subtract";
+    SpecialKey["Add"] = "Add";
+    SpecialKey["Decimal"] = "Decimal";
+})(SpecialKey || (SpecialKey = {}));
+/** Keyboard Shortcut used to execute an action
+ * @public
+ * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.
+ */
+export class KeyboardShortcut extends ItemDefBase {
+    constructor(props) {
+        super(props);
+        this._isAltKeyRequired = false;
+        this._isCtrlKeyRequired = false;
+        this._isShiftKeyRequired = false;
+        this._isFunctionKey = false;
+        this._isSpecialKey = false;
+        this._key = props.key;
+        if (this._key in FunctionKey)
+            this._isFunctionKey = true;
+        if (this._key in SpecialKey)
+            this._isSpecialKey = true;
+        this._shortcuts = new KeyboardShortcutContainer();
+        if (props.item) {
+            this._item = props.item;
+            // Copy over icon, label & tooltip from the item
+            if (!this.iconSpec)
+                this.iconSpec = this._item.iconSpec;
+            if (!this.label)
+                this.setLabel(this._item.label);
+            if (!this.tooltip)
+                this.setTooltip(this._item.tooltip);
+            if (this.isDisabled === undefined)
+                this.isDisabled = this._item.isDisabled;
+            if (this.isHidden === undefined)
+                this.isHidden = this._item.isHidden;
+        }
+        else if (props.execute) {
+            this._execute = props.execute;
+        }
+        else if (props.shortcuts) {
+            props.shortcuts.forEach((childProps) => {
+                const shortcut = new KeyboardShortcut(childProps);
+                this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);
+            });
+        }
+        else {
+            throw new UiError(UiFramework.loggerCategory("KeyboardShortcut"), `Either 'item', 'execute' or 'shortcuts' must be specified for '${props.key}' key.`);
+        }
+        if (props.isAltKeyRequired !== undefined)
+            this._isAltKeyRequired = props.isAltKeyRequired;
+        if (props.isCtrlKeyRequired !== undefined)
+            this._isCtrlKeyRequired = props.isCtrlKeyRequired;
+        if (props.isShiftKeyRequired !== undefined)
+            this._isShiftKeyRequired = props.isShiftKeyRequired;
+        if (props.iconNode !== undefined)
+            this.iconSpec = React.createElement(React.Fragment, null, props.iconNode);
+    }
+    /** Returns the id for this shortcut */
+    get id() {
+        return this.keyMapKey;
+    }
+    /** Returns the shortcut container */
+    get shortcutContainer() {
+        return this._shortcuts;
+    }
+    /** Finds a shortcut with a given key in the shortcut's container */
+    getShortcut(mapKey) {
+        return this._shortcuts.findKey(mapKey);
+    }
+    /** Returns the shortcut's key map key used as the id */
+    get keyMapKey() {
+        const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(this.key, this._isAltKeyRequired, this._isCtrlKeyRequired, this._isShiftKeyRequired);
+        return keyMapKey;
+    }
+    /** Returns the [[ActionButtonItemDef]] associated with this shortcut */
+    get item() {
+        return this._item;
+    }
+    /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */
+    itemPicked() {
+        if (this._shortcuts.areKeyboardShortcutsAvailable()) {
+            this._shortcuts.showShortcutsMenu();
+        }
+        else {
+            setTimeout(() => {
+                if (this._item)
+                    this._item.execute();
+                else if (this._execute)
+                    this._execute();
+            });
+        }
+    }
+    /** Gets the keyboard key */
+    get key() {
+        return this._key;
+    }
+    /** Gets whether the Alt key required. */
+    get isAltKeyRequired() {
+        return this._isAltKeyRequired;
+    }
+    /** Gets whether the Ctrl key required. */
+    get isCtrlKeyRequired() {
+        return this._isCtrlKeyRequired;
+    }
+    /** Gets whether the Shift key required. */
+    get isShiftKeyRequired() {
+        return this._isShiftKeyRequired;
+    }
+    /** Gets whether this is a Function key. */
+    get isFunctionKey() {
+        return this._isFunctionKey;
+    }
+    /** Gets whether this is a Special key. */
+    get isSpecialKey() {
+        return this._isSpecialKey;
+    }
+}
+/** Keyboard Shortcut Container
+ * @public
+ * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.
+ */
+export class KeyboardShortcutContainer {
+    constructor() {
+        this._keyMap = new Map();
+        this._keyArray = new Array();
+    }
+    /** Registers a Keyboard Shortcut associated with a given key in the managed list */
+    registerKey(keyMapKey, inShortcut) {
+        let shortcut;
+        if ((shortcut = this.findKey(keyMapKey)) === undefined) {
+            shortcut = inShortcut;
+            this._keyArray.push(shortcut);
+        }
+        else {
+            const index = this._keyArray.findIndex((value) => {
+                return value.keyMapKey === keyMapKey;
+            });
+            if (index >= 0) {
+                shortcut = inShortcut;
+                this._keyArray[index] = shortcut;
+            }
+        }
+        if (shortcut)
+            this._keyMap.set(keyMapKey, shortcut);
+        return shortcut;
+    }
+    /** Finds a Keyboard Shortcut associated with a given key */
+    findKey(keyMapKey) {
+        return this._keyMap.get(keyMapKey);
+    }
+    /** Determines if any Keyboard Shortcuts are available in this container */
+    areKeyboardShortcutsAvailable() {
+        return this._keyMap.size !== 0;
+    }
+    /** Empties any Keyboard Shortcuts from this container */
+    emptyData() {
+        this._keyMap.clear();
+        this._keyArray.length = 0;
+    }
+    getAvailableKeyboardShortcuts() {
+        return this._keyArray.slice();
+    }
+    /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */
+    static generateKeyMapKey(keyboardKey, isAltKeyRequired, isCtrlKeyRequired, isShiftKeyRequired) {
+        let keyMapKey = keyboardKey;
+        if (isAltKeyRequired)
+            keyMapKey = `Alt+${keyMapKey}`;
+        if (isShiftKeyRequired)
+            keyMapKey = `Shift+${keyMapKey}`;
+        if (isCtrlKeyRequired)
+            keyMapKey = `Ctrl+${keyMapKey}`;
+        return keyMapKey;
+    }
+    /** Displays a menu for the Keyboard Shortcuts in this container */
+    showShortcutsMenu() {
+        const offset = 8;
+        KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({
+            menuVisible: true,
+            menuX: UiFramework.keyboardShortcuts.cursorX - offset,
+            menuY: UiFramework.keyboardShortcuts.cursorY - offset,
+            shortcuts: this.getAvailableKeyboardShortcuts(),
+        });
+    }
+}
+//# sourceMappingURL=KeyboardShortcut.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcut.js","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcut.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAOjE,4CAA4C;AAE5C,IAAK,WAaJ;AAbD,WAAK,WAAW;IACd,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,wBAAS,CAAA;IACT,0BAAW,CAAA;IACX,0BAAW,CAAA;IACX,0BAAW,CAAA;AACb,CAAC,EAbI,WAAW,KAAX,WAAW,QAaf;AAED,IAAK,UAuBJ;AAvBD,WAAK,UAAU;IACb,2BAAa,CAAA;IACb,yBAAW,CAAA;IACX,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,+BAAiB,CAAA;IACjB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,8BAAgB,CAAA;IAChB,yBAAW,CAAA;IACX,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;IACrB,mCAAqB,CAAA;IACrB,yBAAW,CAAA;IACX,iCAAmB,CAAA;AACrB,CAAC,EAvBI,UAAU,KAAV,UAAU,QAuBd;AAED;;;GAGG;AACH,MAAM,OAAO,gBAAiB,SAAQ,WAAW;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,WAAW;YAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,IAAI,IAAI,UAAU;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAEvD,IAAI,CAAC,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;QAElD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;YAExB,gDAAgD;YAChD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;YACxD,IAAI,CAAC,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACjD,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACvD,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;gBAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACvE,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAChC,CAAC;aAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YAC3B,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;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,OAAO,CACf,WAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,EAC9C,kEAAkE,KAAK,CAAC,GAAG,QAAQ,CACpF,CAAC;QACJ,CAAC;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;QACtD,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,QAAQ,GAAG,0CAAG,KAAK,CAAC,QAAQ,CAAI,CAAC;IAC1E,CAAC;IAED,uCAAuC;IACvC,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,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,CAC3D,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,iBAAiB,EACtB,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,mBAAmB,CACzB,CAAC;QACF,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,CAAC;YACpD,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI,IAAI,CAAC,KAAK;oBAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;qBAChC,IAAI,IAAI,CAAC,QAAQ;oBAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,IAAW,GAAG;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACD,yCAAyC;IACzC,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IACD,0CAA0C;IAC1C,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IACD,2CAA2C;IAC3C,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IACD,2CAA2C;IAC3C,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IACD,0CAA0C;IAC1C,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAAtC;QACU,YAAO,GAAkC,IAAI,GAAG,EAGrD,CAAC;QACI,cAAS,GAAuB,IAAI,KAAK,EAAoB,CAAC;IAyExE,CAAC;IAvEC,oFAAoF;IAC7E,WAAW,CAChB,SAAiB,EACjB,UAA4B;QAE5B,IAAI,QAAsC,CAAC;QAE3C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YACvD,QAAQ,GAAG,UAAU,CAAC;YACtB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,CAAC;aAAM,CAAC;YACN,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,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;gBACf,QAAQ,GAAG,UAAU,CAAC;gBACtB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;YACnC,CAAC;QACH,CAAC;QAED,IAAI,QAAQ;YAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEpD,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,CAC7B,WAAmB,EACnB,gBAAyB,EACzB,iBAA0B,EAC1B,kBAA2B;QAE3B,IAAI,SAAS,GAAG,WAAW,CAAC;QAE5B,IAAI,gBAAgB;YAAE,SAAS,GAAG,OAAO,SAAS,EAAE,CAAC;QACrD,IAAI,kBAAkB;YAAE,SAAS,GAAG,SAAS,SAAS,EAAE,CAAC;QACzD,IAAI,iBAAiB;YAAE,SAAS,GAAG,QAAQ,SAAS,EAAE,CAAC;QAEvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mEAAmE;IAC5D,iBAAiB;QACtB,MAAM,MAAM,GAAG,CAAC,CAAC;QACjB,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC;YACpD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,OAAO,GAAG,MAAM;YACrD,SAAS,EAAE,IAAI,CAAC,6BAA6B,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\n\nimport * as React from \"react\";\nimport { UiError } from \"@itwin/appui-abstract\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef.js\";\nimport { ItemDefBase } from \"../shared/ItemDefBase.js\";\nimport { UiFramework } from \"../UiFramework.js\";\nimport { KeyboardShortcutMenu } from \"./KeyboardShortcutMenu.js\";\nimport type { KeyboardShortcutProps } from \"./KeyboardShortcutProps.js\";\nimport type {\n  FrameworkKeyboardShortcut,\n  FrameworkKeyboardShortcutContainer,\n} from \"../framework/FrameworkKeyboardShortcuts.js\";\n\n/* eslint-disable deprecation/deprecation */\n\nenum FunctionKey {\n  F1 = \"F1\",\n  F2 = \"F2\",\n  F3 = \"F3\",\n  F4 = \"F4\",\n  F5 = \"F5\",\n  F6 = \"F6\",\n  F7 = \"F7\",\n  F8 = \"F8\",\n  F9 = \"F9\",\n  F10 = \"F10\",\n  F11 = \"F11\",\n  F12 = \"F12\",\n}\n\nenum SpecialKey {\n  Home = \"Home\",\n  End = \"End\",\n  PageUp = \"PageUp\",\n  PageDown = \"PageDown\",\n  Escape = \"Escape\",\n  Delete = \"Delete\",\n  Insert = \"Insert\",\n  Tab = \"Tab\",\n  ArrowLeft = \"ArrowLeft\",\n  ArrowRight = \"ArrowRight\",\n  ArrowUp = \"ArrowUp\",\n  ArrowDown = \"ArrowDown\",\n  Enter = \"Enter\",\n  Return = \"Enter\", // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\n  Space = \" \",\n  Backspace = \"Backspace\",\n  Clear = \"Clear\",\n  Divide = \"Divide\",\n  Multiply = \"Multiply\",\n  Subtract = \"Subtract\",\n  Add = \"Add\",\n  Decimal = \"Decimal\",\n}\n\n/** Keyboard Shortcut used to execute an action\n * @public\n * @deprecated in 4.15.0. Use {@link KeyboardShortcutProps} or {@link FrameworkKeyboardShortcut} instead.\n */\nexport class KeyboardShortcut extends ItemDefBase {\n  private _key: string;\n  private _item?: ActionButtonItemDef;\n  private _shortcuts: KeyboardShortcutContainer;\n  private _execute?: () => void;\n\n  private _isAltKeyRequired: boolean = false;\n  private _isCtrlKeyRequired: boolean = false;\n  private _isShiftKeyRequired: boolean = false;\n  private _isFunctionKey: boolean = false;\n  private _isSpecialKey: boolean = false;\n\n  constructor(props: KeyboardShortcutProps) {\n    super(props);\n\n    this._key = props.key;\n\n    if (this._key in FunctionKey) this._isFunctionKey = true;\n    if (this._key in SpecialKey) this._isSpecialKey = true;\n\n    this._shortcuts = new KeyboardShortcutContainer();\n\n    if (props.item) {\n      this._item = props.item;\n\n      // Copy over icon, label & tooltip from the item\n      if (!this.iconSpec) this.iconSpec = this._item.iconSpec;\n      if (!this.label) this.setLabel(this._item.label);\n      if (!this.tooltip) this.setTooltip(this._item.tooltip);\n      if (this.isDisabled === undefined)\n        this.isDisabled = this._item.isDisabled;\n      if (this.isHidden === undefined) this.isHidden = this._item.isHidden;\n    } else if (props.execute) {\n      this._execute = props.execute;\n    } else if (props.shortcuts) {\n      props.shortcuts.forEach((childProps: KeyboardShortcutProps) => {\n        const shortcut = new KeyboardShortcut(childProps);\n        this._shortcuts.registerKey(shortcut.keyMapKey, shortcut);\n      });\n    } else {\n      throw new UiError(\n        UiFramework.loggerCategory(\"KeyboardShortcut\"),\n        `Either 'item', 'execute' or 'shortcuts' must be specified for '${props.key}' key.`\n      );\n    }\n\n    if (props.isAltKeyRequired !== undefined)\n      this._isAltKeyRequired = props.isAltKeyRequired;\n    if (props.isCtrlKeyRequired !== undefined)\n      this._isCtrlKeyRequired = props.isCtrlKeyRequired;\n    if (props.isShiftKeyRequired !== undefined)\n      this._isShiftKeyRequired = props.isShiftKeyRequired;\n    if (props.iconNode !== undefined) this.iconSpec = <>{props.iconNode}</>;\n  }\n\n  /** Returns the id for this shortcut */\n  public get id(): string {\n    return this.keyMapKey;\n  }\n\n  /** Returns the shortcut container */\n  public get shortcutContainer(): KeyboardShortcutContainer {\n    return this._shortcuts;\n  }\n\n  /** Finds a shortcut with a given key in the shortcut's container */\n  public getShortcut(mapKey: string): KeyboardShortcut | undefined {\n    return this._shortcuts.findKey(mapKey);\n  }\n\n  /** Returns the shortcut's key map key used as the id */\n  public get keyMapKey(): string {\n    const keyMapKey = KeyboardShortcutContainer.generateKeyMapKey(\n      this.key,\n      this._isAltKeyRequired,\n      this._isCtrlKeyRequired,\n      this._isShiftKeyRequired\n    );\n    return keyMapKey;\n  }\n\n  /** Returns the [[ActionButtonItemDef]] associated with this shortcut */\n  public get item(): ActionButtonItemDef | undefined {\n    return this._item;\n  }\n\n  /** Called when the [[ActionButtonItemDef]] associated with this shortcut is invoked */\n  public itemPicked(): void {\n    if (this._shortcuts.areKeyboardShortcutsAvailable()) {\n      this._shortcuts.showShortcutsMenu();\n    } else {\n      setTimeout(() => {\n        if (this._item) this._item.execute();\n        else if (this._execute) this._execute();\n      });\n    }\n  }\n\n  /** Gets the keyboard key */\n  public get key(): string {\n    return this._key;\n  }\n  /** Gets whether the Alt key required. */\n  public get isAltKeyRequired(): boolean {\n    return this._isAltKeyRequired;\n  }\n  /** Gets whether the Ctrl key required. */\n  public get isCtrlKeyRequired(): boolean {\n    return this._isCtrlKeyRequired;\n  }\n  /** Gets whether the Shift key required. */\n  public get isShiftKeyRequired(): boolean {\n    return this._isShiftKeyRequired;\n  }\n  /** Gets whether this is a Function key. */\n  public get isFunctionKey(): boolean {\n    return this._isFunctionKey;\n  }\n  /** Gets whether this is a Special key. */\n  public get isSpecialKey(): boolean {\n    return this._isSpecialKey;\n  }\n}\n\n/** Keyboard Shortcut Container\n * @public\n * @deprecated in 4.15.0. Use {@link FrameworkKeyboardShortcutContainer} instead.\n */\nexport class KeyboardShortcutContainer {\n  private _keyMap: Map<string, KeyboardShortcut> = new Map<\n    string,\n    KeyboardShortcut\n  >();\n  private _keyArray: KeyboardShortcut[] = new Array<KeyboardShortcut>();\n\n  /** Registers a Keyboard Shortcut associated with a given key in the managed list */\n  public registerKey(\n    keyMapKey: string,\n    inShortcut: KeyboardShortcut\n  ): KeyboardShortcut | undefined {\n    let shortcut: KeyboardShortcut | undefined;\n\n    if ((shortcut = this.findKey(keyMapKey)) === undefined) {\n      shortcut = inShortcut;\n      this._keyArray.push(shortcut);\n    } else {\n      const index = this._keyArray.findIndex((value: KeyboardShortcut) => {\n        return value.keyMapKey === keyMapKey;\n      });\n      if (index >= 0) {\n        shortcut = inShortcut;\n        this._keyArray[index] = shortcut;\n      }\n    }\n\n    if (shortcut) this._keyMap.set(keyMapKey, shortcut);\n\n    return shortcut;\n  }\n\n  /** Finds a Keyboard Shortcut associated with a given key */\n  public findKey(keyMapKey: string): KeyboardShortcut | undefined {\n    return this._keyMap.get(keyMapKey);\n  }\n\n  /** Determines if any Keyboard Shortcuts are available in this container */\n  public areKeyboardShortcutsAvailable(): boolean {\n    return this._keyMap.size !== 0;\n  }\n\n  /** Empties any Keyboard Shortcuts from this container */\n  public emptyData(): void {\n    this._keyMap.clear();\n    this._keyArray.length = 0;\n  }\n\n  public getAvailableKeyboardShortcuts(): KeyboardShortcut[] {\n    return this._keyArray.slice();\n  }\n\n  /** Generates a key used for storing and finding the Keyboard Shortcuts in this container */\n  public static generateKeyMapKey(\n    keyboardKey: string,\n    isAltKeyRequired: boolean,\n    isCtrlKeyRequired: boolean,\n    isShiftKeyRequired: boolean\n  ): string {\n    let keyMapKey = keyboardKey;\n\n    if (isAltKeyRequired) keyMapKey = `Alt+${keyMapKey}`;\n    if (isShiftKeyRequired) keyMapKey = `Shift+${keyMapKey}`;\n    if (isCtrlKeyRequired) keyMapKey = `Ctrl+${keyMapKey}`;\n\n    return keyMapKey;\n  }\n\n  /** Displays a menu for the Keyboard Shortcuts in this container */\n  public showShortcutsMenu() {\n    const offset = 8;\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.emit({\n      menuVisible: true,\n      menuX: UiFramework.keyboardShortcuts.cursorX - offset,\n      menuY: UiFramework.keyboardShortcuts.cursorY - offset,\n      shortcuts: this.getAvailableKeyboardShortcuts(),\n    });\n  }\n}\n"]}

package/lib/appui-react/keyboardshortcut/KeyboardShortcutMenu.d.ts

@@ -0,0 +1,41 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import * as React from "react";
+import type { CommonProps } from "@itwin/core-react";
+import type { KeyboardShortcut } from "./KeyboardShortcut.js";
+import { UiEvent } from "@itwin/appui-abstract";
+/** State of a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component
+ * @public
+ * @deprecated in 4.15.0. Used internally by {@link KeyboardShortcutMenu} component.
+ */
+export interface KeyboardShortcutMenuState {
+    menuVisible: boolean;
+    menuX: number;
+    menuY: number;
+    shortcuts?: KeyboardShortcut[];
+}
+/** KeyboardShortcut Menu Event class.
+ * @public
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
+ */
+export declare class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> {
+}
+/** React component that displays a context menu at the cursor containing keyboard shortcuts.
+ * @public
+ * @deprecated in 4.15.0. Component used internally to display keyboard shortcuts in a context menu.
+ */
+export declare class KeyboardShortcutMenu extends React.PureComponent<CommonProps, KeyboardShortcutMenuState> {
+    readonly state: KeyboardShortcutMenuState;
+    /** Get KeyboardShortcut Menu Event. */
+    static readonly onKeyboardShortcutMenuEvent: KeyboardShortcutMenuEvent;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleKeyboardShortcutMenuEvent;
+    render(): React.ReactNode;
+    private getShortcutMenuItems;
+    private getShortcutMenuItem;
+    private _hideContextMenu;
+    private _itemPicked;
+}
+//# sourceMappingURL=KeyboardShortcutMenu.d.ts.map

package/lib/appui-react/keyboardshortcut/KeyboardShortcutMenu.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutMenu.d.ts","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAOrD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAA2B,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIzE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,OAAO,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,OAAO,CAAC,yBAAyB,CAAC;CAAG;AAEpF;;;GAGG;AACH,qBAAa,oBAAqB,SAAQ,KAAK,CAAC,aAAa,CAC3D,WAAW,EACX,yBAAyB,CAC1B;IACC,SAAyB,KAAK,EAAE,yBAAyB,CAIvD;IAEF,uCAAuC;IACvC,gBAAuB,2BAA2B,4BAChB;IAElB,iBAAiB;IAMjB,oBAAoB;IAMpC,OAAO,CAAC,gCAAgC,CAItC;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IA6BzC,OAAO,CAAC,oBAAoB;IAe5B,OAAO,CAAC,mBAAmB;IA0D3B,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,WAAW,CAGjB;CACH"}

package/lib/appui-react/keyboardshortcut/KeyboardShortcutMenu.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutMenu.js","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcutMenu.tsx"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAezE;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,OAAkC;CAAG;AAEpF;;;GAGG;AACH,MAAM,OAAO,oBAAqB,SAAQ,KAAK,CAAC,aAG/C;IAHD;;QAI2B,UAAK,GAA8B;YAC1D,WAAW,EAAE,KAAK;YAClB,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;SACT,CAAC;QAkBM,qCAAgC,GAEpC,CAAC,KAAK,EAAE,EAAE;YACZ,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QAwGM,qBAAgB,GAAG,GAAG,EAAE;YAC9B,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEM,gBAAW,GAAG,CAAC,QAA0B,EAAQ,EAAE;YACzD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,QAAQ,CAAC,UAAU,EAAE,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC;IAhIiB,iBAAiB;QAC/B,oBAAoB,CAAC,2BAA2B,CAAC,WAAW,CAC1D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAEe,oBAAoB;QAClC,oBAAoB,CAAC,2BAA2B,CAAC,cAAc,CAC7D,IAAI,CAAC,gCAAgC,CACtC,CAAC;IACJ,CAAC;IAQe,MAAM;QACpB,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC;QAEtC,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,OAAO,CACL,oBAAC,iBAAiB,IAChB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EAC/B,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EACvB,UAAU,EAAC,oBAAoB,EAC/B,CAAC,EAAE,KAAK,EACR,CAAC,EAAE,KAAK,EACR,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,OAAO,EACd,cAAc,EAAE,OAAO,EACvB,SAAS,EAAE,KAAK,EAChB,QAAQ,EAAE,IAAI,EACd,eAAe,EAAE,IAAI,IAEpB,KAAK,CACY,CACrB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,oBAAoB,CAC1B,SAA8B;QAE9B,MAAM,KAAK,GAAsB,EAAE,CAAC;QAEpC,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,CAAC,OAAO,CAAC,CAAC,QAA0B,EAAE,KAAa,EAAE,EAAE;gBAC9D,MAAM,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBACvD,IAAI,IAAI;oBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;QACL,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,mBAAmB,CACzB,QAA0B,EAC1B,KAAa;QAEb,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC;QACjC,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAErE,gDAAgD;QAChD,IACE,WAAW,KAAK,QAAQ,CAAC,SAAS;YAClC,QAAQ,CAAC,aAAa;YACtB,QAAQ,CAAC,YAAY;YACrB,QAAQ;YAER,OAAO,IAAI,CAAC;QAEd,IAAI,IAAI,GAAoB,IAAI,CAAC;QACjC,IAAI,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;QAC3B,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAEnC,KAAK,GAAG,IAAI,WAAW,CAAC,iBAAiB,EAAE,IAAI,KAAK,EAAE,CAAC;QAEvD,IAAI,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,EAAE,CAAC;YAC/D,MAAM,SAAS,GACb,QAAQ,CAAC,iBAAiB,CAAC,6BAA6B,EAAE,CAAC;YAC7D,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;YAEnD,IAAI,GAAG,CACL,oBAAC,cAAc,IACb,GAAG,EAAE,KAAK,EACV,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,QAAQ,CAAC,UAAU,EAC7B,SAAS,EAAE,QAAQ,CAAC,SAAS,EAC7B,SAAS,EAAE,QAAQ,CAAC,SAAS,IAE5B,KAAK,CACS,CAClB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC7C,IAAI,GAAG,CACL,oBAAC,eAAe,IACd,GAAG,EAAE,KAAK,EACV,QAAQ,EAAE,GAAG,EACb,IAAI,EAAE,QAAQ,EACd,QAAQ,EAAE,QAAQ,CAAC,UAAU,EAC7B,SAAS,EAAE,QAAQ,CAAC,SAAS,EAC7B,SAAS,EAAE,QAAQ,CAAC,SAAS,IAE5B,KAAK,CACU,CACnB,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AA1HD,uCAAuC;AAChB,gDAA2B,GAChD,IAAI,yBAAyB,EAAE,AADiB,CAChB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\n\nimport * as React from \"react\";\nimport type { CommonProps } from \"@itwin/core-react\";\nimport type { ListenerType } from \"@itwin/core-react/internal\";\nimport {\n  ContextMenuItem,\n  ContextSubMenu,\n  GlobalContextMenu,\n} from \"@itwin/core-react\";\nimport type { KeyboardShortcut } from \"./KeyboardShortcut.js\";\nimport { ConditionalBooleanValue, UiEvent } from \"@itwin/appui-abstract\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** State of a [[KeyboardShortcutMenuEvent]] and [[KeyboardShortcutMenu]] component\n * @public\n * @deprecated in 4.15.0. Used internally by {@link KeyboardShortcutMenu} component.\n */\nexport interface KeyboardShortcutMenuState {\n  menuVisible: boolean;\n  menuX: number;\n  menuY: number;\n  shortcuts?: KeyboardShortcut[];\n}\n\n/** KeyboardShortcut Menu Event class.\n * @public\n * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.\n */\nexport class KeyboardShortcutMenuEvent extends UiEvent<KeyboardShortcutMenuState> {}\n\n/** React component that displays a context menu at the cursor containing keyboard shortcuts.\n * @public\n * @deprecated in 4.15.0. Component used internally to display keyboard shortcuts in a context menu.\n */\nexport class KeyboardShortcutMenu extends React.PureComponent<\n  CommonProps,\n  KeyboardShortcutMenuState\n> {\n  public override readonly state: KeyboardShortcutMenuState = {\n    menuVisible: false,\n    menuX: 0,\n    menuY: 0,\n  };\n\n  /** Get KeyboardShortcut Menu Event. */\n  public static readonly onKeyboardShortcutMenuEvent =\n    new KeyboardShortcutMenuEvent();\n\n  public override componentDidMount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.addListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  public override componentWillUnmount() {\n    KeyboardShortcutMenu.onKeyboardShortcutMenuEvent.removeListener(\n      this._handleKeyboardShortcutMenuEvent\n    );\n  }\n\n  private _handleKeyboardShortcutMenuEvent: ListenerType<\n    typeof KeyboardShortcutMenu.onKeyboardShortcutMenuEvent\n  > = (state) => {\n    this.setState(state);\n  };\n\n  public override render(): React.ReactNode {\n    const { shortcuts, menuX, menuY, menuVisible } = this.state;\n    const onClose = this._hideContextMenu;\n\n    if (menuVisible) {\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      return (\n        <GlobalContextMenu\n          className={this.props.className}\n          style={this.props.style}\n          identifier=\"keyboard-shortcuts\"\n          x={menuX}\n          y={menuY}\n          opened={menuVisible}\n          onEsc={onClose}\n          onOutsideClick={onClose}\n          edgeLimit={false}\n          autoflip={true}\n          ignoreNextKeyUp={true} // Executing the shortcut on the keydown, so ignore the keyup in the menu\n        >\n          {items}\n        </GlobalContextMenu>\n      );\n    }\n\n    return null;\n  }\n\n  private getShortcutMenuItems(\n    shortcuts?: KeyboardShortcut[]\n  ): React.ReactNode[] {\n    const items: React.ReactNode[] = [];\n\n    if (shortcuts) {\n      shortcuts.forEach((shortcut: KeyboardShortcut, index: number) => {\n        const item = this.getShortcutMenuItem(shortcut, index);\n        if (item) items.push(item);\n      });\n    }\n\n    return items;\n  }\n\n  private getShortcutMenuItem(\n    shortcut: KeyboardShortcut,\n    index: number\n  ): React.ReactNode {\n    const shortcutKey = shortcut.key;\n    const isHidden = ConditionalBooleanValue.getValue(shortcut.isHidden);\n\n    // Only pure characters go into the context menu\n    if (\n      shortcutKey !== shortcut.keyMapKey ||\n      shortcut.isFunctionKey ||\n      shortcut.isSpecialKey ||\n      isHidden\n    )\n      return null;\n\n    let node: React.ReactNode = null;\n    let label = shortcut.label;\n    const iconSpec = shortcut.iconSpec;\n\n    label = `~${shortcutKey.toLocaleUpperCase()} ${label}`;\n\n    if (shortcut.shortcutContainer.areKeyboardShortcutsAvailable()) {\n      const shortcuts =\n        shortcut.shortcutContainer.getAvailableKeyboardShortcuts();\n      const items = this.getShortcutMenuItems(shortcuts);\n\n      node = (\n        <ContextSubMenu\n          key={index}\n          icon={iconSpec}\n          label={label}\n          disabled={shortcut.isDisabled}\n          badgeType={shortcut.badgeType}\n          badgeKind={shortcut.badgeKind}\n        >\n          {items}\n        </ContextSubMenu>\n      );\n    } else {\n      const sel = () => this._itemPicked(shortcut);\n      node = (\n        <ContextMenuItem\n          key={index}\n          onSelect={sel}\n          icon={iconSpec}\n          disabled={shortcut.isDisabled}\n          badgeType={shortcut.badgeType}\n          badgeKind={shortcut.badgeKind}\n        >\n          {label}\n        </ContextMenuItem>\n      );\n    }\n\n    return node;\n  }\n\n  private _hideContextMenu = () => {\n    this.setState({ menuVisible: false, shortcuts: undefined });\n  };\n\n  private _itemPicked = (shortcut: KeyboardShortcut): void => {\n    this._hideContextMenu();\n    shortcut.itemPicked();\n  };\n}\n"]}

package/lib/appui-react/keyboardshortcut/KeyboardShortcutProps.d.ts

@@ -0,0 +1,71 @@
+/** @packageDocumentation
+ * @module KeyboardShortcut
+ */
+import type { Key } from "ts-key-enum";
+import type { ActionButtonItemDef } from "../shared/ActionButtonItemDef.js";
+import type { ConditionalBooleanValue, ConditionalStringValue } from "../shared/ConditionalValue.js";
+import type { BadgeType, CommonProps, IconSpec } from "@itwin/core-react";
+import type { BadgeKind } from "@itwin/core-react/internal";
+import type { StringGetter } from "@itwin/appui-abstract";
+/** Properties for a Keyboard Shortcut
+ * @public
+ */
+export interface KeyboardShortcutProps extends CommonProps {
+    /** The key that invokes the shortcut.
+     * This is either an alphanumeric key, a function key or a special key.
+     */
+    key: string | Key;
+    /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified.
+     * @deprecated in 4.15.0. Use properties of this object instead.
+     */
+    item?: ActionButtonItemDef;
+    /** Function to run when the keyboard shortcut is executed. */
+    execute?: () => void;
+    /** Nested array of shortcut props.
+     * @note `execute` is ignored if `shortcuts` is 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;
+    /** Specifies the kind of badge, if any, to be overlaid on the item. */
+    badgeKind?: BadgeKind;
+    /** Icon used for a shortcut. */
+    iconNode?: React.ReactNode;
+    /** if true component will be hidden - defaults to false */
+    isHidden?: boolean | ConditionalBooleanValue;
+    /** if true component will be disabled - defaults to false */
+    isDisabled?: boolean | ConditionalBooleanValue;
+    /** if set, component will be considered "active" an will display an "active stripe" - defaults to false */
+    isActive?: boolean;
+    /** if set, component will be considered selected but will NOT display an "active stripe" - defaults to false. Typically used by buttons that toggle between two states. */
+    isPressed?: boolean;
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Badge to be overlaid on the item.
+     * @deprecated in 4.16.0. Use `badgeKind` property instead.
+     */
+    badgeType?: BadgeType;
+    /** Abstract icon definition, used when creating itemDef from abstract item (ie. MenuItem).
+     * @deprecated in 4.16.0. Use {@link KeyboardShortcutProps.iconNode} instead.
+     */
+    icon?: IconSpec;
+    /** if set, it is used to explicitly set the label shown by a component. */
+    label?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    labelKey?: string;
+    /** if set, it is used to explicitly set the description shown by a component. */
+    description?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */
+    descriptionKey?: string;
+    /** used to explicitly set the tooltip shown by a component. */
+    tooltip?: string | StringGetter | ConditionalStringValue;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    tooltipKey?: string;
+    /** @deprecated in 4.16.0. Use {@link KeyboardShortcutProps.iconNode} instead. */
+    iconSpec?: IconSpec;
+}
+//# sourceMappingURL=KeyboardShortcutProps.d.ts.map

package/lib/appui-react/keyboardshortcut/KeyboardShortcutProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutProps.d.ts","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcutProps.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EACV,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;GAEG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,WAAW;IACxD;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IAElB;;OAEG;IAEH,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B,8DAA8D;IAC9D,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IAErB;;OAEG;IACH,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;IAE7B,uEAAuE;IACvE,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAI3B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC7C,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IAC/C,2GAA2G;IAC3G,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2KAA2K;IAC3K,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB;;OAEG;IAEH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IAEH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAEhB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IACvD,6IAA6I;IAC7I,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IAC7D,mJAAmJ;IACnJ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,CAAC;IACzD,6IAA6I;IAC7I,UAAU,CAAC,EAAE,MAAM,CAAC;IAMpB,iFAAiF;IAEjF,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAGrB"}

package/lib/appui-react/keyboardshortcut/KeyboardShortcutProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyboardShortcutProps.js","sourceRoot":"","sources":["../../../src/appui-react/keyboardshortcut/KeyboardShortcutProps.ts"],"names":[],"mappings":"","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module KeyboardShortcut\n */\nimport type { Key } from \"ts-key-enum\";\nimport type { ActionButtonItemDef } from \"../shared/ActionButtonItemDef.js\";\nimport type {\n  ConditionalBooleanValue,\n  ConditionalStringValue,\n} from \"../shared/ConditionalValue.js\";\nimport type { BadgeType, CommonProps, IconSpec } from \"@itwin/core-react\";\nimport type { BadgeKind } from \"@itwin/core-react/internal\";\nimport type { StringGetter } from \"@itwin/appui-abstract\";\n\n/** Properties for a Keyboard Shortcut\n * @public\n */\n// eslint-disable-next-line deprecation/deprecation\nexport interface KeyboardShortcutProps extends CommonProps {\n  /** The key that invokes the shortcut.\n   * This is either an alphanumeric key, a function key or a special key.\n   */\n  key: string | Key;\n\n  /** The item to execute when this shortcut is invoked. Either 'item' or 'shortcuts' must be specified.\n   * @deprecated in 4.15.0. Use properties of this object instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  item?: ActionButtonItemDef;\n  /** Function to run when the keyboard shortcut is executed. */\n  execute?: () => void;\n\n  /** Nested array of shortcut props.\n   * @note `execute` is ignored if `shortcuts` is specified.\n   */\n  shortcuts?: KeyboardShortcutProps[];\n\n  /** Indicates whether the Alt key required. Default - false */\n  isAltKeyRequired?: boolean;\n  /** Indicates whether the Ctrl key required. Default - false */\n  isCtrlKeyRequired?: boolean;\n  /** Indicates whether the Shift key required. Default - false */\n  isShiftKeyRequired?: boolean;\n\n  /** Specifies the kind of badge, if any, to be overlaid on the item. */\n  badgeKind?: BadgeKind;\n  /** Icon used for a shortcut. */\n  iconNode?: React.ReactNode;\n\n  // #region \"ItemProps\" properties previously extended from deprecated type.\n\n  /** if true component will be hidden - defaults to false */\n  isHidden?: boolean | ConditionalBooleanValue;\n  /** if true component will be disabled - defaults to false */\n  isDisabled?: boolean | ConditionalBooleanValue;\n  /** if set, component will be considered \"active\" an will display an \"active stripe\" - defaults to false */\n  isActive?: boolean;\n  /** if set, component will be considered selected but will NOT display an \"active stripe\" - defaults to false. Typically used by buttons that toggle between two states. */\n  isPressed?: boolean;\n  /** can be used by application to store miscellaneous data. */\n  applicationData?: any;\n  /** Badge to be overlaid on the item.\n   * @deprecated in 4.16.0. Use `badgeKind` property instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  badgeType?: BadgeType;\n  /** Abstract icon definition, used when creating itemDef from abstract item (ie. MenuItem).\n   * @deprecated in 4.16.0. Use {@link KeyboardShortcutProps.iconNode} instead.\n   */\n  // eslint-disable-next-line deprecation/deprecation\n  icon?: IconSpec;\n\n  /** if set, it is used to explicitly set the label shown by a component. */\n  label?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  labelKey?: string;\n\n  /** if set, it is used to explicitly set the description shown by a component. */\n  description?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */\n  descriptionKey?: string;\n  /** used to explicitly set the tooltip shown by a component. */\n  tooltip?: string | StringGetter | ConditionalStringValue;\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\n  tooltipKey?: string;\n\n  // #endregion \"ItemProps\"\n\n  // #region \"IconProps\" properties previously extended from deprecated type.\n\n  /** @deprecated in 4.16.0. Use {@link KeyboardShortcutProps.iconNode} instead. */\n  // eslint-disable-next-line deprecation/deprecation\n  iconSpec?: IconSpec;\n\n  // #endregion \"IconProps\"\n}\n"]}