@itwin/appui-react 3.6.0-dev.8 → 3.7.0-dev.1

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/keyinbrowser/KeyinBrowser.d.ts

@@ -5,20 +5,20 @@ import "./KeyinBrowser.scss";
 import * as React from "react";
 import { AutoSuggestData, CommonProps } from "@itwin/core-react";
 /** Data for each key-in.
- @deprecated */
+ @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react) */
 interface KeyinBrowserData extends AutoSuggestData {
     /** English key-in - Browser supports both English and localized key-ins */
     englishKeyin: string;
 }
 /** State of key-in browser.
- @deprecated */
+ @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react)*/
 interface KeyinBrowserState {
     keyins: KeyinBrowserData[];
     currentToolId: string | undefined;
     currentArgs: string;
 }
 /** Arguments for [[KeyinBrowserProps]] onExecute callback.
- * @beta @deprecated
+ * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).
  */
 export interface KeyinBrowserExecuteArgs {
     /** Id of the tool that was run */
@@ -29,7 +29,7 @@ export interface KeyinBrowserExecuteArgs {
     runStatus: boolean;
 }
 /** Properties of the [[KeyinBrowser]] component.
- * @beta @deprecated
+ * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).
  */
 export interface KeyinBrowserProps extends CommonProps {
     /** Function called after the key-in is executed */
@@ -39,7 +39,7 @@ export interface KeyinBrowserProps extends CommonProps {
 }
 /**
  * Component used to allow users to select, provide arguments, and execute a key-in.
- * @beta @deprecated
+ * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).
  */
 export declare class KeyinBrowser extends React.PureComponent<KeyinBrowserProps, KeyinBrowserState> {
     private _toolIdLabel;

package/lib/cjs/appui-react/keyinbrowser/KeyinBrowser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"KeyinBrowser.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAE7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAe,eAAe,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAK1F;eACe;AACf,UAAU,gBAAiB,SAAQ,eAAe;IAIhD,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;eACe;AACf,UAAU,iBAAiB;IACzB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,kCAAkC;IAClC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,mCAAmC;IACnC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,+BAA+B;IAC/B,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,mDAAmD;IACnD,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,CAAC;IACpD,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAK,CAAC,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACzF,OAAO,CAAC,YAAY,CAA+C;IACnE,OAAO,CAAC,UAAU,CAA8C;IAChE,OAAO,CAAC,QAAQ,CAAiD;IACjE,OAAO,CAAC,aAAa,CAAiD;IACtE,OAAO,CAAC,mBAAmB,CAAqD;IAChF,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,UAAU,CAAS;IAE3B,gBAAgB;gBACJ,KAAK,EAAE,GAAG;IAYtB,gBAAgB;IACA,iBAAiB;IAcjC,gBAAgB;IACA,oBAAoB;IAIpC,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,QAAQ,CAEd;YAEY,QAAQ;IA+CtB,OAAO,CAAC,cAAc,CAGpB;IAGF,OAAO,CAAC,gBAAgB,CAMtB;IAEF,OAAO,CAAC,kBAAkB,CAIxB;IAEF,OAAO,CAAC,UAAU,CAahB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,mBAAmB,CAUzB;IAEF,OAAO,CAAC,iBAAiB,CAKvB;IAEF,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,oBAAoB,CAK1B;IAEF,uDAAuD;IACvD,OAAO,CAAC,eAAe,CAWrB;IAEF,gBAAgB;IACA,MAAM,IAAI,KAAK,CAAC,SAAS;CAiB1C"}
+{"version":3,"file":"KeyinBrowser.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,qBAAqB,CAAC;AAE7B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAe,eAAe,EAAE,WAAW,EAAc,MAAM,mBAAmB,CAAC;AAK1F;oFACoF;AACpF,UAAU,gBAAiB,SAAQ,eAAe;IAIhD,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;mFACmF;AACnF,UAAU,iBAAiB;IACzB,MAAM,EAAE,gBAAgB,EAAE,CAAC;IAC3B,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,kCAAkC;IAClC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,mCAAmC;IACnC,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,+BAA+B;IAC/B,SAAS,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,mDAAmD;IACnD,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,uBAAuB,KAAK,IAAI,CAAC;IACpD,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAK,CAAC,aAAa,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IACzF,OAAO,CAAC,YAAY,CAA+C;IACnE,OAAO,CAAC,UAAU,CAA8C;IAChE,OAAO,CAAC,QAAQ,CAAiD;IACjE,OAAO,CAAC,aAAa,CAAiD;IACtE,OAAO,CAAC,mBAAmB,CAAqD;IAChF,OAAO,CAAC,UAAU,CAAwB;IAC1C,OAAO,CAAC,UAAU,CAAS;IAE3B,gBAAgB;gBACJ,KAAK,EAAE,GAAG;IAYtB,gBAAgB;IACA,iBAAiB;IAcjC,gBAAgB;IACA,oBAAoB;IAIpC,OAAO,CAAC,UAAU;IAMlB,OAAO,CAAC,cAAc;IAKtB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,eAAe;IAOvB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,QAAQ,CAEd;YAEY,QAAQ;IA+CtB,OAAO,CAAC,cAAc,CAGpB;IAGF,OAAO,CAAC,gBAAgB,CAMtB;IAEF,OAAO,CAAC,kBAAkB,CAIxB;IAEF,OAAO,CAAC,UAAU,CAahB;IAEF,OAAO,CAAC,aAAa,CAKnB;IAEF,OAAO,CAAC,mBAAmB,CAUzB;IAEF,OAAO,CAAC,iBAAiB,CAKvB;IAEF,OAAO,CAAC,kBAAkB;IA+B1B,OAAO,CAAC,oBAAoB,CAK1B;IAEF,uDAAuD;IACvD,OAAO,CAAC,eAAe,CAWrB;IAEF,gBAAgB;IACA,MAAM,IAAI,KAAK,CAAC,SAAS;CAiB1C"}

package/lib/cjs/appui-react/keyinbrowser/KeyinBrowser.js

@@ -19,7 +19,7 @@ const UiFramework_1 = require("../UiFramework");
 const appui_abstract_1 = require("@itwin/appui-abstract");
 /**
  * Component used to allow users to select, provide arguments, and execute a key-in.
- * @beta @deprecated
+ * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).
  */
 class KeyinBrowser extends React.PureComponent {
     /** @internal */

package/lib/cjs/appui-react/keyinbrowser/KeyinBrowser.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyinBrowser.js","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA6B;AAC7B,oDAAoD;AACpD,+BAA+B;AAC/B,wDAAuH;AACvH,kDAA0F;AAC1F,wDAA4D;AAC5D,gDAA6C;AAC7C,0DAAmD;AA0CnD;;;GAGG;AACH,MAAa,YAAa,SAAQ,KAAK,CAAC,aAAmD;IASzF,gBAAgB;IAChB,YAAY,KAAU;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;QAVP,iBAAY,GAAG,yBAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC3D,eAAU,GAAG,yBAAW,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACxD,aAAQ,GAAG,yBAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACzD,kBAAa,GAAG,yBAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAC9D,wBAAmB,GAAG,yBAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACxE,eAAU,GAAG,oBAAoB,CAAC;QAClC,eAAU,GAAG,KAAK,CAAC;QAyEnB,aAAQ,GAAG,KAAK,IAAI,EAAE;YAC5B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC,CAAC;QAiDM,mBAAc,GAAG,CAAC,GAAW,EAAE,EAAE;YACvC,MAAM,OAAO,GAAG,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iCAAiB,CAAC,KAAK,CAAC,CAAC;YAC/G,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,uBAAuB;QACf,qBAAgB,GAAG,CAAC,QAAyB,EAAQ,EAAE;YAC7D,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YACpD,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC;QAEM,uBAAkB,GAAG,CAAC,KAA0C,EAAQ,EAAE;YAChF,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC;QAEM,eAAU,GAAG,KAAK,EAAE,KAA4C,EAAiB,EAAE;YACzF,IAAI,2BAAU,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,EAAE;gBAClC,KAAK,CAAC,eAAe,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;aACxB;YAED,uBAAuB;YACvB,IAAI,2BAAU,CAAC,MAAM,KAAK,KAAK,CAAC,GAAG,EAAE;gBACnC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;oBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO;aACR;QACH,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,KAAyC,EAAQ,EAAE;YAC1E,uBAAuB;YACvB,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;aACvB;QACH,CAAC,CAAC;QAEM,wBAAmB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YACjE,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,uBAAuB;YACvB,IAAI,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;gBACvC,UAAU,CAAC,KAAK,IAAI,EAAE;oBACpB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAC/D,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC;QAiCM,yBAAoB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAClE,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,uBAAuB;YACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;gBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,uDAAuD;QAC/C,oBAAe,GAAG,KAAK,EAAE,KAAa,EAA8B,EAAE;YAC5E,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC;YAEtC,OAAO,OAAO,CAAC,OAAO,CACpB,WAAW,KAAK,CAAC,CAAC,CAAC;gBACjB,0BAA0B,CAAA,EAAE,CAAC,CAAC;gBAC9B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAsB,EAAE,EAAE;oBAClD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC/G,CAAC,CAAC,CACL,CAAC;QACJ,CAAC,CAAC;QAtOA,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAEpD,IAAI,CAAC,KAAK,GAAG;YACX,MAAM,EAAE,EAAE;YACV,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,gBAAgB;IACA,iBAAiB;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAE1B,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAkB,EAAE,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACjG,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACA,oBAAoB;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEO,UAAU,CAAC,MAA0B;QAC3C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAC7B,OAAO,gBAAgB,MAAM,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACrC,CAAC;IAEO,WAAW,CAAC,MAA0B;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAClD,qBAAqB;YACrB,IAAI,IAAI,IAAI,0BAA0B,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACpG,OAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjD;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE;aAC1B,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAC3H,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,YAAY;QAClB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAC1C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAMO,KAAK,CAAC,QAAQ;QACpB,IAAI,MAA0B,CAAC;QAC/B,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,MAAM,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACjE,uBAAuB;YACvB,IAAI,SAAS,EAAE;gBACb,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;gBAC1B,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;gBAElC,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE;oBACvF,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,CAAC;oBACzE,OAAO;iBACR;gBAED,IAAI,GAAG,GAAG,oBAAoB,CAAC;gBAC/B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBAEzC,qBAAqB;gBACrB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC3B,GAAG,GAAG,gBAAgB,MAAM,EAAE,CAAC;oBAC/B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAC5C,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;iBAClD;gBAED,MAAM,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBAC7B,SAAS,GAAG,KAAK,CAAC;gBAElB,IAAI;oBACF,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC5G,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,CAAC;iBACtF;gBAAC,OAAO,CAAC,EAAE;oBACV,uBAAuB;oBACvB,IAAI,CAAC,cAAc,CAAC,GAAG,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACzF;aACF;SACF;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS;YACtB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IA+DO,kBAAkB,CAAC,UAAkB;QAC3C,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,SAAkC,CAAC;QAEvC,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC3D,uBAAuB;YACvB,IAAI,SAAS;gBACX,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC;SAClC;QAED,uBAAuB;QACvB,IAAI,UAAU,KAAK,YAAY,EAAE;YAC/B,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACxD,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE;iBACtC,IAAI,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,eAAe,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,CAAC;YAEpI,IAAI,CAAC,SAAS,EAAE;gBACd,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC,CAAC;gBAC5E,OAAO,KAAK,CAAC;aACd;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;gBACvC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,UAAU;oBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;aACpC;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAuBD,gBAAgB;IACA,MAAM;QACpB,OAAO,CACL,6BAAK,SAAS,EAAC,sBAAsB;YACnC,oBAAC,uBAAU,IAAC,KAAK,EAAE,IAAI,CAAC,YAAY;gBAClC,oBAAC,wBAAW,IAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EACrE,WAAW,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EACjE,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY,EAAE,IAAI,CAAC,mBAAmB,EACnF,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,EAAE,IAAI,CAAC,oBAAoB,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAC9G,cAAc,EAAE,IAAI,CAAC,eAAe,iBAAc,uBAAuB,GAAG,CACnE;YACb,oBAAC,4BAAY,IAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,iBAC3E,qBAAqB,EAAC,EAAE,EAAC,qBAAqB,EAC1D,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAC,OAAO,GAAG;YAC7G,oBAAC,sBAAM,IAAC,SAAS,EAAC,KAAK,iBAAa,2BAA2B,EAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,IAAG,IAAI,CAAC,aAAa,CAAU,CACjH,CACP,CAAC;IACJ,CAAC;CACF;AAtQD,oCAsQC","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport \"./KeyinBrowser.scss\";\r\n// cSpell:ignore Modeless keyins keyinbrowser testid\r\nimport * as React from \"react\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType, Tool } from \"@itwin/core-frontend\";\r\nimport { AutoSuggest, AutoSuggestData, CommonProps, InputLabel } from \"@itwin/core-react\";\r\nimport { Button, LabeledInput } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SpecialKey } from \"@itwin/appui-abstract\";\r\n\r\n/** Data for each key-in.\r\n @deprecated */\r\ninterface KeyinBrowserData extends AutoSuggestData {\r\n  // AutoSuggestData.value is the toolId\r\n  // AutoSuggestData.label is the keyin\r\n\r\n  /** English key-in - Browser supports both English and localized key-ins */\r\n  englishKeyin: string;\r\n}\r\n\r\n/** State of key-in browser.\r\n @deprecated */\r\ninterface KeyinBrowserState {\r\n  keyins: KeyinBrowserData[];\r\n  currentToolId: string | undefined;\r\n  currentArgs: string;\r\n}\r\n\r\n/** Arguments for [[KeyinBrowserProps]] onExecute callback.\r\n * @beta @deprecated\r\n */\r\nexport interface KeyinBrowserExecuteArgs {\r\n  /** Id of the tool that was run */\r\n  toolId: string | undefined;\r\n  /** Arguments passed to the tool */\r\n  args: string[];\r\n  /** Status of the key-in run */\r\n  runStatus: boolean;\r\n}\r\n\r\n/** Properties of the [[KeyinBrowser]] component.\r\n * @beta @deprecated\r\n */\r\nexport interface KeyinBrowserProps extends CommonProps {\r\n  /** Function called after the key-in is executed */\r\n  onExecute?: (args: KeyinBrowserExecuteArgs) => void;\r\n  /** Function called on Escape or popup close */\r\n  onCancel?: () => void;\r\n}\r\n\r\n/**\r\n * Component used to allow users to select, provide arguments, and execute a key-in.\r\n * @beta @deprecated\r\n */\r\nexport class KeyinBrowser extends React.PureComponent<KeyinBrowserProps, KeyinBrowserState> {\r\n  private _toolIdLabel = UiFramework.translate(\"keyinbrowser.keyin\");\r\n  private _argsLabel = UiFramework.translate(\"keyinbrowser.args\");\r\n  private _argsTip = UiFramework.translate(\"keyinbrowser.argsTip\");\r\n  private _executeLabel = UiFramework.translate(\"keyinbrowser.execute\");\r\n  private _suggestPlaceholder = UiFramework.translate(\"keyinbrowser.placeholder\");\r\n  private _toolIdKey = \"keyinbrowser:keyin\";\r\n  private _isMounted = false;\r\n\r\n  /** @internal */\r\n  constructor(props: any) {\r\n    super(props);\r\n    const currentToolId = this.getSavedToolId();\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n\r\n    this.state = {\r\n      keyins: [],\r\n      currentToolId,\r\n      currentArgs,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentDidMount() {\r\n    this._isMounted = true;\r\n\r\n    let keyins = this.getToolKeyinMap();\r\n    this.setState({ keyins });\r\n\r\n    setTimeout(() => {\r\n      keyins = keyins.sort((a: AutoSuggestData, b: AutoSuggestData) => a.label.localeCompare(b.label));\r\n      // istanbul ignore else\r\n      if (this._isMounted)\r\n        this.setState({ keyins });\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentWillUnmount() {\r\n    this._isMounted = false;\r\n  }\r\n\r\n  private getArgsKey(toolId: string | undefined): string | undefined {\r\n    if (toolId && toolId.length > 0)\r\n      return `keyinbrowser:${toolId}`;\r\n    return undefined;\r\n  }\r\n\r\n  private getSavedToolId(): string | undefined {\r\n    const toolId = window.localStorage.getItem(this._toolIdKey);\r\n    return toolId ? toolId : undefined;\r\n  }\r\n\r\n  private getToolArgs(toolId: string | undefined): string {\r\n    const argsKey = this.getArgsKey(toolId);\r\n    if (argsKey && argsKey.length > 0) {\r\n      const args = window.localStorage.getItem(argsKey);\r\n      // istanbul ignore if\r\n      if (args && /* istanbul ignore next */ args.length > 0 && /* istanbul ignore next */ args[0] === \"[\") {\r\n        return (JSON.parse(args) as string[]).join(\"|\");\r\n      }\r\n    }\r\n    return \"\";\r\n  }\r\n\r\n  private getToolKeyinMap(): KeyinBrowserData[] {\r\n    const keyins: KeyinBrowserData[] = [];\r\n    IModelApp.tools.getToolList()\r\n      .forEach((tool: typeof Tool) => keyins.push({ value: tool.toolId, label: tool.keyin, englishKeyin: tool.englishKeyin }));\r\n    return keyins;\r\n  }\r\n\r\n  private getArgsArray(): string[] {\r\n    // istanbul ignore else\r\n    if (this.state.currentArgs.length > 0) {\r\n      return this.state.currentArgs.split(\"|\");\r\n    }\r\n    return [];\r\n  }\r\n\r\n  private _onClick = async () => {\r\n    return this._execute();\r\n  };\r\n\r\n  private async _execute(): Promise<void> {\r\n    let toolId: string | undefined;\r\n    let args: string[] = [];\r\n    let runStatus = false;\r\n\r\n    // istanbul ignore else\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      const foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool) {\r\n        toolId = foundTool.toolId;\r\n        args = this.getArgsArray();\r\n        const maxArgs = foundTool.maxArgs;\r\n\r\n        if (args.length < foundTool.minArgs || (undefined !== maxArgs && args.length > maxArgs)) {\r\n          this._outputMessage(UiFramework.translate(\"keyinbrowser.incorrectArgs\"));\r\n          return;\r\n        }\r\n\r\n        let key = \"keyinbrowser:keyin\";\r\n        window.localStorage.setItem(key, toolId);\r\n\r\n        // istanbul ignore if\r\n        if (args && args.length > 0) {\r\n          key = `keyinbrowser:${toolId}`;\r\n          const objectAsString = JSON.stringify(args);\r\n          window.localStorage.setItem(key, objectAsString);\r\n        }\r\n\r\n        const tool = new foundTool();\r\n        runStatus = false;\r\n\r\n        try {\r\n          runStatus = args.length > 0 ? /* istanbul ignore next */ await tool.parseAndRun(...args) : await tool.run();\r\n          !runStatus && this._outputMessage(UiFramework.translate(\"keyinbrowser.failedToRun\"));\r\n        } catch (e) {\r\n          // istanbul ignore next\r\n          this._outputMessage(`${UiFramework.translate(\"keyinbrowser.exceptionOccurred\")}: ${e}`);\r\n        }\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (this.props.onExecute)\r\n      this.props.onExecute({ toolId, args, runStatus });\r\n  }\r\n\r\n  private _outputMessage = (msg: string) => {\r\n    const details = new NotifyMessageDetails(OutputMessagePriority.Error, msg, undefined, OutputMessageType.Alert);\r\n    IModelApp.notifications.outputMessage(details);\r\n  };\r\n\r\n  // istanbul ignore next\r\n  private _onKeyinSelected = (selected: AutoSuggestData): void => {\r\n    const currentToolId = selected.value;\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentToolId, currentArgs });\r\n  };\r\n\r\n  private _onArgumentsChange = (event: React.ChangeEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentArgs: event.target.value });\r\n  };\r\n\r\n  private _onKeyDown = async (event: React.KeyboardEvent<HTMLInputElement>): Promise<void> => {\r\n    if (SpecialKey.Enter === event.key) {\r\n      event.stopPropagation();\r\n      return this._execute();\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (SpecialKey.Escape === event.key) {\r\n      // istanbul ignore else\r\n      if (this.props.onCancel)\r\n        this.props.onCancel();\r\n      return;\r\n    }\r\n  };\r\n\r\n  private _onInputFocus = (event: React.FocusEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (event.target) {\r\n      event.target.select();\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestEnter = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    // istanbul ignore else\r\n    if (this._processInputValue(inputValue)) {\r\n      setTimeout(async () => {\r\n        await this._execute();\r\n      });\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestTab = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    this._processInputValue(inputValue);\r\n  };\r\n\r\n  private _processInputValue(inputValue: string): boolean {\r\n    let currentKeyin = \"\";\r\n    let foundTool: typeof Tool | undefined;\r\n\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool)\r\n        currentKeyin = foundTool.keyin;\r\n    }\r\n\r\n    // istanbul ignore next\r\n    if (inputValue !== currentKeyin) {\r\n      const inputValueLower = inputValue.trim().toLowerCase();\r\n      foundTool = IModelApp.tools.getToolList()\r\n        .find((tool: typeof Tool) => tool.keyin.toLowerCase() === inputValueLower || tool.englishKeyin.toLowerCase() === inputValueLower);\r\n\r\n      if (!foundTool) {\r\n        this._outputMessage(UiFramework.translate(\"keyinbrowser.couldNotFindTool\"));\r\n        return false;\r\n      } else {\r\n        const currentToolId = foundTool.toolId;\r\n        // istanbul ignore else\r\n        if (this._isMounted)\r\n          this.setState({ currentToolId });\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  private _onAutoSuggestEscape = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n    // istanbul ignore else\r\n    if (this.props.onCancel)\r\n      this.props.onCancel();\r\n  };\r\n\r\n  /** Calculate suggestions for any given input value. */\r\n  private _getSuggestions = async (value: string): Promise<AutoSuggestData[]> => {\r\n    const inputValue = value.trim().toLowerCase();\r\n    const inputLength = inputValue.length;\r\n\r\n    return Promise.resolve(\r\n      inputLength === 0 ?\r\n        /* istanbul ignore next */[] :\r\n        this.state.keyins.filter((data: KeyinBrowserData) => {\r\n          return data.label.toLowerCase().includes(inputValue) || data.englishKeyin.toLowerCase().includes(inputValue);\r\n        })\r\n    );\r\n  };\r\n\r\n  /** @internal */\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <div className=\"uif-keyinbrowser-div\">\r\n        <InputLabel label={this._toolIdLabel}>\r\n          <AutoSuggest value={this.state.currentToolId} style={{ width: \"250px\" }}\r\n            placeholder={this._suggestPlaceholder} options={this.state.keyins}\r\n            onSuggestionSelected={this._onKeyinSelected} onPressEnter={this._onAutoSuggestEnter}\r\n            onPressTab={this._onAutoSuggestTab} onPressEscape={this._onAutoSuggestEscape} onInputFocus={this._onInputFocus}\r\n            getSuggestions={this._getSuggestions} data-testid=\"uif-keyin-autosuggest\" />\r\n        </InputLabel>\r\n        <LabeledInput label={this._argsLabel} title={this._argsTip} value={this.state.currentArgs}\r\n          data-testid=\"uif-keyin-arguments\" id=\"uif-keyin-arguments\"\r\n          onKeyDown={this._onKeyDown} onChange={this._onArgumentsChange} onFocus={this._onInputFocus} size=\"small\" />\r\n        <Button styleType=\"cta\" data-testid=\"uif-keyin-browser-execute\" onClick={this._onClick}>{this._executeLabel}</Button>\r\n      </div>\r\n    );\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"KeyinBrowser.js","sourceRoot":"","sources":["../../../../src/appui-react/keyinbrowser/KeyinBrowser.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;;;AAEH,+BAA6B;AAC7B,oDAAoD;AACpD,+BAA+B;AAC/B,wDAAuH;AACvH,kDAA0F;AAC1F,wDAA4D;AAC5D,gDAA6C;AAC7C,0DAAmD;AA0CnD;;;GAGG;AACH,MAAa,YAAa,SAAQ,KAAK,CAAC,aAAmD;IASzF,gBAAgB;IAChB,YAAY,KAAU;QACpB,KAAK,CAAC,KAAK,CAAC,CAAC;QAVP,iBAAY,GAAG,yBAAW,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC3D,eAAU,GAAG,yBAAW,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACxD,aAAQ,GAAG,yBAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QACzD,kBAAa,GAAG,yBAAW,CAAC,SAAS,CAAC,sBAAsB,CAAC,CAAC;QAC9D,wBAAmB,GAAG,yBAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACxE,eAAU,GAAG,oBAAoB,CAAC;QAClC,eAAU,GAAG,KAAK,CAAC;QAyEnB,aAAQ,GAAG,KAAK,IAAI,EAAE;YAC5B,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;QACzB,CAAC,CAAC;QAiDM,mBAAc,GAAG,CAAC,GAAW,EAAE,EAAE;YACvC,MAAM,OAAO,GAAG,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,iCAAiB,CAAC,KAAK,CAAC,CAAC;YAC/G,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC,CAAC;QAEF,uBAAuB;QACf,qBAAgB,GAAG,CAAC,QAAyB,EAAQ,EAAE;YAC7D,MAAM,aAAa,GAAG,QAAQ,CAAC,KAAK,CAAC;YACrC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YACpD,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC;QAEM,uBAAkB,GAAG,CAAC,KAA0C,EAAQ,EAAE;YAChF,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC;QAEM,eAAU,GAAG,KAAK,EAAE,KAA4C,EAAiB,EAAE;YACzF,IAAI,2BAAU,CAAC,KAAK,KAAK,KAAK,CAAC,GAAG,EAAE;gBAClC,KAAK,CAAC,eAAe,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;aACxB;YAED,uBAAuB;YACvB,IAAI,2BAAU,CAAC,MAAM,KAAK,KAAK,CAAC,GAAG,EAAE;gBACnC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;oBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;gBACxB,OAAO;aACR;QACH,CAAC,CAAC;QAEM,kBAAa,GAAG,CAAC,KAAyC,EAAQ,EAAE;YAC1E,uBAAuB;YACvB,IAAI,KAAK,CAAC,MAAM,EAAE;gBAChB,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;aACvB;QACH,CAAC,CAAC;QAEM,wBAAmB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YACjE,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,uBAAuB;YACvB,IAAI,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;gBACvC,UAAU,CAAC,KAAK,IAAI,EAAE;oBACpB,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACxB,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC;QAEM,sBAAiB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAC/D,KAAK,CAAC,eAAe,EAAE,CAAC;YAExB,MAAM,UAAU,GAAI,KAAK,CAAC,MAA2B,CAAC,KAAK,CAAC;YAC5D,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACtC,CAAC,CAAC;QAiCM,yBAAoB,GAAG,CAAC,KAA0B,EAAQ,EAAE;YAClE,KAAK,CAAC,eAAe,EAAE,CAAC;YACxB,uBAAuB;YACvB,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ;gBACrB,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC,CAAC;QAEF,uDAAuD;QAC/C,oBAAe,GAAG,KAAK,EAAE,KAAa,EAA8B,EAAE;YAC5E,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC;YAEtC,OAAO,OAAO,CAAC,OAAO,CACpB,WAAW,KAAK,CAAC,CAAC,CAAC;gBACjB,0BAA0B,CAAA,EAAE,CAAC,CAAC;gBAC9B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAsB,EAAE,EAAE;oBAClD,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBAC/G,CAAC,CAAC,CACL,CAAC;QACJ,CAAC,CAAC;QAtOA,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAEpD,IAAI,CAAC,KAAK,GAAG;YACX,MAAM,EAAE,EAAE;YACV,aAAa;YACb,WAAW;SACZ,CAAC;IACJ,CAAC;IAED,gBAAgB;IACA,iBAAiB;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QAEvB,IAAI,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACpC,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAE1B,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAkB,EAAE,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;YACjG,uBAAuB;YACvB,IAAI,IAAI,CAAC,UAAU;gBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACA,oBAAoB;QAClC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAEO,UAAU,CAAC,MAA0B;QAC3C,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAC7B,OAAO,gBAAgB,MAAM,EAAE,CAAC;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IACrC,CAAC;IAEO,WAAW,CAAC,MAA0B;QAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxC,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAClD,qBAAqB;YACrB,IAAI,IAAI,IAAI,0BAA0B,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBACpG,OAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACjD;SACF;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEO,eAAe;QACrB,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE;aAC1B,OAAO,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;QAC3H,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,YAAY;QAClB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;SAC1C;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAMO,KAAK,CAAC,QAAQ;QACpB,IAAI,MAA0B,CAAC;QAC/B,IAAI,IAAI,GAAa,EAAE,CAAC;QACxB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,MAAM,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACjE,uBAAuB;YACvB,IAAI,SAAS,EAAE;gBACb,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;gBAC1B,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC3B,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;gBAElC,IAAI,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE;oBACvF,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,CAAC;oBACzE,OAAO;iBACR;gBAED,IAAI,GAAG,GAAG,oBAAoB,CAAC;gBAC/B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBAEzC,qBAAqB;gBACrB,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;oBAC3B,GAAG,GAAG,gBAAgB,MAAM,EAAE,CAAC;oBAC/B,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;oBAC5C,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;iBAClD;gBAED,MAAM,IAAI,GAAG,IAAI,SAAS,EAAE,CAAC;gBAC7B,SAAS,GAAG,KAAK,CAAC;gBAElB,IAAI;oBACF,SAAS,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC5G,CAAC,SAAS,IAAI,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC,CAAC;iBACtF;gBAAC,OAAO,CAAC,EAAE;oBACV,uBAAuB;oBACvB,IAAI,CAAC,cAAc,CAAC,GAAG,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;iBACzF;aACF;SACF;QAED,uBAAuB;QACvB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS;YACtB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IA+DO,kBAAkB,CAAC,UAAkB;QAC3C,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,SAAkC,CAAC;QAEvC,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YACnE,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YAC3D,uBAAuB;YACvB,IAAI,SAAS;gBACX,YAAY,GAAG,SAAS,CAAC,KAAK,CAAC;SAClC;QAED,uBAAuB;QACvB,IAAI,UAAU,KAAK,YAAY,EAAE;YAC/B,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YACxD,SAAS,GAAG,yBAAS,CAAC,KAAK,CAAC,WAAW,EAAE;iBACtC,IAAI,CAAC,CAAC,IAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,eAAe,IAAI,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,KAAK,eAAe,CAAC,CAAC;YAEpI,IAAI,CAAC,SAAS,EAAE;gBACd,IAAI,CAAC,cAAc,CAAC,yBAAW,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC,CAAC;gBAC5E,OAAO,KAAK,CAAC;aACd;iBAAM;gBACL,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC;gBACvC,uBAAuB;gBACvB,IAAI,IAAI,CAAC,UAAU;oBACjB,IAAI,CAAC,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC;aACpC;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAuBD,gBAAgB;IACA,MAAM;QACpB,OAAO,CACL,6BAAK,SAAS,EAAC,sBAAsB;YACnC,oBAAC,uBAAU,IAAC,KAAK,EAAE,IAAI,CAAC,YAAY;gBAClC,oBAAC,wBAAW,IAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,EACrE,WAAW,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,EACjE,oBAAoB,EAAE,IAAI,CAAC,gBAAgB,EAAE,YAAY,EAAE,IAAI,CAAC,mBAAmB,EACnF,UAAU,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,EAAE,IAAI,CAAC,oBAAoB,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAC9G,cAAc,EAAE,IAAI,CAAC,eAAe,iBAAc,uBAAuB,GAAG,CACnE;YACb,oBAAC,4BAAY,IAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,iBAC3E,qBAAqB,EAAC,EAAE,EAAC,qBAAqB,EAC1D,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,EAAC,OAAO,GAAG;YAC7G,oBAAC,sBAAM,IAAC,SAAS,EAAC,KAAK,iBAAa,2BAA2B,EAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,IAAG,IAAI,CAAC,aAAa,CAAU,CACjH,CACP,CAAC;IACJ,CAAC;CACF;AAtQD,oCAsQC","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport \"./KeyinBrowser.scss\";\r\n// cSpell:ignore Modeless keyins keyinbrowser testid\r\nimport * as React from \"react\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType, Tool } from \"@itwin/core-frontend\";\r\nimport { AutoSuggest, AutoSuggestData, CommonProps, InputLabel } from \"@itwin/core-react\";\r\nimport { Button, LabeledInput } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SpecialKey } from \"@itwin/appui-abstract\";\r\n\r\n/** Data for each key-in.\r\n @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react) */\r\ninterface KeyinBrowserData extends AutoSuggestData {\r\n  // AutoSuggestData.value is the toolId\r\n  // AutoSuggestData.label is the keyin\r\n\r\n  /** English key-in - Browser supports both English and localized key-ins */\r\n  englishKeyin: string;\r\n}\r\n\r\n/** State of key-in browser.\r\n @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react)*/\r\ninterface KeyinBrowserState {\r\n  keyins: KeyinBrowserData[];\r\n  currentToolId: string | undefined;\r\n  currentArgs: string;\r\n}\r\n\r\n/** Arguments for [[KeyinBrowserProps]] onExecute callback.\r\n * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).\r\n */\r\nexport interface KeyinBrowserExecuteArgs {\r\n  /** Id of the tool that was run */\r\n  toolId: string | undefined;\r\n  /** Arguments passed to the tool */\r\n  args: string[];\r\n  /** Status of the key-in run */\r\n  runStatus: boolean;\r\n}\r\n\r\n/** Properties of the [[KeyinBrowser]] component.\r\n * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).\r\n */\r\nexport interface KeyinBrowserProps extends CommonProps {\r\n  /** Function called after the key-in is executed */\r\n  onExecute?: (args: KeyinBrowserExecuteArgs) => void;\r\n  /** Function called on Escape or popup close */\r\n  onCancel?: () => void;\r\n}\r\n\r\n/**\r\n * Component used to allow users to select, provide arguments, and execute a key-in.\r\n * @beta @deprecated in 3.0. Key-in browser replaced by [KeyinPalettePopup]($appui-react).\r\n */\r\nexport class KeyinBrowser extends React.PureComponent<KeyinBrowserProps, KeyinBrowserState> {\r\n  private _toolIdLabel = UiFramework.translate(\"keyinbrowser.keyin\");\r\n  private _argsLabel = UiFramework.translate(\"keyinbrowser.args\");\r\n  private _argsTip = UiFramework.translate(\"keyinbrowser.argsTip\");\r\n  private _executeLabel = UiFramework.translate(\"keyinbrowser.execute\");\r\n  private _suggestPlaceholder = UiFramework.translate(\"keyinbrowser.placeholder\");\r\n  private _toolIdKey = \"keyinbrowser:keyin\";\r\n  private _isMounted = false;\r\n\r\n  /** @internal */\r\n  constructor(props: any) {\r\n    super(props);\r\n    const currentToolId = this.getSavedToolId();\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n\r\n    this.state = {\r\n      keyins: [],\r\n      currentToolId,\r\n      currentArgs,\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentDidMount() {\r\n    this._isMounted = true;\r\n\r\n    let keyins = this.getToolKeyinMap();\r\n    this.setState({ keyins });\r\n\r\n    setTimeout(() => {\r\n      keyins = keyins.sort((a: AutoSuggestData, b: AutoSuggestData) => a.label.localeCompare(b.label));\r\n      // istanbul ignore else\r\n      if (this._isMounted)\r\n        this.setState({ keyins });\r\n    });\r\n  }\r\n\r\n  /** @internal */\r\n  public override componentWillUnmount() {\r\n    this._isMounted = false;\r\n  }\r\n\r\n  private getArgsKey(toolId: string | undefined): string | undefined {\r\n    if (toolId && toolId.length > 0)\r\n      return `keyinbrowser:${toolId}`;\r\n    return undefined;\r\n  }\r\n\r\n  private getSavedToolId(): string | undefined {\r\n    const toolId = window.localStorage.getItem(this._toolIdKey);\r\n    return toolId ? toolId : undefined;\r\n  }\r\n\r\n  private getToolArgs(toolId: string | undefined): string {\r\n    const argsKey = this.getArgsKey(toolId);\r\n    if (argsKey && argsKey.length > 0) {\r\n      const args = window.localStorage.getItem(argsKey);\r\n      // istanbul ignore if\r\n      if (args && /* istanbul ignore next */ args.length > 0 && /* istanbul ignore next */ args[0] === \"[\") {\r\n        return (JSON.parse(args) as string[]).join(\"|\");\r\n      }\r\n    }\r\n    return \"\";\r\n  }\r\n\r\n  private getToolKeyinMap(): KeyinBrowserData[] {\r\n    const keyins: KeyinBrowserData[] = [];\r\n    IModelApp.tools.getToolList()\r\n      .forEach((tool: typeof Tool) => keyins.push({ value: tool.toolId, label: tool.keyin, englishKeyin: tool.englishKeyin }));\r\n    return keyins;\r\n  }\r\n\r\n  private getArgsArray(): string[] {\r\n    // istanbul ignore else\r\n    if (this.state.currentArgs.length > 0) {\r\n      return this.state.currentArgs.split(\"|\");\r\n    }\r\n    return [];\r\n  }\r\n\r\n  private _onClick = async () => {\r\n    return this._execute();\r\n  };\r\n\r\n  private async _execute(): Promise<void> {\r\n    let toolId: string | undefined;\r\n    let args: string[] = [];\r\n    let runStatus = false;\r\n\r\n    // istanbul ignore else\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      const foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool) {\r\n        toolId = foundTool.toolId;\r\n        args = this.getArgsArray();\r\n        const maxArgs = foundTool.maxArgs;\r\n\r\n        if (args.length < foundTool.minArgs || (undefined !== maxArgs && args.length > maxArgs)) {\r\n          this._outputMessage(UiFramework.translate(\"keyinbrowser.incorrectArgs\"));\r\n          return;\r\n        }\r\n\r\n        let key = \"keyinbrowser:keyin\";\r\n        window.localStorage.setItem(key, toolId);\r\n\r\n        // istanbul ignore if\r\n        if (args && args.length > 0) {\r\n          key = `keyinbrowser:${toolId}`;\r\n          const objectAsString = JSON.stringify(args);\r\n          window.localStorage.setItem(key, objectAsString);\r\n        }\r\n\r\n        const tool = new foundTool();\r\n        runStatus = false;\r\n\r\n        try {\r\n          runStatus = args.length > 0 ? /* istanbul ignore next */ await tool.parseAndRun(...args) : await tool.run();\r\n          !runStatus && this._outputMessage(UiFramework.translate(\"keyinbrowser.failedToRun\"));\r\n        } catch (e) {\r\n          // istanbul ignore next\r\n          this._outputMessage(`${UiFramework.translate(\"keyinbrowser.exceptionOccurred\")}: ${e}`);\r\n        }\r\n      }\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (this.props.onExecute)\r\n      this.props.onExecute({ toolId, args, runStatus });\r\n  }\r\n\r\n  private _outputMessage = (msg: string) => {\r\n    const details = new NotifyMessageDetails(OutputMessagePriority.Error, msg, undefined, OutputMessageType.Alert);\r\n    IModelApp.notifications.outputMessage(details);\r\n  };\r\n\r\n  // istanbul ignore next\r\n  private _onKeyinSelected = (selected: AutoSuggestData): void => {\r\n    const currentToolId = selected.value;\r\n    const currentArgs = this.getToolArgs(currentToolId);\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentToolId, currentArgs });\r\n  };\r\n\r\n  private _onArgumentsChange = (event: React.ChangeEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (this._isMounted)\r\n      this.setState({ currentArgs: event.target.value });\r\n  };\r\n\r\n  private _onKeyDown = async (event: React.KeyboardEvent<HTMLInputElement>): Promise<void> => {\r\n    if (SpecialKey.Enter === event.key) {\r\n      event.stopPropagation();\r\n      return this._execute();\r\n    }\r\n\r\n    // istanbul ignore else\r\n    if (SpecialKey.Escape === event.key) {\r\n      // istanbul ignore else\r\n      if (this.props.onCancel)\r\n        this.props.onCancel();\r\n      return;\r\n    }\r\n  };\r\n\r\n  private _onInputFocus = (event: React.FocusEvent<HTMLInputElement>): void => {\r\n    // istanbul ignore else\r\n    if (event.target) {\r\n      event.target.select();\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestEnter = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    // istanbul ignore else\r\n    if (this._processInputValue(inputValue)) {\r\n      setTimeout(async () => {\r\n        await this._execute();\r\n      });\r\n    }\r\n  };\r\n\r\n  private _onAutoSuggestTab = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n\r\n    const inputValue = (event.target as HTMLInputElement).value;\r\n    this._processInputValue(inputValue);\r\n  };\r\n\r\n  private _processInputValue(inputValue: string): boolean {\r\n    let currentKeyin = \"\";\r\n    let foundTool: typeof Tool | undefined;\r\n\r\n    if (this.state.currentToolId && this.state.currentToolId.length > 0) {\r\n      foundTool = IModelApp.tools.find(this.state.currentToolId);\r\n      // istanbul ignore else\r\n      if (foundTool)\r\n        currentKeyin = foundTool.keyin;\r\n    }\r\n\r\n    // istanbul ignore next\r\n    if (inputValue !== currentKeyin) {\r\n      const inputValueLower = inputValue.trim().toLowerCase();\r\n      foundTool = IModelApp.tools.getToolList()\r\n        .find((tool: typeof Tool) => tool.keyin.toLowerCase() === inputValueLower || tool.englishKeyin.toLowerCase() === inputValueLower);\r\n\r\n      if (!foundTool) {\r\n        this._outputMessage(UiFramework.translate(\"keyinbrowser.couldNotFindTool\"));\r\n        return false;\r\n      } else {\r\n        const currentToolId = foundTool.toolId;\r\n        // istanbul ignore else\r\n        if (this._isMounted)\r\n          this.setState({ currentToolId });\r\n      }\r\n    }\r\n\r\n    return true;\r\n  }\r\n\r\n  private _onAutoSuggestEscape = (event: React.KeyboardEvent): void => {\r\n    event.stopPropagation();\r\n    // istanbul ignore else\r\n    if (this.props.onCancel)\r\n      this.props.onCancel();\r\n  };\r\n\r\n  /** Calculate suggestions for any given input value. */\r\n  private _getSuggestions = async (value: string): Promise<AutoSuggestData[]> => {\r\n    const inputValue = value.trim().toLowerCase();\r\n    const inputLength = inputValue.length;\r\n\r\n    return Promise.resolve(\r\n      inputLength === 0 ?\r\n        /* istanbul ignore next */[] :\r\n        this.state.keyins.filter((data: KeyinBrowserData) => {\r\n          return data.label.toLowerCase().includes(inputValue) || data.englishKeyin.toLowerCase().includes(inputValue);\r\n        })\r\n    );\r\n  };\r\n\r\n  /** @internal */\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <div className=\"uif-keyinbrowser-div\">\r\n        <InputLabel label={this._toolIdLabel}>\r\n          <AutoSuggest value={this.state.currentToolId} style={{ width: \"250px\" }}\r\n            placeholder={this._suggestPlaceholder} options={this.state.keyins}\r\n            onSuggestionSelected={this._onKeyinSelected} onPressEnter={this._onAutoSuggestEnter}\r\n            onPressTab={this._onAutoSuggestTab} onPressEscape={this._onAutoSuggestEscape} onInputFocus={this._onInputFocus}\r\n            getSuggestions={this._getSuggestions} data-testid=\"uif-keyin-autosuggest\" />\r\n        </InputLabel>\r\n        <LabeledInput label={this._argsLabel} title={this._argsTip} value={this.state.currentArgs}\r\n          data-testid=\"uif-keyin-arguments\" id=\"uif-keyin-arguments\"\r\n          onKeyDown={this._onKeyDown} onChange={this._onArgumentsChange} onFocus={this._onInputFocus} size=\"small\" />\r\n        <Button styleType=\"cta\" data-testid=\"uif-keyin-browser-execute\" onClick={this._onClick}>{this._executeLabel}</Button>\r\n      </div>\r\n    );\r\n  }\r\n}\r\n"]}

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

@@ -5,7 +5,7 @@
 import { ActivityMessageEventArgs } from "../messages/MessageManager";
 import { ToasterSettings } from "@itwin/itwinui-react/cjs/core/Toast/Toaster";
 /** Properties for a [[ActivityMessage]]
- * @deprecated Props of a deprecated component.
+ * @deprecated in 3.5. Props of a deprecated component.
  * @public
  */
 export interface ActivityMessageProps {
@@ -15,7 +15,7 @@ export interface ActivityMessageProps {
 }
 /** Activity Message React component
  * @public
- * @deprecated
+ * @deprecated in 3.3. Replaced by Toaster from @itwin/itwinui-react.
  */
 export declare function ActivityMessage(props: ActivityMessageProps): JSX.Element;
 interface CustomActivityMessageProps {

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

@@ -18,7 +18,7 @@ const MessageLabel_1 = require("./MessageLabel");
 const HollowIcon_1 = require("./HollowIcon");
 /** Activity Message React component
  * @public
- * @deprecated
+ * @deprecated in 3.3. Replaced by Toaster from @itwin/itwinui-react.
  */
 function ActivityMessage(props) {
     const messageDetails = props.activityMessageInfo.details;

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

@@ -1 +1 @@
-{"version":3,"file":"ActivityMessage.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAAiD;AACjD,kEAOmC;AACnC,wDAA4E;AAC5E,gDAA6C;AAC7C,+DAAsF;AACtF,iDAA8C;AAC9C,6CAA0C;AAa1C;;;GAGG;AACH,SAAgB,eAAe,CAAC,KAA2B;IACzD,MAAM,cAAc,GAAG,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC;IACzD,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,mBAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAExE,OAAO,CACL,oBAAC,4BAAO,CAAC,8CAA8C;QACrD,MAAM,EAAE,2BAAM,CAAC,WAAW,EAC1B,IAAI,EAAE,oBAAC,uBAAU,IAAC,QAAQ,EAAC,kBAAkB,GAAG;QAEhD,oBAAC,kCAAa,IACZ,OAAO,EAAE,CAAC,cAAc,IAAI,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CACjE;gBACE,oBAAC,qCAAgB,IAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,IACnD,WAAW,CACK;gBACnB,2CAAmB;gBACnB,oBAAC,kCAAa,IAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB;oBAClD,oBAAC,iBAAI,IAAC,QAAQ,EAAC,YAAY,GAAG,CAChB,CACZ,CACP,CAAC,CAAC,CAAC,CACF,oBAAC,kCAAa,IAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB;gBAClD,oBAAC,iBAAI,IAAC,QAAQ,EAAC,YAAY,GAAG,CAChB,CACjB,EACD,QAAQ,EAAE,CAAC,cAAc,IAAI,cAAc,CAAC,eAAe,CAAC;gBACxD,oBAAC,oCAAe,IACd,MAAM,EAAE,2BAAM,CAAC,WAAW,EAC1B,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,GAC9C;YAGN;gBACE,oBAAC,2BAAY,IAAC,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAC,8BAA8B,GAAG;gBACpG,CAAC,cAAc,IAAI,cAAc,CAAC,oBAAoB,CAAC;oBACtD,oBAAC,qBAAK,QAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,GAAG,oBAAoB,CAAS,CAE1E,CACQ,CACR,CACX,CAAC;AACJ,CAAC;AA1CD,0CA0CC;AASD;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAA6B;IAC3I,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,mBAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAmC,CAAC;IACpE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAO,CAAC,WAAW,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAC,SAAS,EAAE,KAAK,EAAC,CAAC,CAAC;IACtD,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,IAAI,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,QAAQ,EAAE;YACjC,WAAW,CAAC,OAAO,GAAG,uBAAO,CAAC,aAAa,CACzC,oBAAC,4BAA4B,IAAC,0BAA0B,EAAE,mBAAmB,GAAI,EACjF,EAAE,QAAQ,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,OAAO,0CAAE,oBAAoB,KAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,EAAC,CAChN,CAAC;SACH;QACD,IAAI,CAAC,mBAAmB,EAAE;YACxB,MAAA,WAAW,CAAC,OAAO,0CAAE,KAAK,EAAE,CAAC;SAC9B;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;AACxF,CAAC;AAlBD,gDAkBC;AAED;;;GAGG;AACH,SAAgB,6BAA6B,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAA6B;IACtJ,kBAAkB,CAAC,EAAC,mBAAmB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,QAAQ,EAAC,CAAC,CAAC;IAEnG,OAAO,yCAAK,CAAC;AACf,CAAC;AAJD,sEAIC;AAED;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,EAAC,0BAA0B,EAAyD;;IAC/H,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEjG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iCAAiC,GAAG,CAAC,IAA8B,EAAE,EAAE;YAC3E,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,OAAO,+BAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;IACrG,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL;QACG,mBAAmB,CAAC,OAAO,IAAI,oBAAC,oBAAI,QAAE,mBAAmB,CAAC,OAAO,CAAQ;QACzE,CAAC,CAAC,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,oBAAoB,CAAA;YAClD,oBAAC,qBAAK,QAAE,GAAG,mBAAmB,CAAC,UAAU,IAAI,oBAAoB,EAAE,CAAS;QAE7E,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,eAAe,KAAI,oBAAC,8BAAc,IAAC,KAAK,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,UAAU,GAAI,CAC1G,CACJ,CAAC;AACJ,CAAC;AArBD,oEAqBC","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 Notification\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Icon, UiCore } from \"@itwin/core-react\";\r\nimport {\r\n  Message,\r\n  MessageButton,\r\n  MessageHyperlink,\r\n  MessageLayout,\r\n  MessageProgress,\r\n  Status,\r\n} from \"@itwin/appui-layout-react\";\r\nimport { ProgressLinear, Small, Text, toaster } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ActivityMessageEventArgs, MessageManager } from \"../messages/MessageManager\";\r\nimport { MessageLabel } from \"./MessageLabel\";\r\nimport { HollowIcon } from \"./HollowIcon\";\r\nimport { ToasterSettings } from \"@itwin/itwinui-react/cjs/core/Toast/Toaster\";\r\n\r\n/** Properties for a [[ActivityMessage]]\r\n * @deprecated Props of a deprecated component.\r\n * @public\r\n */\r\nexport interface ActivityMessageProps {\r\n  activityMessageInfo: ActivityMessageEventArgs;\r\n  cancelActivityMessage: () => void;\r\n  dismissActivityMessage: () => void;\r\n}\r\n\r\n/** Activity Message React component\r\n * @public\r\n * @deprecated\r\n */\r\nexport function ActivityMessage(props: ActivityMessageProps) { // eslint-disable-line deprecation/deprecation\r\n  const messageDetails = props.activityMessageInfo.details;\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n\r\n  return (\r\n    <Message // eslint-disable-line deprecation/deprecation\r\n      status={Status.Information}\r\n      icon={<HollowIcon iconSpec=\"icon-info-hollow\" />}\r\n    >\r\n      <MessageLayout\r\n        buttons={(messageDetails && messageDetails.supportsCancellation) ? (\r\n          <div>\r\n            <MessageHyperlink onClick={props.cancelActivityMessage}>\r\n              {cancelLabel}\r\n            </MessageHyperlink>\r\n            <span>&nbsp;</span>\r\n            <MessageButton onClick={props.dismissActivityMessage}>\r\n              <Icon iconSpec=\"icon-close\" />\r\n            </MessageButton>\r\n          </div>\r\n        ) : (\r\n          <MessageButton onClick={props.dismissActivityMessage}>\r\n            <Icon iconSpec=\"icon-close\" />\r\n          </MessageButton>\r\n        )}\r\n        progress={(messageDetails && messageDetails.showProgressBar) &&\r\n            <MessageProgress\r\n              status={Status.Information}\r\n              progress={props.activityMessageInfo.percentage}\r\n            />\r\n        }\r\n      >\r\n        <div>\r\n          <MessageLabel message={props.activityMessageInfo.message} className=\"uifw-statusbar-message-brief\" />\r\n          {(messageDetails && messageDetails.showPercentInMessage) &&\r\n            <Small>{props.activityMessageInfo.percentage + percentCompleteLabel}</Small>\r\n          }\r\n        </div>\r\n      </MessageLayout>\r\n    </Message>\r\n  );\r\n}\r\n\r\ninterface CustomActivityMessageProps {\r\n  cancelActivityMessage?: () => void;\r\n  dismissActivityMessage?: () => void;\r\n  activityMessageInfo?: ActivityMessageEventArgs;\r\n  settings?: ToasterSettings;\r\n}\r\n\r\n/**\r\n * Hook to render an Activity message.\r\n * @internal\r\n */\r\nexport function useActivityMessage({activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings}: CustomActivityMessageProps) {\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n  const recentToast = React.useRef<{close: () => void} | undefined>();\r\n  React.useEffect(() => {\r\n    toaster.setSettings(settings ?? {placement: \"top\"});\r\n  }, [settings]);\r\n\r\n  React.useEffect(() => {\r\n    if (activityMessageInfo?.restored) {\r\n      recentToast.current = toaster.informational(\r\n        <CustomActivityMessageContent initialActivityMessageInfo={activityMessageInfo} />,\r\n        { onRemove: dismissActivityMessage, type: \"persisting\", link: activityMessageInfo?.details?.supportsCancellation && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined}\r\n      );\r\n    }\r\n    if (!activityMessageInfo) {\r\n      recentToast.current?.close();\r\n    }\r\n  }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);\r\n}\r\n\r\n/**\r\n * Component wrapping the `useActivityMessage` hook to use in class components.\r\n * @internal\r\n */\r\nexport function CustomActivityMessageRenderer({activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings}: CustomActivityMessageProps) {\r\n  useActivityMessage({activityMessageInfo, cancelActivityMessage, dismissActivityMessage, settings});\r\n\r\n  return <></>;\r\n}\r\n\r\n/**\r\n * Component used to show and update activity message content.\r\n * @internal\r\n */\r\nexport function CustomActivityMessageContent({initialActivityMessageInfo}: {initialActivityMessageInfo: ActivityMessageEventArgs})  {\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);\r\n\r\n  React.useEffect(() => {\r\n    const handleActivityMessageUpdatedEvent = (args: ActivityMessageEventArgs) => {\r\n      setActivityMessageInfo(args);\r\n    };\r\n\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);\r\n  }, []);\r\n\r\n  return (\r\n    <>\r\n      {activityMessageInfo.message && <Text>{activityMessageInfo.message}</Text>}\r\n      {!!activityMessageInfo.details?.showPercentInMessage &&\r\n        <Small>{`${activityMessageInfo.percentage} ${percentCompleteLabel}`}</Small>\r\n      }\r\n      {activityMessageInfo.details?.showProgressBar && <ProgressLinear value={activityMessageInfo?.percentage} />}\r\n    </>\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"ActivityMessage.js","sourceRoot":"","sources":["../../../../src/appui-react/messages/ActivityMessage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAAiD;AACjD,kEAOmC;AACnC,wDAA4E;AAC5E,gDAA6C;AAC7C,+DAAsF;AACtF,iDAA8C;AAC9C,6CAA0C;AAa1C;;;GAGG;AACH,SAAgB,eAAe,CAAC,KAA2B;IACzD,MAAM,cAAc,GAAG,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC;IACzD,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,mBAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAExE,OAAO,CACL,oBAAC,4BAAO,CAAC,8CAA8C;QACrD,MAAM,EAAE,2BAAM,CAAC,WAAW,EAC1B,IAAI,EAAE,oBAAC,uBAAU,IAAC,QAAQ,EAAC,kBAAkB,GAAG;QAEhD,oBAAC,kCAAa,IACZ,OAAO,EAAE,CAAC,cAAc,IAAI,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CACjE;gBACE,oBAAC,qCAAgB,IAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,IACnD,WAAW,CACK;gBACnB,2CAAmB;gBACnB,oBAAC,kCAAa,IAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB;oBAClD,oBAAC,iBAAI,IAAC,QAAQ,EAAC,YAAY,GAAG,CAChB,CACZ,CACP,CAAC,CAAC,CAAC,CACF,oBAAC,kCAAa,IAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB;gBAClD,oBAAC,iBAAI,IAAC,QAAQ,EAAC,YAAY,GAAG,CAChB,CACjB,EACD,QAAQ,EAAE,CAAC,cAAc,IAAI,cAAc,CAAC,eAAe,CAAC;gBACxD,oBAAC,oCAAe,IACd,MAAM,EAAE,2BAAM,CAAC,WAAW,EAC1B,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,GAC9C;YAGN;gBACE,oBAAC,2BAAY,IAAC,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAC,8BAA8B,GAAG;gBACpG,CAAC,cAAc,IAAI,cAAc,CAAC,oBAAoB,CAAC;oBACtD,oBAAC,qBAAK,QAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,GAAG,oBAAoB,CAAS,CAE1E,CACQ,CACR,CACX,CAAC;AACJ,CAAC;AA1CD,0CA0CC;AASD;;;GAGG;AACH,SAAgB,kBAAkB,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAA6B;IAC3I,MAAM,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,mBAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IACxE,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,EAAmC,CAAC;IACpE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,uBAAO,CAAC,WAAW,CAAC,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAC,SAAS,EAAE,KAAK,EAAC,CAAC,CAAC;IACtD,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEf,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;;QACnB,IAAI,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,QAAQ,EAAE;YACjC,WAAW,CAAC,OAAO,GAAG,uBAAO,CAAC,aAAa,CACzC,oBAAC,4BAA4B,IAAC,0BAA0B,EAAE,mBAAmB,GAAI,EACjF,EAAE,QAAQ,EAAE,sBAAsB,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA,MAAA,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,OAAO,0CAAE,oBAAoB,KAAI,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC,SAAS,EAAC,CAChN,CAAC;SACH;QACD,IAAI,CAAC,mBAAmB,EAAE;YACxB,MAAA,WAAW,CAAC,OAAO,0CAAE,KAAK,EAAE,CAAC;SAC9B;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,qBAAqB,EAAE,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;AACxF,CAAC;AAlBD,gDAkBC;AAED;;;GAGG;AACH,SAAgB,6BAA6B,CAAC,EAAC,mBAAmB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,QAAQ,EAA6B;IACtJ,kBAAkB,CAAC,EAAC,mBAAmB,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,QAAQ,EAAC,CAAC,CAAC;IAEnG,OAAO,yCAAK,CAAC;AACf,CAAC;AAJD,sEAIC;AAED;;;GAGG;AACH,SAAgB,4BAA4B,CAAC,EAAC,0BAA0B,EAAyD;;IAC/H,MAAM,CAAC,oBAAoB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,yBAAW,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC,CAAC;IACvG,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,CAAC;IAEjG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iCAAiC,GAAG,CAAC,IAA8B,EAAE,EAAE;YAC3E,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,OAAO,+BAAc,CAAC,6BAA6B,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAC;IACrG,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,CACL;QACG,mBAAmB,CAAC,OAAO,IAAI,oBAAC,oBAAI,QAAE,mBAAmB,CAAC,OAAO,CAAQ;QACzE,CAAC,CAAC,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,oBAAoB,CAAA;YAClD,oBAAC,qBAAK,QAAE,GAAG,mBAAmB,CAAC,UAAU,IAAI,oBAAoB,EAAE,CAAS;QAE7E,CAAA,MAAA,mBAAmB,CAAC,OAAO,0CAAE,eAAe,KAAI,oBAAC,8BAAc,IAAC,KAAK,EAAE,mBAAmB,aAAnB,mBAAmB,uBAAnB,mBAAmB,CAAE,UAAU,GAAI,CAC1G,CACJ,CAAC;AACJ,CAAC;AArBD,oEAqBC","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 Notification\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Icon, UiCore } from \"@itwin/core-react\";\r\nimport {\r\n  Message,\r\n  MessageButton,\r\n  MessageHyperlink,\r\n  MessageLayout,\r\n  MessageProgress,\r\n  Status,\r\n} from \"@itwin/appui-layout-react\";\r\nimport { ProgressLinear, Small, Text, toaster } from \"@itwin/itwinui-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ActivityMessageEventArgs, MessageManager } from \"../messages/MessageManager\";\r\nimport { MessageLabel } from \"./MessageLabel\";\r\nimport { HollowIcon } from \"./HollowIcon\";\r\nimport { ToasterSettings } from \"@itwin/itwinui-react/cjs/core/Toast/Toaster\";\r\n\r\n/** Properties for a [[ActivityMessage]]\r\n * @deprecated in 3.5. Props of a deprecated component.\r\n * @public\r\n */\r\nexport interface ActivityMessageProps {\r\n  activityMessageInfo: ActivityMessageEventArgs;\r\n  cancelActivityMessage: () => void;\r\n  dismissActivityMessage: () => void;\r\n}\r\n\r\n/** Activity Message React component\r\n * @public\r\n * @deprecated in 3.3. Replaced by Toaster from @itwin/itwinui-react.\r\n */\r\nexport function ActivityMessage(props: ActivityMessageProps) { // eslint-disable-line deprecation/deprecation\r\n  const messageDetails = props.activityMessageInfo.details;\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n\r\n  return (\r\n    <Message // eslint-disable-line deprecation/deprecation\r\n      status={Status.Information}\r\n      icon={<HollowIcon iconSpec=\"icon-info-hollow\" />}\r\n    >\r\n      <MessageLayout\r\n        buttons={(messageDetails && messageDetails.supportsCancellation) ? (\r\n          <div>\r\n            <MessageHyperlink onClick={props.cancelActivityMessage}>\r\n              {cancelLabel}\r\n            </MessageHyperlink>\r\n            <span>&nbsp;</span>\r\n            <MessageButton onClick={props.dismissActivityMessage}>\r\n              <Icon iconSpec=\"icon-close\" />\r\n            </MessageButton>\r\n          </div>\r\n        ) : (\r\n          <MessageButton onClick={props.dismissActivityMessage}>\r\n            <Icon iconSpec=\"icon-close\" />\r\n          </MessageButton>\r\n        )}\r\n        progress={(messageDetails && messageDetails.showProgressBar) &&\r\n            <MessageProgress\r\n              status={Status.Information}\r\n              progress={props.activityMessageInfo.percentage}\r\n            />\r\n        }\r\n      >\r\n        <div>\r\n          <MessageLabel message={props.activityMessageInfo.message} className=\"uifw-statusbar-message-brief\" />\r\n          {(messageDetails && messageDetails.showPercentInMessage) &&\r\n            <Small>{props.activityMessageInfo.percentage + percentCompleteLabel}</Small>\r\n          }\r\n        </div>\r\n      </MessageLayout>\r\n    </Message>\r\n  );\r\n}\r\n\r\ninterface CustomActivityMessageProps {\r\n  cancelActivityMessage?: () => void;\r\n  dismissActivityMessage?: () => void;\r\n  activityMessageInfo?: ActivityMessageEventArgs;\r\n  settings?: ToasterSettings;\r\n}\r\n\r\n/**\r\n * Hook to render an Activity message.\r\n * @internal\r\n */\r\nexport function useActivityMessage({activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings}: CustomActivityMessageProps) {\r\n  const [cancelLabel] = React.useState(UiCore.translate(\"dialog.cancel\"));\r\n  const recentToast = React.useRef<{close: () => void} | undefined>();\r\n  React.useEffect(() => {\r\n    toaster.setSettings(settings ?? {placement: \"top\"});\r\n  }, [settings]);\r\n\r\n  React.useEffect(() => {\r\n    if (activityMessageInfo?.restored) {\r\n      recentToast.current = toaster.informational(\r\n        <CustomActivityMessageContent initialActivityMessageInfo={activityMessageInfo} />,\r\n        { onRemove: dismissActivityMessage, type: \"persisting\", link: activityMessageInfo?.details?.supportsCancellation && cancelActivityMessage ? { title: cancelLabel, onClick: cancelActivityMessage } : undefined}\r\n      );\r\n    }\r\n    if (!activityMessageInfo) {\r\n      recentToast.current?.close();\r\n    }\r\n  }, [activityMessageInfo, cancelActivityMessage, cancelLabel, dismissActivityMessage]);\r\n}\r\n\r\n/**\r\n * Component wrapping the `useActivityMessage` hook to use in class components.\r\n * @internal\r\n */\r\nexport function CustomActivityMessageRenderer({activityMessageInfo, dismissActivityMessage, cancelActivityMessage, settings}: CustomActivityMessageProps) {\r\n  useActivityMessage({activityMessageInfo, cancelActivityMessage, dismissActivityMessage, settings});\r\n\r\n  return <></>;\r\n}\r\n\r\n/**\r\n * Component used to show and update activity message content.\r\n * @internal\r\n */\r\nexport function CustomActivityMessageContent({initialActivityMessageInfo}: {initialActivityMessageInfo: ActivityMessageEventArgs})  {\r\n  const [percentCompleteLabel] = React.useState(UiFramework.translate(\"activityCenter.percentComplete\"));\r\n  const [activityMessageInfo, setActivityMessageInfo] = React.useState(initialActivityMessageInfo);\r\n\r\n  React.useEffect(() => {\r\n    const handleActivityMessageUpdatedEvent = (args: ActivityMessageEventArgs) => {\r\n      setActivityMessageInfo(args);\r\n    };\r\n\r\n    return MessageManager.onActivityMessageUpdatedEvent.addListener(handleActivityMessageUpdatedEvent);\r\n  }, []);\r\n\r\n  return (\r\n    <>\r\n      {activityMessageInfo.message && <Text>{activityMessageInfo.message}</Text>}\r\n      {!!activityMessageInfo.details?.showPercentInMessage &&\r\n        <Small>{`${activityMessageInfo.percentage} ${percentCompleteLabel}`}</Small>\r\n      }\r\n      {activityMessageInfo.details?.showProgressBar && <ProgressLinear value={activityMessageInfo?.percentage} />}\r\n    </>\r\n  );\r\n}\r\n"]}

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

@@ -5,7 +5,7 @@
 import "./ActivityMessagePopup.scss";
 import { CommonProps } from "@itwin/core-react";
 /** Properties for [[ActivityMessagePopup]] component
- * @deprecated Props of a deprecated component.
+ * @deprecated in 3.5. Props of a deprecated component.
  * @public
  */
 export interface ActivityMessagePopupProps extends CommonProps {
@@ -13,7 +13,7 @@ export interface ActivityMessagePopupProps extends CommonProps {
     dismissActivityMessage?: () => void;
 }
 /** Activity Message Popup React component
- * @deprecated Activity messages are set-up automatically in a StatusBar.
+ * @deprecated in 3.5. Activity messages are set-up automatically in a StatusBar.
  * @public
  */
 export declare function ActivityMessagePopup(props: ActivityMessagePopupProps): JSX.Element;

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

@@ -13,7 +13,7 @@ const React = require("react");
 const MessageManager_1 = require("../messages/MessageManager");
 const ActivityMessage_1 = require("./ActivityMessage");
 /** Activity Message Popup React component
- * @deprecated Activity messages are set-up automatically in a StatusBar.
+ * @deprecated in 3.5. Activity messages are set-up automatically in a StatusBar.
  * @public
  */
 function ActivityMessagePopup(props) {