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

package/CHANGELOG.md

@@ -1,6 +1,50 @@
 # Change Log - @itwin/appui-react
 
-This log was last generated on Wed, 07 Dec 2022 19:12:36 GMT and should not be manually modified.
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:39 GMT
+
+### Updates
+
+- Expose AppUI specific types previously defined in @itwin/appui-abstract.
+- Deprecated tree components that were movet to '@itwin/tree-widget-react' package
+- Use EmptyLocalization for localization in tests to increase test performance
+- Deprecate UI1.0 related properties.
+- React to RPC deprecations.
+- Add viewportRef as a props for the FloatingWidgetComponent. Caller might be needing to grab a reference to the viewport. Also, change the initialViewState to allow passing a function that returns a ViewState
+- Use React.ForwardedRef rather than just a callback.
+- Issue #4879: Make sure floating viewports properly set their content as active and display the active view highlight bar.
+- Fix floating widget offset issue.
+
+## 3.5.5
+Thu, 26 Jan 2023 22:53:27 GMT
+
+_Version update only_
+
+## 3.5.4
+Wed, 18 Jan 2023 15:27:15 GMT
+
+### Updates
+
+- Issue #4879: Make sure floating viewports properly set their content as active and display the active view highlight bar.
+
+## 3.5.3
+Fri, 13 Jan 2023 17:23:07 GMT
+
+_Version update only_
+
+## 3.5.2
+Wed, 11 Jan 2023 16:46:30 GMT
+
+### Updates
+
+- Fix detailed output message on a new line in toasts.
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:28 GMT
+
+_Version update only_
 
 ## 3.5.0
 Wed, 07 Dec 2022 19:12:36 GMT

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2023 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/cjs/appui-react/UiFramework.d.ts

@@ -13,8 +13,17 @@ import { FrameworkState } from "./redux/FrameworkState";
 import { CursorMenuData, PresentationSelectionScope } from "./redux/SessionState";
 import { HideIsolateEmphasizeActionHandler } from "./selection/HideIsolateEmphasizeManager";
 import { WidgetManager } from "./widgets/WidgetManager";
+import { FrameworkBackstage } from "./framework/FrameworkBackstage";
+import { FrameworkChildWindows } from "./framework/FrameworkChildWindows";
+import { FrameworkControls } from "./framework/FrameworkControls";
+import { FrameworkFrontstages } from "./framework/FrameworkFrontstages";
+import { FrameworkToolSettings } from "./framework/FrameworkToolSettings";
+import { FrameworkContent } from "./framework/FrameworkContent";
+import { FrameworkDialogs } from "./framework/FrameworkDialogs";
+import { FrameworkKeyboardShortcuts } from "./framework/FrameworkKeyboardShortcuts";
+import { FrameworkVisibility } from "./framework/FrameworkVisibility";
 /** Defined that available UI Versions. It is recommended to always use the latest version available.
- * @deprecated Used to toggle between UI1.0 and UI2.0.
+ * @deprecated in 3.5. Used to toggle between UI1.0 and UI2.0.
  * @public
  */
 export declare type FrameworkVersionId = "1" | "2";
@@ -62,6 +71,51 @@ export interface TrackingTime {
  * @public
  */
 export declare class UiFramework {
+    /**
+     * Operation on the backstage component.
+     * @beta
+     */
+    static get backstage(): FrameworkBackstage;
+    /**
+     * Manage access to the child windows.
+     * @beta
+     */
+    static get childWindows(): FrameworkChildWindows;
+    /**
+     * Manage registered controls
+     * @beta
+     */
+    static get controls(): FrameworkControls;
+    /**
+     * Manage access to frontstages and related helper methods.
+     * @beta
+     */
+    static get frontstages(): FrameworkFrontstages;
+    /**
+     * Manage access and behavior of the tool settings.
+     * @beta
+     */
+    static get toolSettings(): FrameworkToolSettings;
+    /**
+     * Manage content presented by the frontstages.
+     * @beta
+     */
+    static get content(): FrameworkContent;
+    /**
+     * Manage displayed dialogs.
+     * @beta
+     */
+    static get dialogs(): FrameworkDialogs;
+    /**
+     * Manages global keyboard shortcuts
+     * @beta
+     */
+    static get keyboardShortcuts(): FrameworkKeyboardShortcuts;
+    /**
+     * Manages UI visibility (Show/Hide)
+     * @beta
+     */
+    static get visibility(): FrameworkVisibility;
     private static _initialized;
     private static _store?;
     private static _complaint;
@@ -74,9 +128,11 @@ export declare class UiFramework {
     private static _uiStateStorage;
     private static _settingsManager?;
     private static _uiSettingsProviderRegistry;
-    private static _PopupWindowManager;
+    private static _childWindowManager;
     static useDefaultPopoutUrl: boolean;
-    /** @public */
+    /** @public
+     * @deprecated in 3.7. Use `childWindows` property, name realignment.
+    */
     static get childWindowManager(): ChildWindowManager;
     /** Registers class that will be informed when the UserSettingsStorage location has been set or changed. This allows
      * classes to load any previously saved settings from the new storage location. Common storage locations are the browser's
@@ -92,11 +148,10 @@ export declare class UiFramework {
      * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
      * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
      * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
-     * @param startInUi1Mode Used for legacy applications to start up in the deprecated UI 1 mode. This should not set by newer applications.
      */
     static initialize(store: Store<any> | undefined, frameworkStateKey?: string): Promise<void>;
     /**
-     * @deprecated UI1.0 is deprecated. Use an overload without a `startInUi1Mode` argument instead.
+     * @deprecated in 3.5. UI1.0 is deprecated. Use an overload without a `startInUi1Mode` argument instead.
      */
     static initialize(store: Store<any> | undefined, frameworkStateKey?: string, startInUi1Mode?: boolean): Promise<void>;
     /**
@@ -130,7 +185,9 @@ export declare class UiFramework {
     static get localization(): Localization;
     /** The internationalization service namespace. */
     static get localizationNamespace(): string;
-    /** @public */
+    /** @public
+     * @deprecated in 3.7. Use `backstage` alternate property, name realignment.
+    */
     static get backstageManager(): BackstageManager;
     /** @alpha */
     static get hideIsolateEmphasizeActionHandler(): HideIsolateEmphasizeActionHandler;
@@ -198,11 +255,11 @@ export declare class UiFramework {
     static getWidgetOpacity(): number;
     static isMobile(): boolean;
     /** Returns the Ui Version.
-     * @deprecated UI1.0 is deprecated.
+     * @deprecated in 3.6. UI1.0 is deprecated.
      * @public
      */
     static get uiVersion(): FrameworkVersionId;
-    /** @deprecated UI1.0 is deprecated. */
+    /** @deprecated in 3.6. UI1.0 is deprecated. */
     static setUiVersion(version: FrameworkVersionId): void;
     static get showWidgetIcon(): boolean;
     static setShowWidgetIcon(value: boolean): void;

package/lib/cjs/appui-react/UiFramework.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiFramework.d.ts","sourceRoot":"","sources":["../../../src/appui-react/UiFramework.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAe,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAa,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGxF,OAAO,EAAkC,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAqB,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAwB,MAAM,sBAAsB,CAAC;AAExG,OAAO,EAAE,iCAAiC,EAA+B,MAAM,yCAAyC,CAAC;AAQzH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAKxD;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,GAAG,GAAG,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,qBAAqB,CAAC;CAAI;AAEhF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAI;AAE/F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAa;IACnC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiC;IAC1D,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAA4B;IACpE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAgB;IAC9C,OAAO,CAAC,MAAM,CAAC,UAAU,CAA2B;IACpD,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAoC;IACtF,oDAAoD;IACpD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA2C;IACzE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA8E;IACxH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAA4B;IAC9D,OAAc,mBAAmB,UAAS;IAE1C,cAAc;IACd,WAAkB,kBAAkB,IAAI,kBAAkB,CAEzD;IAED;;;;OAIG;WACW,4BAA4B,CAAC,KAAK,EAAE,oBAAoB;IAQtE;;OAEG;IACH,gBAAuB,qBAAqB,2BAAkC;IAE9E;;;;;OAKG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExG;;OAEG;WAEiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAalI;;;;;;;OAOG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAoDpI,0EAA0E;WAC5D,SAAS;IAiBvB,qDAAqD;IACrD,WAAkB,WAAW,IAAI,OAAO,CAAqC;IAE7E;;OAEG;IACH,WAAkB,eAAe,oBAIhC;IAED,cAAc;IACd,WAAkB,iBAAiB,IAAI,MAAM,CAE5C;IAED;;OAEG;IACH,WAAkB,cAAc,IAAI,cAAc,GAAG,SAAS,CAO7D;IAED,sBAAsB;IACtB,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED;;MAEE;IACF,WAAkB,YAAY,IAAI,YAAY,CAK7C;IAED,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,cAAc;IACd,WAAkB,gBAAgB,IAAI,gBAAgB,CAKrD;IAED,aAAa;IACb,WAAkB,iCAAiC,IAAI,iCAAiC,CAKvF;IAED,aAAa;WACC,oCAAoC,CAAC,OAAO,EAAE,iCAAiC,GAAG,SAAS;IAQzG,aAAa;IACb,WAAkB,aAAa,IAAI,aAAa,CAK/C;IAED;;OAEG;WACW,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAIvD,gBAAgB;IAChB,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED,gBAAgB;WACF,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;WAMhC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,UAAQ;WAQvE,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;WAItC,mBAAmB,IAAI,QAAQ;WAI/B,uBAAuB,IAAI,MAAM;WAIjC,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAYrE,cAAc;WACA,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;IAIxE,cAAc;WACA,eAAe,IAAI,IAAI;IAIrC,cAAc;WACA,iBAAiB,IAAI,cAAc,GAAG,SAAS;WAI/C,iBAAiB,IAAI,MAAM;WAI3B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;WAIzC,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,EAAE,aAAa,UAAQ;WAYzF,mBAAmB,IAAI,gBAAgB,GAAG,SAAS;IAIjE;;OAEG;WACiB,wCAAwC,CAAC,aAAa,UAAQ;IAclF,cAAc;WACM,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,aAAa,UAAQ;IAQpF;;;;OAIG;WACW,iBAAiB,IAAI,cAAc;WAInC,iCAAiC,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,UAAQ;WAIxF,iCAAiC,IAAI,MAAM,GAAG,SAAS;WAIvD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,UAAQ;WAItD,gBAAgB,IAAI,MAAM,GAAG,SAAS;WAItC,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,UAAQ;WAG/D,mBAAmB,IAAI,SAAS,GAAG,SAAS;IAI1D,cAAc;WACA,2BAA2B,IAAI,0BAA0B,EAAE;WAO3D,cAAc;WAId,cAAc,CAAC,OAAO,EAAE,OAAO;WAO/B,aAAa,CAAC,KAAK,EAAE,MAAM;WAO3B,aAAa,IAAI,MAAM;IAIrC;;;OAGG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM;IAO/C;;OAEG;WACW,iBAAiB,IAAI,MAAM;WAI3B,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;;OAGG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;IAED,uCAAuC;WACzB,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,cAAc,IAAI,OAAO,CAE1C;WAEa,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAM9C,uCAAuC;IACvC,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;WACa,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAMnD,sDAAsD;IACtD,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;WACa,6BAA6B,CAAC,KAAK,EAAE,OAAO;IAM1D,aAAa;IACb,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;IAED;;;gBAGY;WAEE,6BAA6B,CAAC,KAAK,EAAE,OAAO;IAO1D,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;OAEG;IACH,WAAkB,kBAAkB,YAEnC;IACD;;KAEC;WACa,qBAAqB,CAAC,OAAO,EAAE,OAAO;IAKpD;;OAEG;WAEiB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,EAAE,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB/N;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CACF"}
+{"version":3,"file":"UiFramework.d.ts","sourceRoot":"","sources":["../../../src/appui-react/UiFramework.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAe,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAa,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGxF,OAAO,EAAkC,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAqB,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEvF,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAwB,MAAM,sBAAsB,CAAC;AAExG,OAAO,EAAE,iCAAiC,EAA+B,MAAM,yCAAyC,CAAC;AAOzH,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAOxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAKtE;;;GAGG;AACH,oBAAY,kBAAkB,GAAG,GAAG,GAAG,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,gBAAgB,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,qBAAqB,CAAC;CAAI;AAEhF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAI;AAE/F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB;;;OAGG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAKhD;IAED;;;OAGG;IACH,WAAkB,YAAY,IAAI,qBAAqB,CAEtD;IAED;;;OAGG;IACH,WAAkB,QAAQ,IAAI,iBAAiB,CAE9C;IAED;;;OAGG;IACH,WAAkB,WAAW,IAAI,oBAAoB,CAEpD;IAED;;;OAGG;IACH,WAAkB,YAAY,IAAI,qBAAqB,CAEtD;IAED;;;OAGG;IACH,WAAkB,OAAO,IAAI,gBAAgB,CAE5C;IAED;;;OAGG;IACH,WAAkB,OAAO,IAAI,gBAAgB,CAK5C;IAED;;;OAGG;IACH,WAAkB,iBAAiB,IAAI,0BAA0B,CAEhE;IAED;;;OAGG;IACH,WAAkB,UAAU,IAAI,mBAAmB,CAElD;IAED,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAa;IACnC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiC;IAC1D,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAA4B;IACpE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAgB;IAC9C,OAAO,CAAC,MAAM,CAAC,UAAU,CAA2B;IACpD,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAoC;IACtF,oDAAoD;IACpD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA2C;IACzE,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA8E;IACxH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAA4B;IAC9D,OAAc,mBAAmB,UAAS;IAE1C;;MAEE;IACF,WAAkB,kBAAkB,IAAI,kBAAkB,CAEzD;IAED;;;;OAIG;WACW,4BAA4B,CAAC,KAAK,EAAE,oBAAoB;IAQtE;;OAEG;IACH,gBAAuB,qBAAqB,2BAAkC;IAE9E;;;;OAIG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAExG;;OAEG;WAEiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAalI;;;;;;;OAOG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAoDpI,0EAA0E;WAC5D,SAAS;IAiBvB,qDAAqD;IACrD,WAAkB,WAAW,IAAI,OAAO,CAAqC;IAE7E;;OAEG;IACH,WAAkB,eAAe,oBAIhC;IAED,cAAc;IACd,WAAkB,iBAAiB,IAAI,MAAM,CAE5C;IAED;;OAEG;IACH,WAAkB,cAAc,IAAI,cAAc,GAAG,SAAS,CAO7D;IAED,sBAAsB;IACtB,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED;;MAEE;IACF,WAAkB,YAAY,IAAI,YAAY,CAK7C;IAED,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED;;MAEE;IACF,WAAkB,gBAAgB,IAAI,gBAAgB,CAErD;IAED,aAAa;IACb,WAAkB,iCAAiC,IAAI,iCAAiC,CAKvF;IAED,aAAa;WACC,oCAAoC,CAAC,OAAO,EAAE,iCAAiC,GAAG,SAAS;IAQzG,aAAa;IACb,WAAkB,aAAa,IAAI,aAAa,CAK/C;IAED;;OAEG;WACW,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAIvD,gBAAgB;IAChB,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED,gBAAgB;WACF,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;WAMhC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,UAAQ;WAQvE,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;WAItC,mBAAmB,IAAI,QAAQ;WAI/B,uBAAuB,IAAI,MAAM;WAIjC,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAYrE,cAAc;WACA,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;IAIxE,cAAc;WACA,eAAe,IAAI,IAAI;IAIrC,cAAc;WACA,iBAAiB,IAAI,cAAc,GAAG,SAAS;WAI/C,iBAAiB,IAAI,MAAM;WAI3B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;WAIzC,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,EAAE,aAAa,UAAQ;WAYzF,mBAAmB,IAAI,gBAAgB,GAAG,SAAS;IAIjE;;OAEG;WACiB,wCAAwC,CAAC,aAAa,UAAQ;IAclF,cAAc;WACM,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,aAAa,UAAQ;IAQpF;;;;OAIG;WACW,iBAAiB,IAAI,cAAc;WAInC,iCAAiC,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,UAAQ;WAIxF,iCAAiC,IAAI,MAAM,GAAG,SAAS;WAIvD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,UAAQ;WAItD,gBAAgB,IAAI,MAAM,GAAG,SAAS;WAItC,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,UAAQ;WAG/D,mBAAmB,IAAI,SAAS,GAAG,SAAS;IAI1D,cAAc;WACA,2BAA2B,IAAI,0BAA0B,EAAE;WAO3D,cAAc;WAId,cAAc,CAAC,OAAO,EAAE,OAAO;WAO/B,aAAa,CAAC,KAAK,EAAE,MAAM;WAO3B,aAAa,IAAI,MAAM;IAIrC;;;OAGG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM;IAO/C;;OAEG;WACW,iBAAiB,IAAI,MAAM;WAI3B,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;;OAGG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;IAED,+CAA+C;WACjC,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,cAAc,IAAI,OAAO,CAE1C;WAEa,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAM9C,uCAAuC;IACvC,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;WACa,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAMnD,sDAAsD;IACtD,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;WACa,6BAA6B,CAAC,KAAK,EAAE,OAAO;IAM1D,aAAa;IACb,WAAkB,0BAA0B,IAAI,OAAO,CAEtD;IAED;;;gBAGY;WAEE,6BAA6B,CAAC,KAAK,EAAE,OAAO;IAO1D,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;OAEG;IACH,WAAkB,kBAAkB,YAEnC;IACD;;KAEC;WACa,qBAAqB,CAAC,OAAO,EAAE,OAAO;IAKpD;;OAEG;WAEiB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,EAAE,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB/N;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CACF"}

package/lib/cjs/appui-react/UiFramework.js

@@ -17,20 +17,25 @@ const core_react_1 = require("@itwin/core-react");
 const imodel_components_react_1 = require("@itwin/imodel-components-react");
 const BackstageManager_1 = require("./backstage/BackstageManager");
 const ChildWindowManager_1 = require("./childwindow/ChildWindowManager");
-const ConfigurableUiManager_1 = require("./configurableui/ConfigurableUiManager");
+const InternalConfigurableUiManager_1 = require("./configurableui/InternalConfigurableUiManager");
 const state_1 = require("./configurableui/state");
 const SessionState_1 = require("./redux/SessionState");
 const StateManager_1 = require("./redux/StateManager");
 const HideIsolateEmphasizeManager_1 = require("./selection/HideIsolateEmphasizeManager");
-const SyncUiEventDispatcher_1 = require("./syncui/SyncUiEventDispatcher");
 const ThemeManager_1 = require("./theme/ThemeManager");
 const keyinPaletteTools = require("./tools/KeyinPaletteTools");
 const openSettingTools = require("./tools/OpenSettingsTool");
 const restoreLayoutTools = require("./tools/RestoreLayoutTool");
 const toolSettingTools = require("./tools/ToolSettingsTools");
-const UiShowHideManager_1 = require("./utils/UiShowHideManager");
+const InternalUiShowHideManager_1 = require("./utils/InternalUiShowHideManager");
 const WidgetManager_1 = require("./widgets/WidgetManager");
-const FrontstageManager_1 = require("./frontstage/FrontstageManager");
+const InternalFrontstageManager_1 = require("./frontstage/InternalFrontstageManager");
+const InternalContentViewManager_1 = require("./content/InternalContentViewManager");
+const InternalModalDialogManager_1 = require("./dialog/InternalModalDialogManager");
+const InternalModelessDialogManager_1 = require("./dialog/InternalModelessDialogManager");
+const InternalKeyboardShortcut_1 = require("./keyboardshortcut/InternalKeyboardShortcut");
+const InternalToolSettingsManager_1 = require("./zones/toolsettings/InternalToolSettingsManager");
+const SyncUiEventDispatcher_1 = require("./syncui/SyncUiEventDispatcher");
 /** UiVisibility Event class.
  * @public
  */
@@ -48,9 +53,80 @@ exports.FrameworkVersionChangedEvent = FrameworkVersionChangedEvent;
  * @public
  */
 class UiFramework {
-    /** @public */
+    /**
+     * Operation on the backstage component.
+     * @beta
+     */
+    static get backstage() {
+        // istanbul ignore next
+        if (!UiFramework._backstageManager)
+            throw new appui_abstract_1.UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
+        return UiFramework._backstageManager;
+    }
+    /**
+     * Manage access to the child windows.
+     * @beta
+     */
+    static get childWindows() {
+        return this._childWindowManager;
+    }
+    /**
+     * Manage registered controls
+     * @beta
+     */
+    static get controls() {
+        return InternalConfigurableUiManager_1.InternalConfigurableUiManager;
+    }
+    /**
+     * Manage access to frontstages and related helper methods.
+     * @beta
+     */
+    static get frontstages() {
+        return InternalFrontstageManager_1.InternalFrontstageManager;
+    }
+    /**
+     * Manage access and behavior of the tool settings.
+     * @beta
+     */
+    static get toolSettings() {
+        return InternalToolSettingsManager_1.InternalToolSettingsManager;
+    }
+    /**
+     * Manage content presented by the frontstages.
+     * @beta
+     */
+    static get content() {
+        return InternalContentViewManager_1.InternalContentViewManager;
+    }
+    /**
+     * Manage displayed dialogs.
+     * @beta
+     */
+    static get dialogs() {
+        return {
+            modal: InternalModalDialogManager_1.InternalModalDialogManager,
+            modeless: InternalModelessDialogManager_1.InternalModelessDialogManager,
+        };
+    }
+    /**
+     * Manages global keyboard shortcuts
+     * @beta
+     */
+    static get keyboardShortcuts() {
+        return InternalKeyboardShortcut_1.InternalKeyboardShortcutManager;
+    }
+    /**
+     * Manages UI visibility (Show/Hide)
+     * @beta
+     */
+    static get visibility() {
+        return InternalUiShowHideManager_1.InternalUiShowHideManager;
+    }
+    /** @public
+     * @deprecated in 3.7. Use `childWindows` property, name realignment.
+    */
     static get childWindowManager() {
-        return UiFramework._PopupWindowManager;
+        return UiFramework.childWindows; // eslint-disable-line deprecation/deprecation
     }
     /** Registers class that will be informed when the UserSettingsStorage location has been set or changed. This allows
      * classes to load any previously saved settings from the new storage location. Common storage locations are the browser's
@@ -68,7 +144,7 @@ class UiFramework {
      * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
      * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
      * @param startInUi1Mode Used for legacy applications to start up in the deprecated UI 1 mode. This should not set by newer applications.
-     * @deprecated
+     * @deprecated in 3.5. UI1.0 is deprecated. Use an overload without a `startInUi1Mode` argument instead.
      */
     static async initialize(store, frameworkStateKey, startInUi1Mode) {
         return this.initializeEx(store, frameworkStateKey, startInUi1Mode);
@@ -117,8 +193,8 @@ class UiFramework {
         appui_abstract_1.UiAdmin.messagePresenter = core_frontend_1.IModelApp.notifications;
         UiFramework._initialized = true;
         // initialize any standalone settings providers that don't need to have defaults set by iModelApp
-        UiShowHideManager_1.UiShowHideSettingsProvider.initialize();
-        ConfigurableUiManager_1.ConfigurableUiManager.initialize();
+        InternalUiShowHideManager_1.UiShowHideSettingsProvider.initialize();
+        InternalConfigurableUiManager_1.InternalConfigurableUiManager.initialize();
         return frameworkNamespace;
     }
     /** Un-registers the UiFramework internationalization service namespace */
@@ -135,7 +211,7 @@ class UiFramework {
         UiFramework._hideIsolateEmphasizeActionHandler = undefined;
         UiFramework._settingsManager = undefined;
         imodel_components_react_1.UiIModelComponents.terminate();
-        UiShowHideManager_1.UiShowHideManager.terminate();
+        InternalUiShowHideManager_1.InternalUiShowHideManager.terminate();
         UiFramework._initialized = false;
     }
     /** Determines if UiFramework has been initialized */
@@ -187,12 +263,11 @@ class UiFramework {
     static get localizationNamespace() {
         return "UiFramework";
     }
-    /** @public */
+    /** @public
+     * @deprecated in 3.7. Use `backstage` alternate property, name realignment.
+    */
     static get backstageManager() {
-        // istanbul ignore next
-        if (!UiFramework._backstageManager)
-            throw new appui_abstract_1.UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
-        return UiFramework._backstageManager;
+        return UiFramework.backstage;
     }
     /** @alpha */
     static get hideIsolateEmphasizeActionHandler() {
@@ -282,7 +357,7 @@ class UiFramework {
         const oldConnection = UiFramework.getIModelConnection();
         if (oldConnection !== iModelConnection) {
             if (oldConnection === null || oldConnection === void 0 ? void 0 : oldConnection.iModelId)
-                FrontstageManager_1.FrontstageManager.clearFrontstageDefsForIModelId(oldConnection.iModelId);
+                InternalFrontstageManager_1.InternalFrontstageManager.clearFrontstageDefsForIModelId(oldConnection.iModelId);
             oldConnection && undefined === iModelConnection && SyncUiEventDispatcher_1.SyncUiEventDispatcher.clearConnectionEvents(oldConnection);
             iModelConnection && SyncUiEventDispatcher_1.SyncUiEventDispatcher.initializeConnectionEvents(iModelConnection);
             UiFramework.dispatchActionToStore(SessionState_1.SessionStateActionId.SetIModelConnection, iModelConnection, immediateSync);
@@ -348,11 +423,11 @@ class UiFramework {
             [{ id: "element", label: "Element" }];
     }
     static getIsUiVisible() {
-        return UiShowHideManager_1.UiShowHideManager.isUiVisible;
+        return UiFramework.visibility.isUiVisible;
     }
     static setIsUiVisible(visible) {
-        if (UiShowHideManager_1.UiShowHideManager.isUiVisible !== visible) {
-            UiShowHideManager_1.UiShowHideManager.isUiVisible = visible;
+        if (UiFramework.visibility.isUiVisible !== visible) {
+            UiFramework.visibility.isUiVisible = visible;
             UiFramework.onUiVisibilityChanged.emit({ visible });
         }
     }
@@ -391,13 +466,13 @@ class UiFramework {
         return core_bentley_1.ProcessDetector.isMobileBrowser;
     }
     /** Returns the Ui Version.
-     * @deprecated UI1.0 is deprecated.
+     * @deprecated in 3.6. UI1.0 is deprecated.
      * @public
      */
     static get uiVersion() {
         return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.frameworkVersion : this._uiVersion; // eslint-disable-line deprecation/deprecation
     }
-    /** @deprecated UI1.0 is deprecated. */
+    /** @deprecated in 3.6. UI1.0 is deprecated. */
     static setUiVersion(version) {
         if (UiFramework.uiVersion === version) // eslint-disable-line deprecation/deprecation
             return;
@@ -499,7 +574,7 @@ UiFramework._uiVersion = "2"; // eslint-disable-line deprecation/deprecation
 /** this provides a default state storage handler */
 UiFramework._uiStateStorage = new core_react_1.LocalStateStorage();
 UiFramework._uiSettingsProviderRegistry = new Map();
-UiFramework._PopupWindowManager = new ChildWindowManager_1.ChildWindowManager();
+UiFramework._childWindowManager = new ChildWindowManager_1.ChildWindowManager(); // eslint-disable-line deprecation/deprecation
 UiFramework.useDefaultPopoutUrl = false;
 /** Get Show Ui event.
  * @public