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

package/lib/cjs/appui-react/utils/InternalUiShowHideManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAyE;AACzE,2EAAuF;AACvF,gDAAmE;AAEnE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA+B5D,CAAC;IA7BQ,MAAM,CAAC,UAAU;QACtB,yBAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAwB;QAC/E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC1H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAwB;QAC7E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IACxH,CAAC;;AAnCH,gEAoCC;AAnCgB,6CAAkB,GAAG,eAAe,CAAC;AACrC,yCAAc,GAAG,YAAY,CAAC;AAC9B,kDAAuB,GAAG,qBAAqB,CAAC;AAChD,gDAAqB,GAAG,mBAAmB,CAAC;AAkC7D;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,MAAa,yBAAyB;IAUpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;IACnD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,yBAAyB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACjD,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,uBAAuB;QACvB,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC/H,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,2DAA2D;QAC3D,yBAAyB,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9C,yBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7C,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,+BAAuB,CAAC;QACpE,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;;AAlKH,8DAmKC;AAlKgB,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,+BAAuB,CAAC;AAElD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,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 Utilities\r\n */\r\n\r\nimport { UiStateStorage, UiStateStorageStatus } from \"@itwin/core-react\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n/** Class that maintain UiShowHide user settings between sessions\r\n * @internal\r\n */\r\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\r\n  private static _settingsNamespace = \"AppUiSettings\";\r\n  private static _autoHideUiKey = \"AutoHideUi\";\r\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\r\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\r\n  public readonly providerId = \"UiShowHideSettingsProvider\";\r\n\r\n  public static initialize() {\r\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\r\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\r\n  }\r\n\r\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\r\n  }\r\n\r\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\r\n  }\r\n\r\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);\r\n  }\r\n}\r\n\r\n/** The default inactivity time.\r\n * @internal\r\n */\r\nexport const INACTIVITY_TIME_DEFAULT = 3500;  /** Wait 3.5 seconds */\r\n\r\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\r\n * @internal\r\n */\r\nexport class InternalUiShowHideManager {\r\n  private static _isUiVisible: boolean = true;\r\n  private static _autoHideUi: boolean = true;\r\n  private static _showHidePanels: boolean = false;\r\n  private static _showHideFooter: boolean = false;\r\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\r\n  private static _timeout: NodeJS.Timeout;\r\n  private static _useProximityOpacity: boolean = false;\r\n  private static _snapWidgetOpacity: boolean = false;\r\n\r\n  /** Determines if the Ui is visible */\r\n  public static get isUiVisible() {\r\n    return InternalUiShowHideManager._isUiVisible;\r\n  }\r\n  public static set isUiVisible(visible: boolean) {\r\n    InternalUiShowHideManager._isUiVisible = visible;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setAutoHideUi(value: boolean) {\r\n    InternalUiShowHideManager._autoHideUi = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setUseProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setSnapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n  }\r\n\r\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n   * When true, the Ui automatically hides after a few seconds of inactivity.\r\n   */\r\n  public static get autoHideUi(): boolean {\r\n    return InternalUiShowHideManager._autoHideUi;\r\n  }\r\n\r\n  public static set autoHideUi(autoHide: boolean) {\r\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\r\n    InternalUiShowHideManager._autoHideUi = autoHide;\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n  }\r\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n  public static get showHidePanels(): boolean {\r\n    return InternalUiShowHideManager._showHidePanels;\r\n  }\r\n  public static set showHidePanels(showHide: boolean) {\r\n    InternalUiShowHideManager._showHidePanels = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n  public static get showHideFooter(): boolean {\r\n    return InternalUiShowHideManager._showHideFooter;\r\n  }\r\n  public static set showHideFooter(showHide: boolean) {\r\n    InternalUiShowHideManager._showHideFooter = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n  public static get inactivityTime(): number {\r\n    return InternalUiShowHideManager._inactivityTime;\r\n  }\r\n  public static set inactivityTime(time: number) {\r\n    InternalUiShowHideManager._inactivityTime = time;\r\n  }\r\n\r\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n  public static get useProximityOpacity(): boolean {\r\n    return InternalUiShowHideManager._useProximityOpacity;\r\n  }\r\n  public static set useProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n  public static get snapWidgetOpacity(): boolean {\r\n    return InternalUiShowHideManager._snapWidgetOpacity;\r\n  }\r\n  public static set snapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Handler for when a Frontstage is ready */\r\n  public static handleFrontstageReady() {\r\n    // istanbul ignore next\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse moves over the content area */\r\n  public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse enters a widget */\r\n  public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndCancelTimer();\r\n  }\r\n\r\n  /** Shows the Ui and resets the inactivity timer */\r\n  public static showUiAndResetTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.resetTimer();\r\n    });\r\n  }\r\n\r\n  /** Shows the Ui and cancels the inactivity timer */\r\n  public static showUiAndCancelTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.cancelTimer();\r\n    });\r\n  }\r\n\r\n  private static cancelTimer() {\r\n    clearTimeout(InternalUiShowHideManager._timeout);\r\n  }\r\n\r\n  private static resetTimer() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);\r\n  }\r\n\r\n  private static showUi() {\r\n    UiFramework.setIsUiVisible(true);\r\n  }\r\n\r\n  private static hideUi() {\r\n    UiFramework.setIsUiVisible(false);\r\n  }\r\n\r\n  /** @internal */\r\n  public static terminate() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    // Ensure that next use will have default values for tests.\r\n    InternalUiShowHideManager._isUiVisible = true;\r\n    InternalUiShowHideManager._autoHideUi = true;\r\n    InternalUiShowHideManager._showHidePanels = false;\r\n    InternalUiShowHideManager._showHideFooter = false;\r\n    InternalUiShowHideManager._inactivityTime = INACTIVITY_TIME_DEFAULT;\r\n    InternalUiShowHideManager._useProximityOpacity = false;\r\n    InternalUiShowHideManager._snapWidgetOpacity = false;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"InternalUiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/InternalUiShowHideManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,kDAAyE;AACzE,2EAAuF;AACvF,gDAAmE;AAEnE;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QAKkB,eAAU,GAAG,4BAA4B,CAAC;IA+B5D,CAAC;IA7BQ,MAAM,CAAC,UAAU;QACtB,yBAAW,CAAC,4BAA4B,CAAC,IAAI,0BAA0B,EAAE,CAAC,CAAC;IAC7E,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,OAAuB;QACnD,IAAI,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,cAAc,CAAC,CAAC;QAChI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAE1D,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;QACrI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,sBAAsB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnE,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,kBAAkB,EAAE,0BAA0B,CAAC,qBAAqB,CAAC,CAAC;QACnI,IAAI,MAAM,CAAC,MAAM,KAAK,iCAAoB,CAAC,OAAO;YAChD,yBAAyB,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAU,EAAE,OAAwB;QACtE,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;IACjH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAU,EAAE,OAAwB;QAC/E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IAC1H,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAU,EAAE,OAAwB;QAC7E,KAAK,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,yBAAW,CAAC,iBAAiB,EAAE,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,CAAC;IACxH,CAAC;;AAlCc,6CAAkB,GAAG,eAAe,AAAlB,CAAmB;AACrC,yCAAc,GAAG,YAAY,AAAf,CAAgB;AAC9B,kDAAuB,GAAG,qBAAqB,AAAxB,CAAyB;AAChD,gDAAqB,GAAG,mBAAmB,AAAtB,CAAuB;AAJhD,gEAA0B;AAsCvC;;GAEG;AACU,QAAA,uBAAuB,GAAG,IAAI,CAAC,CAAE,uBAAuB;AAErE;;GAEG;AACH,MAAa,yBAAyB;IAUpC,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,yBAAyB,CAAC,YAAY,CAAC;IAChD,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,yBAAyB,CAAC,YAAY,GAAG,OAAO,CAAC;IACnD,CAAC;IAED,cAAc;IACP,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,yBAAyB,CAAC,WAAW,GAAG,KAAK,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;IACzD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,yBAAyB,CAAC,WAAW,CAAC;IAC/C,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,KAAK,0BAA0B,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;QAC1D,yBAAyB,CAAC,WAAW,GAAG,QAAQ,CAAC;QACjD,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;IACjG,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,yBAAyB,CAAC,eAAe,GAAG,QAAQ,CAAC;QACrD,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,yBAAyB,CAAC,eAAe,CAAC;IACnD,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,yBAAyB,CAAC,eAAe,GAAG,IAAI,CAAC;IACnD,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,yBAAyB,CAAC,oBAAoB,CAAC;IACxD,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,KAAK,0BAA0B,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAChE,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,yBAAyB,CAAC,kBAAkB,CAAC;IACtD,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;QACrD,KAAK,0BAA0B,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;QAC9D,6CAAqB,CAAC,4BAA4B,CAAC,qCAAa,CAAC,4BAA4B,CAAC,CAAC;QAC/F,yBAAW,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,yBAAW,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,uBAAuB;QACvB,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;IAClD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,IAAI,CAAC,yBAAyB,CAAC,WAAW;YACxC,OAAO;QAET,yBAAyB,CAAC,oBAAoB,EAAE,CAAC;IACnD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,UAAU,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,yBAAyB,CAAC,MAAM,EAAE,CAAC;YACnC,yBAAyB,CAAC,WAAW,EAAE,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,WAAW;QACxB,YAAY,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAEO,MAAM,CAAC,UAAU;QACvB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,yBAAyB,CAAC,QAAQ,GAAG,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,yBAAyB,CAAC,eAAe,CAAC,CAAC;IAC/H,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,MAAM;QACnB,yBAAW,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,yBAAyB,CAAC,WAAW,EAAE,CAAC;QACxC,2DAA2D;QAC3D,yBAAyB,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9C,yBAAyB,CAAC,WAAW,GAAG,IAAI,CAAC;QAC7C,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,KAAK,CAAC;QAClD,yBAAyB,CAAC,eAAe,GAAG,+BAAuB,CAAC;QACpE,yBAAyB,CAAC,oBAAoB,GAAG,KAAK,CAAC;QACvD,yBAAyB,CAAC,kBAAkB,GAAG,KAAK,CAAC;IACvD,CAAC;;AAjKc,sCAAY,GAAY,IAAI,CAAC;AAC7B,qCAAW,GAAY,IAAI,CAAC;AAC5B,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAY,KAAK,CAAC;AACjC,yCAAe,GAAW,+BAAuB,CAAC;AAElD,8CAAoB,GAAY,KAAK,CAAC;AACtC,4CAAkB,GAAY,KAAK,CAAC;AARxC,8DAAyB","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 Utilities\r\n */\r\n\r\nimport { UiStateStorage, UiStateStorageStatus } from \"@itwin/core-react\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework, UserSettingsProvider } from \"../UiFramework\";\r\n\r\n/** Class that maintain UiShowHide user settings between sessions\r\n * @internal\r\n */\r\nexport class UiShowHideSettingsProvider implements UserSettingsProvider {\r\n  private static _settingsNamespace = \"AppUiSettings\";\r\n  private static _autoHideUiKey = \"AutoHideUi\";\r\n  private static _useProximityOpacityKey = \"UseProximityOpacity\";\r\n  private static _snapWidgetOpacityKey = \"SnapWidgetOpacity\";\r\n  public readonly providerId = \"UiShowHideSettingsProvider\";\r\n\r\n  public static initialize() {\r\n    UiFramework.registerUserSettingsProvider(new UiShowHideSettingsProvider());\r\n  }\r\n\r\n  public async loadUserSettings(storage: UiStateStorage): Promise<void> {\r\n    let result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._autoHideUiKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setAutoHideUi(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._useProximityOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setUseProximityOpacity(result.setting);\r\n\r\n    result = await storage.getSetting(UiShowHideSettingsProvider._settingsNamespace, UiShowHideSettingsProvider._snapWidgetOpacityKey);\r\n    if (result.status === UiStateStorageStatus.Success)\r\n      InternalUiShowHideManager.setSnapWidgetOpacity(result.setting);\r\n  }\r\n\r\n  public static async storeAutoHideUi(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._autoHideUiKey, v);\r\n  }\r\n\r\n  public static async storeUseProximityOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._useProximityOpacityKey, v);\r\n  }\r\n\r\n  public static async storeSnapWidgetOpacity(v: boolean, storage?: UiStateStorage) {\r\n    void (storage ?? UiFramework.getUiStateStorage()).saveSetting(this._settingsNamespace, this._snapWidgetOpacityKey, v);\r\n  }\r\n}\r\n\r\n/** The default inactivity time.\r\n * @internal\r\n */\r\nexport const INACTIVITY_TIME_DEFAULT = 3500;  /** Wait 3.5 seconds */\r\n\r\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\r\n * @internal\r\n */\r\nexport class InternalUiShowHideManager {\r\n  private static _isUiVisible: boolean = true;\r\n  private static _autoHideUi: boolean = true;\r\n  private static _showHidePanels: boolean = false;\r\n  private static _showHideFooter: boolean = false;\r\n  private static _inactivityTime: number = INACTIVITY_TIME_DEFAULT;\r\n  private static _timeout: NodeJS.Timeout;\r\n  private static _useProximityOpacity: boolean = false;\r\n  private static _snapWidgetOpacity: boolean = false;\r\n\r\n  /** Determines if the Ui is visible */\r\n  public static get isUiVisible() {\r\n    return InternalUiShowHideManager._isUiVisible;\r\n  }\r\n  public static set isUiVisible(visible: boolean) {\r\n    InternalUiShowHideManager._isUiVisible = visible;\r\n  }\r\n\r\n  /** @public */\r\n  public static setAutoHideUi(value: boolean) {\r\n    InternalUiShowHideManager._autoHideUi = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setUseProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n  }\r\n\r\n  /** @internal */\r\n  public static setSnapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n  }\r\n\r\n  /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n   * When true, the Ui automatically hides after a few seconds of inactivity.\r\n   */\r\n  public static get autoHideUi(): boolean {\r\n    return InternalUiShowHideManager._autoHideUi;\r\n  }\r\n\r\n  public static set autoHideUi(autoHide: boolean) {\r\n    void UiShowHideSettingsProvider.storeAutoHideUi(autoHide);\r\n    InternalUiShowHideManager._autoHideUi = autoHide;\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n  }\r\n  /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n  public static get showHidePanels(): boolean {\r\n    return InternalUiShowHideManager._showHidePanels;\r\n  }\r\n  public static set showHidePanels(showHide: boolean) {\r\n    InternalUiShowHideManager._showHidePanels = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n  public static get showHideFooter(): boolean {\r\n    return InternalUiShowHideManager._showHideFooter;\r\n  }\r\n  public static set showHideFooter(showHide: boolean) {\r\n    InternalUiShowHideManager._showHideFooter = showHide;\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n  public static get inactivityTime(): number {\r\n    return InternalUiShowHideManager._inactivityTime;\r\n  }\r\n  public static set inactivityTime(time: number) {\r\n    InternalUiShowHideManager._inactivityTime = time;\r\n  }\r\n\r\n  /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n  public static get useProximityOpacity(): boolean {\r\n    return InternalUiShowHideManager._useProximityOpacity;\r\n  }\r\n  public static set useProximityOpacity(value: boolean) {\r\n    InternalUiShowHideManager._useProximityOpacity = value;\r\n    void UiShowHideSettingsProvider.storeUseProximityOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n  public static get snapWidgetOpacity(): boolean {\r\n    return InternalUiShowHideManager._snapWidgetOpacity;\r\n  }\r\n  public static set snapWidgetOpacity(value: boolean) {\r\n    InternalUiShowHideManager._snapWidgetOpacity = value;\r\n    void UiShowHideSettingsProvider.storeSnapWidgetOpacity(value);\r\n    SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.ShowHideManagerSettingChange);\r\n    UiFramework.onUiVisibilityChanged.emit({ visible: UiFramework.getIsUiVisible() });\r\n  }\r\n\r\n  /** Handler for when a Frontstage is ready */\r\n  public static handleFrontstageReady() {\r\n    // istanbul ignore next\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse moves over the content area */\r\n  public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndResetTimer();\r\n  }\r\n\r\n  /** Handler for when the mouse enters a widget */\r\n  public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n    if (!InternalUiShowHideManager._autoHideUi)\r\n      return;\r\n\r\n    InternalUiShowHideManager.showUiAndCancelTimer();\r\n  }\r\n\r\n  /** Shows the Ui and resets the inactivity timer */\r\n  public static showUiAndResetTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.resetTimer();\r\n    });\r\n  }\r\n\r\n  /** Shows the Ui and cancels the inactivity timer */\r\n  public static showUiAndCancelTimer() {\r\n    setTimeout(() => {\r\n      InternalUiShowHideManager.showUi();\r\n      InternalUiShowHideManager.cancelTimer();\r\n    });\r\n  }\r\n\r\n  private static cancelTimer() {\r\n    clearTimeout(InternalUiShowHideManager._timeout);\r\n  }\r\n\r\n  private static resetTimer() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    InternalUiShowHideManager._timeout = setTimeout(InternalUiShowHideManager.hideUi, InternalUiShowHideManager._inactivityTime);\r\n  }\r\n\r\n  private static showUi() {\r\n    UiFramework.setIsUiVisible(true);\r\n  }\r\n\r\n  private static hideUi() {\r\n    UiFramework.setIsUiVisible(false);\r\n  }\r\n\r\n  /** @internal */\r\n  public static terminate() {\r\n    InternalUiShowHideManager.cancelTimer();\r\n    // Ensure that next use will have default values for tests.\r\n    InternalUiShowHideManager._isUiVisible = true;\r\n    InternalUiShowHideManager._autoHideUi = true;\r\n    InternalUiShowHideManager._showHidePanels = false;\r\n    InternalUiShowHideManager._showHideFooter = false;\r\n    InternalUiShowHideManager._inactivityTime = INACTIVITY_TIME_DEFAULT;\r\n    InternalUiShowHideManager._useProximityOpacity = false;\r\n    InternalUiShowHideManager._snapWidgetOpacity = false;\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/utils/PropsHelper.d.ts

@@ -1,21 +1,22 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import * as React from "react";
-import { AbstractWidgetProps, BackstageItem, ConditionalStringValue, StringGetter } from "@itwin/appui-abstract";
-import { IconSpec } from "@itwin/core-react";
-/** A set of helper methods for various props
- * @public
- */
-export declare class PropsHelper {
-    /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
-    static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue;
-    /** Get the display string. */
-    static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string;
-    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
-    static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined;
-    /** returns true if the two objects are the same using a shallow compare of each property */
-    static isShallowEqual(newObj: any, prevObj: any): boolean;
-    static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<AbstractWidgetProps> | Partial<BackstageItem>;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+import * as React from "react";
+import { IconSpec } from "@itwin/core-react";
+import { ConditionalStringValue, StringGetter, AbstractWidgetProps as UIA_AbstractWidgetProps, CommonBackstageItem as UIA_CommonBackstageItem } from "@itwin/appui-abstract";
+/** A set of helper methods for various props
+ * @public
+ */
+export declare class PropsHelper {
+    /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
+    static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue;
+    /** Get the display string. */
+    static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string;
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined;
+    /** returns true if the two objects are the same using a shallow compare of each property */
+    static isShallowEqual(newObj: any, prevObj: any): boolean;
+    /** @deprecated in 4.0 These abstract props types are obsolete. */
+    static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem>;
+}
 //# sourceMappingURL=PropsHelper.d.ts.map

package/lib/cjs/appui-react/utils/PropsHelper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACjH,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAG/D;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;WAMxC,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,mBAAmB,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;CAavJ"}
+{"version":3,"file":"PropsHelper.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAoB,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE/D,OAAO,EAAE,sBAAsB,EAAE,YAAY,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAE7K;;GAEG;AACH,qBAAa,WAAW;IACtB,sHAAsH;WACxG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,SAAS,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,sBAAsB;IAW1K,8BAA8B;WAChB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,sBAAsB,GAAG,MAAM;IAW7F,+JAA+J;WAEjJ,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,sBAAsB,GAAG,KAAK,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,GAAG,SAAS;IAO3G,4FAA4F;WAC9E,cAAc,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG;IAOtD,kEAAkE;WACpD,4BAA4B,CAAC,QAAQ,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAarK"}

package/lib/cjs/appui-react/utils/PropsHelper.js

@@ -1,67 +1,68 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropsHelper = void 0;
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const core_react_1 = require("@itwin/core-react");
-const UiFramework_1 = require("../UiFramework");
-/** A set of helper methods for various props
- * @public
- */
-class PropsHelper {
-    /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
-    static getStringSpec(explicitValue, stringKey) {
-        if (explicitValue) {
-            return explicitValue;
-        }
-        let outValue = "";
-        if (stringKey)
-            outValue = UiFramework_1.UiFramework.localization.getLocalizedString(stringKey);
-        return outValue;
-    }
-    /** Get the display string. */
-    static getStringFromSpec(spec) {
-        let label = "";
-        if (typeof spec === "string")
-            label = spec;
-        else if (spec instanceof appui_abstract_1.ConditionalStringValue)
-            label = spec.value;
-        else
-            label = spec();
-        return label;
-    }
-    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    static getIcon(iconSpec) {
-        if (iconSpec instanceof appui_abstract_1.ConditionalStringValue)
-            return React.createElement(core_react_1.Icon, { iconSpec: iconSpec.value });
-        return (iconSpec) ? React.createElement(core_react_1.Icon, { iconSpec: iconSpec }) : undefined;
-    }
-    /** returns true if the two objects are the same using a shallow compare of each property */
-    static isShallowEqual(newObj, prevObj) {
-        for (const key in newObj) {
-            if (newObj[key] !== prevObj[key])
-                return false;
-        }
-        return true;
-    }
-    static getAbstractPropsForReactIcon(iconSpec, internalData) {
-        // istanbul ignore else
-        if (!iconSpec || !React.isValidElement(iconSpec))
-            return {};
-        // istanbul ignore else
-        if (!internalData)
-            internalData = new Map();
-        const icon = core_react_1.IconHelper.getIconData(iconSpec, internalData);
-        return (icon === "" ? { icon } : { icon, internalData });
-    }
-}
-exports.PropsHelper = PropsHelper;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropsHelper = void 0;
+const React = require("react");
+const core_react_1 = require("@itwin/core-react");
+const UiFramework_1 = require("../UiFramework");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** A set of helper methods for various props
+ * @public
+ */
+class PropsHelper {
+    /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */
+    static getStringSpec(explicitValue, stringKey) {
+        if (explicitValue) {
+            return explicitValue;
+        }
+        let outValue = "";
+        if (stringKey)
+            outValue = UiFramework_1.UiFramework.localization.getLocalizedString(stringKey);
+        return outValue;
+    }
+    /** Get the display string. */
+    static getStringFromSpec(spec) {
+        let label = "";
+        if (typeof spec === "string")
+            label = spec;
+        else if (spec instanceof appui_abstract_1.ConditionalStringValue)
+            label = spec.value;
+        else
+            label = spec();
+        return label;
+    }
+    /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    static getIcon(iconSpec) {
+        if (iconSpec instanceof appui_abstract_1.ConditionalStringValue)
+            return React.createElement(core_react_1.Icon, { iconSpec: iconSpec.value });
+        return (iconSpec) ? React.createElement(core_react_1.Icon, { iconSpec: iconSpec }) : undefined;
+    }
+    /** returns true if the two objects are the same using a shallow compare of each property */
+    static isShallowEqual(newObj, prevObj) {
+        for (const key in newObj) {
+            if (newObj[key] !== prevObj[key])
+                return false;
+        }
+        return true;
+    }
+    /** @deprecated in 4.0 These abstract props types are obsolete. */
+    static getAbstractPropsForReactIcon(iconSpec, internalData) {
+        // istanbul ignore else
+        if (!iconSpec || !React.isValidElement(iconSpec))
+            return {};
+        // istanbul ignore else
+        if (!internalData)
+            internalData = new Map();
+        const icon = core_react_1.IconHelper.getIconData(iconSpec, internalData);
+        return (icon === "" ? { icon } : { icon, internalData });
+    }
+}
+exports.PropsHelper = PropsHelper;
 //# sourceMappingURL=PropsHelper.js.map

package/lib/cjs/appui-react/utils/PropsHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,0DAAiH;AACjH,kDAA+D;AAC/D,gDAA6C;AAE7C;;GAEG;AACH,MAAa,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,uCAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,uCAAsB;YAC5C,OAAO,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAc,CAAC;QAEvC,MAAM,IAAI,GAAG,uBAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,EAAC,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IACxD,CAAC;CACF;AAtDD,kCAsDC","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 Utilities\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { AbstractWidgetProps, BackstageItem, ConditionalStringValue, StringGetter } from \"@itwin/appui-abstract\";\r\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** A set of helper methods for various props\r\n * @public\r\n */\r\nexport class PropsHelper {\r\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\r\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\r\n    if (explicitValue) {\r\n      return explicitValue;\r\n    }\r\n\r\n    let outValue = \"\";\r\n    if (stringKey)\r\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\r\n    return outValue;\r\n  }\r\n\r\n  /** Get the display string. */\r\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\r\n    let label = \"\";\r\n    if (typeof spec === \"string\")\r\n      label = spec;\r\n    else if (spec instanceof ConditionalStringValue)\r\n      label = spec.value;\r\n    else\r\n      label = spec();\r\n    return label;\r\n  }\r\n\r\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\r\n    if (iconSpec instanceof ConditionalStringValue)\r\n      return <Icon iconSpec={iconSpec.value} />;\r\n\r\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\r\n  }\r\n\r\n  /** returns true if the two objects are the same using a shallow compare of each property */\r\n  public static isShallowEqual(newObj: any, prevObj: any) {\r\n    for (const key in newObj) {\r\n      if (newObj[key] !== prevObj[key]) return false;\r\n    }\r\n    return true;\r\n  }\r\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<AbstractWidgetProps> | Partial<BackstageItem> { // eslint-disable-line deprecation/deprecation\r\n    // istanbul ignore else\r\n    if (!iconSpec || !React.isValidElement(iconSpec))\r\n      return {};\r\n\r\n    // istanbul ignore else\r\n    if (!internalData)\r\n      internalData = new Map<string,any>();\r\n\r\n    const icon = IconHelper.getIconData(iconSpec, internalData);\r\n\r\n    return (icon === \"\" ? {icon} : {icon, internalData });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"PropsHelper.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/PropsHelper.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,kDAA+D;AAC/D,gDAA6C;AAC7C,0DAA6K;AAE7K;;GAEG;AACH,MAAa,WAAW;IACtB,sHAAsH;IAC/G,MAAM,CAAC,aAAa,CAAC,aAAyE,EAAE,SAAkB;QACvH,IAAI,aAAa,EAAE;YACjB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS;YACX,QAAQ,GAAG,yBAAW,CAAC,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,iBAAiB,CAAC,IAAoD;QAClF,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,KAAK,GAAG,IAAI,CAAC;aACV,IAAI,IAAI,YAAY,uCAAsB;YAC7C,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;;YAEnB,KAAK,GAAG,IAAI,EAAE,CAAC;QACjB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+JAA+J;IAC/J,gEAAgE;IACzD,MAAM,CAAC,OAAO,CAAC,QAA2D;QAC/E,IAAI,QAAQ,YAAY,uCAAsB;YAC5C,OAAO,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,GAAI,CAAC;QAE5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED,4FAA4F;IACrF,MAAM,CAAC,cAAc,CAAC,MAAW,EAAE,OAAY;QACpD,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;SAChD;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kEAAkE;IAC3D,MAAM,CAAC,4BAA4B,CAAC,QAAkB,EAAE,YAA+B;QAC5F,uBAAuB;QACvB,IAAI,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;YAC9C,OAAO,EAAE,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,YAAY;YACf,YAAY,GAAG,IAAI,GAAG,EAAe,CAAC;QAExC,MAAM,IAAI,GAAG,uBAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAE5D,OAAO,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;CACF;AAxDD,kCAwDC","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 Utilities\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Icon, IconHelper, IconSpec } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ConditionalStringValue, StringGetter, AbstractWidgetProps as UIA_AbstractWidgetProps, CommonBackstageItem as UIA_CommonBackstageItem } from \"@itwin/appui-abstract\";\r\n\r\n/** A set of helper methods for various props\r\n * @public\r\n */\r\nexport class PropsHelper {\r\n  /** Get spec for returning a string. Could be a simple string of a 'StringGetter' method used to return the string. */\r\n  public static getStringSpec(explicitValue: string | StringGetter | ConditionalStringValue | undefined, stringKey?: string): string | StringGetter | ConditionalStringValue {\r\n    if (explicitValue) {\r\n      return explicitValue;\r\n    }\r\n\r\n    let outValue = \"\";\r\n    if (stringKey)\r\n      outValue = UiFramework.localization.getLocalizedString(stringKey);\r\n    return outValue;\r\n  }\r\n\r\n  /** Get the display string. */\r\n  public static getStringFromSpec(spec: string | StringGetter | ConditionalStringValue): string {\r\n    let label = \"\";\r\n    if (typeof spec === \"string\")\r\n      label = spec;\r\n    else if (spec instanceof ConditionalStringValue)\r\n      label = spec.value;\r\n    else\r\n      label = spec();\r\n    return label;\r\n  }\r\n\r\n  /** Get JSX element that defines an icon. If iconSpec is a string, then a web-font icon class is used otherwise a ReactNode holding an SVG icon is assumed.  */\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  public static getIcon(iconSpec: string | ConditionalStringValue | React.ReactNode): JSX.Element | undefined {\r\n    if (iconSpec instanceof ConditionalStringValue)\r\n      return <Icon iconSpec={iconSpec.value} />;\r\n\r\n    return (iconSpec) ? <Icon iconSpec={iconSpec} /> : undefined;\r\n  }\r\n\r\n  /** returns true if the two objects are the same using a shallow compare of each property */\r\n  public static isShallowEqual(newObj: any, prevObj: any) {\r\n    for (const key in newObj) {\r\n      if (newObj[key] !== prevObj[key]) return false;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** @deprecated in 4.0 These abstract props types are obsolete. */\r\n  public static getAbstractPropsForReactIcon(iconSpec: IconSpec, internalData?: Map<string, any>): Partial<UIA_AbstractWidgetProps> | Partial<UIA_CommonBackstageItem> { // eslint-disable-line deprecation/deprecation\r\n    // istanbul ignore else\r\n    if (!iconSpec || !React.isValidElement(iconSpec))\r\n      return {};\r\n\r\n    // istanbul ignore else\r\n    if (!internalData)\r\n      internalData = new Map<string, any>();\r\n\r\n    const icon = IconHelper.getIconData(iconSpec, internalData);\r\n\r\n    return (icon === \"\" ? { icon } : { icon, internalData });\r\n  }\r\n}\r\n"]}

package/lib/cjs/appui-react/utils/ToolbarButtonHelper.d.ts

@@ -1,18 +1,18 @@
-/** @packageDocumentation
- * @module Utilities
- */
-/** A set of Dom helper methods
- * @public
- */
-export declare class ToolbarButtonHelper {
-    static searchToolbarsByTitle(title: string, horizontal: boolean): HTMLButtonElement | null;
-    /** Search Horizontal Toolbars for button by title. */
-    static searchHorizontalToolbarsByTitle(title: string): HTMLButtonElement | null;
-    /** Search Vertical Toolbars by Title for button by title. */
-    static searchVerticalToolbarsByTitle(title: string): HTMLButtonElement | null;
-    /** Get toolbar button by title. */
-    static getToolbarButtonByTitle(title: string): HTMLButtonElement | null;
-    /** Get App button. */
-    static getAppButton(): HTMLButtonElement | null;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+/** A set of Dom helper methods
+ * @public
+ */
+export declare class ToolbarButtonHelper {
+    static searchToolbarsByTitle(title: string, horizontal: boolean): HTMLButtonElement | null;
+    /** Search Horizontal Toolbars for button by title. */
+    static searchHorizontalToolbarsByTitle(title: string): HTMLButtonElement | null;
+    /** Search Vertical Toolbars by Title for button by title. */
+    static searchVerticalToolbarsByTitle(title: string): HTMLButtonElement | null;
+    /** Get toolbar button by title. */
+    static getToolbarButtonByTitle(title: string): HTMLButtonElement | null;
+    /** Get App button. */
+    static getAppButton(): HTMLButtonElement | null;
+}
 //# sourceMappingURL=ToolbarButtonHelper.d.ts.map

package/lib/cjs/appui-react/utils/ToolbarButtonHelper.js

@@ -1,61 +1,61 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ToolbarButtonHelper = void 0;
-/** A set of Dom helper methods
- * @public
- */
-class ToolbarButtonHelper {
-    static searchToolbarsByTitle(title, horizontal) {
-        // first look for simple tool buttons
-        const nodeList = document.documentElement.querySelectorAll(`div.nz-toolbar-items.nz-${horizontal ? "horizontal" : "vertical"}.nz-items .nz-toolbar-item-item`);
-        // istanbul ignore else
-        if (nodeList && nodeList.length > 0) {
-            for (const node of nodeList) {
-                const button = node;
-                if (button.title === title) {
-                    return button;
-                }
-            }
-        }
-        return null;
-    }
-    /** Search Horizontal Toolbars for button by title. */
-    static searchHorizontalToolbarsByTitle(title) {
-        return ToolbarButtonHelper.searchToolbarsByTitle(title, true);
-    }
-    /** Search Vertical Toolbars by Title for button by title. */
-    static searchVerticalToolbarsByTitle(title) {
-        return ToolbarButtonHelper.searchToolbarsByTitle(title, false);
-    }
-    /** Get toolbar button by title. */
-    static getToolbarButtonByTitle(title) {
-        let button = ToolbarButtonHelper.searchHorizontalToolbarsByTitle(title);
-        // istanbul ignore if
-        if (button)
-            return button;
-        button = ToolbarButtonHelper.searchVerticalToolbarsByTitle(title);
-        // istanbul ignore else
-        if (button)
-            return button;
-        // istanbul ignore next
-        return null;
-    }
-    /** Get App button. */
-    static getAppButton() {
-        const node = document.documentElement.querySelector("div.nz-app-button > button");
-        // istanbul ignore else
-        if (node)
-            return node;
-        // istanbul ignore next
-        return null;
-    }
-}
-exports.ToolbarButtonHelper = ToolbarButtonHelper;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToolbarButtonHelper = void 0;
+/** A set of Dom helper methods
+ * @public
+ */
+class ToolbarButtonHelper {
+    static searchToolbarsByTitle(title, horizontal) {
+        // first look for simple tool buttons
+        const nodeList = document.documentElement.querySelectorAll(`div.nz-toolbar-items.nz-${horizontal ? "horizontal" : "vertical"}.nz-items .nz-toolbar-item-item`);
+        // istanbul ignore else
+        if (nodeList && nodeList.length > 0) {
+            for (const node of nodeList) {
+                const button = node;
+                if (button.title === title) {
+                    return button;
+                }
+            }
+        }
+        return null;
+    }
+    /** Search Horizontal Toolbars for button by title. */
+    static searchHorizontalToolbarsByTitle(title) {
+        return ToolbarButtonHelper.searchToolbarsByTitle(title, true);
+    }
+    /** Search Vertical Toolbars by Title for button by title. */
+    static searchVerticalToolbarsByTitle(title) {
+        return ToolbarButtonHelper.searchToolbarsByTitle(title, false);
+    }
+    /** Get toolbar button by title. */
+    static getToolbarButtonByTitle(title) {
+        let button = ToolbarButtonHelper.searchHorizontalToolbarsByTitle(title);
+        // istanbul ignore if
+        if (button)
+            return button;
+        button = ToolbarButtonHelper.searchVerticalToolbarsByTitle(title);
+        // istanbul ignore else
+        if (button)
+            return button;
+        // istanbul ignore next
+        return null;
+    }
+    /** Get App button. */
+    static getAppButton() {
+        const node = document.documentElement.querySelector("div.nz-app-button > button");
+        // istanbul ignore else
+        if (node)
+            return node;
+        // istanbul ignore next
+        return null;
+    }
+}
+exports.ToolbarButtonHelper = ToolbarButtonHelper;
 //# sourceMappingURL=ToolbarButtonHelper.js.map

package/lib/cjs/appui-react/utils/ViewUtilities.d.ts

@@ -1,67 +1,67 @@
-/** @packageDocumentation
- * @module Utilities
- */
-import { ScreenViewport } from "@itwin/core-frontend";
-/**
- * Various View utility methods
- * @public
- */
-export declare class ViewUtilities {
-    /**
-     * Extracts the BisBaseClass from a full class name.
-     * @param classFullName full class name
-     * @returns BisBaseClass name
-     */
-    static getBisBaseClass(classFullName: string): string;
-    /**
-     * Determines if given class is a spatial view.
-     * @param classname Name of class to check
-     */
-    static isSpatial(classname: string): boolean;
-    /**
-     * Determines if given class is a spatial view.
-     * @param classname Name of class to check
-     */
-    static isOrthographic(classname: string): boolean;
-    /**
-     * Determines if given class is a drawing view.
-     * @param classname Name of class to check
-     */
-    static isDrawing(classname: string): boolean;
-    /**
-     * Determines if given class is a sheet view.
-     * @param classname Name of class to check
-     */
-    static isSheet(classname: string): boolean;
-    /**
-     * Determines if viewport displays a Sheet view.
-     * @param viewport ScreenViewport to check
-     */
-    static isSheetView(viewport: ScreenViewport): boolean;
-    /**
-     * Determines if viewport displays a Drawing view.
-     * @param viewport ScreenViewport to check
-     */
-    static isDrawingView(viewport: ScreenViewport): boolean;
-    /**
-     * Determines if viewport displays a Orthographic view.
-     * @param viewport ScreenViewport to check
-     */
-    static isOrthographicView(viewport: ScreenViewport): boolean;
-    /**
-     * Determines if viewport displays a Spatial view.
-     * @param viewport ScreenViewport to check
-     */
-    static isSpatialView(viewport: ScreenViewport): boolean;
-    /**
-     * Determines if viewport displays a 3d view.
-     * @param viewport ScreenViewport to check
-     */
-    static is3dView(viewport: ScreenViewport): boolean;
-    /**
-     * Determines if viewport supports use of a camera.
-     * @param viewport ScreenViewport to check
-     */
-    static viewSupportsCamera(viewport: ScreenViewport): boolean;
-}
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { ScreenViewport } from "@itwin/core-frontend";
+/**
+ * Various View utility methods
+ * @public
+ */
+export declare class ViewUtilities {
+    /**
+     * Extracts the BisBaseClass from a full class name.
+     * @param classFullName full class name
+     * @returns BisBaseClass name
+     */
+    static getBisBaseClass(classFullName: string): string;
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isSpatial(classname: string): boolean;
+    /**
+     * Determines if given class is a spatial view.
+     * @param classname Name of class to check
+     */
+    static isOrthographic(classname: string): boolean;
+    /**
+     * Determines if given class is a drawing view.
+     * @param classname Name of class to check
+     */
+    static isDrawing(classname: string): boolean;
+    /**
+     * Determines if given class is a sheet view.
+     * @param classname Name of class to check
+     */
+    static isSheet(classname: string): boolean;
+    /**
+     * Determines if viewport displays a Sheet view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSheetView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Drawing view.
+     * @param viewport ScreenViewport to check
+     */
+    static isDrawingView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Orthographic view.
+     * @param viewport ScreenViewport to check
+     */
+    static isOrthographicView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a Spatial view.
+     * @param viewport ScreenViewport to check
+     */
+    static isSpatialView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport displays a 3d view.
+     * @param viewport ScreenViewport to check
+     */
+    static is3dView(viewport: ScreenViewport): boolean;
+    /**
+     * Determines if viewport supports use of a camera.
+     * @param viewport ScreenViewport to check
+     */
+    static viewSupportsCamera(viewport: ScreenViewport): boolean;
+}
 //# sourceMappingURL=ViewUtilities.d.ts.map