@itwin/appui-react 3.0.0-extension.1 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +1,178 @@
 # Change Log - @itwin/appui-react
 
-This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+This log was last generated on Mon, 24 Jan 2022 14:00:52 GMT and should not be manually modified.
+
+## 3.0.0
+Mon, 24 Jan 2022 14:00:52 GMT
+
+### Updates
+
+- Update ClearHideIsolateEmphasize Tool button definition to work on Models and Categories as well as Elements.
+- The Cartographic creation API now takes an interface as an argument with named properties. This will avoid callers mixing up the order of longitude, latitude, and height.
+- Update colorpicker to support RGB input
+- fix code for breaking change to .query() method
+- Existing ruleset configurations were updated to no longer use deprecated rule versions for iModel.js 3.0.
+- Upgrade target to ES2019 and deliver both a CommonJs and ESModule version of package
+- export CategoryVisibilityHandler
+- Fix ecsql row format
+- getAccessToken always returns a token
+- rename contextId -> iTwinId
+- updated @itwin/browser-authorization to 0.3.1
+- rename to @itwin/appui-react
+- Added UserInfo from itwin-client
+- remove ClientRequestContext and its subclasses
+- Made ConfigurableUiManager.closeUi() public
+- Removed OIDC signin/signout and UserProfileBackstageItem
+- Improve performance of determining visibility state of element and element grouping nodes.
+- Removed 'ModelsTreeProps.enablePreloading' flag
+- Promote standard UI providers from beta to public
+- Initialize StateManager store if necessary during UiFramework initialization.
+- Replace usage of I18N with generic Localization interface.
+- Remove use of UiItemsArbiter
+- Remove UserInfo completely
+- Update snapshots
+- Replaced ContextRegistry with generalized ITwinAccess interface
+-  Renamed an iModel's parent container to iTwin
+- Removed references to the deleted config-loader package
+- tool.run and tool.parseAndRun are now async methods
+- Support for TypeDoc v0.22.7. Fix various broken docs links.
+- Refactor SynchUiEventDispatcher to use new UiEventDispatcher from appui-abstract. Deprecate obsolete code.
+- Refactored part of AccuDraw UI & Providing AccuDraw UI documentation
+- Create empty frontstage and UiItemsProviders to populate it and update how ContentGroups are defined.
+- Add missing public/beta types to the barrel file.
+- Add required `width` and `height` props for `CategoryTree`, `ModelsTree` and `SpatialContainmentTree`.
+- Remove `IModelConnectedCategoryTree`, `IModelConnectedModelsTree` and `IModelConnectedSpatialContainmentTree`.
+- Remove deprecated `CategoryTreeWithSearchBox`.
+- Remove deprecated `VisibilityComponent`, `VisibilityWidget` and related types.
+- Clean up deprecated Drag & Drop related APIs
+- Add state variable to control display of view overlay in the viewports.
+- Update to default to using UI2.0/AppUI.
+- Deprecate and promote apis
+- Deprecate obsolete APIs. Publish beta APIs from last release.
+- Update links in API doc comments.
+- Make it possible to set label and execute function for BackstageAppButton
+- Upgraded itwinui-react to 1.16.2. Fixed editor sizes.
+- Ensure duplicate items provided via UiItemProviders are filtered out and only one item per Id is used. 
+- Add ability to remove stage launcher entry from backstage if only one stage is available.
+- Remove files generated by bad merge
+- Fix bug where ConditionalStringValue used in some status bar components would cause a crash.
+- Ensure nineZoneState is not set in FrontstageDef until 'isReady' is set.
+- Add support for all existing Indicator Props.
+- Updates to enable frontstageDef to be cached per iModelConnection.
+- Add initializeStateFromUserSettingsProviders to initialize UI state.
+- Update ShowHideManager defaults
+- Update comment.
+- Fix warning shown in unit test by ensuring setState is only processed if state component is mounted.
+- Allow widgets supplied by a UiItemsProvider to specify a default state of floating.
+- Deprecated HorizontalTabs in ui-core. Removed older deprecated items. Updated NextVersion.md.
+- Update to latest itwinui-react
+- Clean up css for status bar entries to avoid unwanted text wrapping.
+- Incorporating iTwinUI-CSS and iTwinUI-React into iModel.js
+- Moved iTwinUI style overrides to ui-core from ui-framework
+- Rename ui directories to match new package names.
+- Deprecated Task/Workflow. Promoted AccuDraw UI to @beta. Added AccuDraw and NavigationAids learning docs.
+- Fix bug that sets the icon on MessageBox.NoSymbol the Success icon.
+- Add prop that prevents popup button panel from unmounting when closed.
+- Update to React 17.
+- Created imodel-components folder & package and moved color, lineweight, navigationaids, quantity, timeline & viewport. Deprecated MessageSeverity in ui-core & added it ui-abstract. Added MessagePresenter interface to ui-abstract.
+- Remove react 16 peer dependency.
+- Filter out duplicate tools that may be registered in different UiItemProviders. First one in wins.
+- Remove itwinUi css overrides.
+- UiFramework and UiIModelComponent initialize method no longer take localization argument, uses IModelApp.localization internally.
+- Remove package react-split-pane.
+- Remove WidgetProvider and associated events.
+- Fixed z-index of status messages to be on top of a dialog
+- Update Tool Setting for UI 1.0 to fix refresh bug.
+- BaseUiItemsProvider class and refactor "standard" providers to subclass it.
+- Undeprecate necessary UI 1.0 classes/interfaces
+- Update standard UI item providers to require a providerId so more than one instance may be used within an app.  Usually by different packages providing stages.
+- Replaced ui-core Slider with one from iTwinUi-react. Update DefaultViewOverlay to opt-in to dislay of view overlays.
+- Update to latest types/react package
+- reset to use overflow hidden in floating widgets as it messes up auto-sizing and re-sizing.
+- Add support for widget tab icons in UI-2
+- Update CSS used for ToolSettingEntries in grid layout.
+- Get WidgetState and PanelState from NinzoneState when running in UI 2 mode - single source of truth.
+- Lock down and update version numbers so docs will build.
+- Hide widgets with Hidden defaultState when frontstage is activated.
+
+## 2.19.28
+Wed, 12 Jan 2022 14:52:38 GMT
+
+_Version update only_
+
+## 2.19.27
+Wed, 05 Jan 2022 20:07:20 GMT
+
+_Version update only_
+
+## 2.19.26
+Wed, 08 Dec 2021 20:54:53 GMT
+
+_Version update only_
+
+## 2.19.25
+Fri, 03 Dec 2021 20:05:49 GMT
+
+_Version update only_
+
+## 2.19.24
+Mon, 29 Nov 2021 18:44:31 GMT
+
+_Version update only_
+
+## 2.19.23
+Mon, 22 Nov 2021 20:41:40 GMT
+
+_Version update only_
+
+## 2.19.22
+Wed, 17 Nov 2021 01:23:26 GMT
+
+_Version update only_
+
+## 2.19.21
+Wed, 10 Nov 2021 10:58:24 GMT
+
+_Version update only_
+
+## 2.19.20
+Fri, 29 Oct 2021 16:14:22 GMT
+
+_Version update only_
+
+## 2.19.19
+Mon, 25 Oct 2021 16:16:25 GMT
+
+### Updates
+
+- Drop unnecessary dep on @bentley/react-scripts; add a *.d.ts file for svg?sprite loader syntax
+
+## 2.19.18
+Thu, 21 Oct 2021 20:59:44 GMT
+
+_Version update only_
+
+## 2.19.17
+Thu, 14 Oct 2021 21:19:43 GMT
+
+_Version update only_
+
+## 2.19.16
+Mon, 11 Oct 2021 17:37:46 GMT
+
+_Version update only_
+
+## 2.19.15
+Fri, 08 Oct 2021 16:44:23 GMT
+
+_Version update only_
+
+## 2.19.14
+Fri, 01 Oct 2021 13:07:03 GMT
+
+### Updates
+
+- Force Tool Settings to render when the active tool is reloaded.
 
 ## 2.19.13
 Tue, 21 Sep 2021 21:06:40 GMT
@@ -202,9 +374,9 @@ Mon, 24 May 2021 15:58:39 GMT
 - Clean up styling in StatusBar.css
 - Set overflow hidden on content Panes used when stage has multiple content views.
 - Adding ability to override isActive property for BackstageItem
-- Add support for child popup windows.
+- Add support for child popup windows. 
 - Replace deprecated ViewManager.forEachViewport() with iterator.
-- Update to latest classnames package
+- Update to latest classnames package 
 
 ## 2.15.6
 Wed, 26 May 2021 15:55:19 GMT
@@ -361,7 +533,7 @@ Thu, 28 Jan 2021 13:39:27 GMT
 
 ### Updates
 
-- Update components that support providing refs via React.forwardRef to work better with document generation.
+- Update components that support providing refs via React.forwardRef to work better with document generation.  
 - Fix backstage not updating when props.items are updated.
 - Propagate isDisabled MenuItem property to ContextMenuItem disabled property
 - Added partially visible instances support to VisibilityHandler
@@ -444,7 +616,7 @@ Thu, 19 Nov 2020 17:03:42 GMT
 
 ### Updates
 
-- Revert width change to EnumEditor component instead set width to auto only for docked tool settings.
+- Revert width change to EnumEditor component instead set width to auto only for docked tool settings. 
 
 ## 2.9.0
 Wed, 18 Nov 2020 16:01:50 GMT
@@ -552,7 +724,7 @@ Thu, 17 Sep 2020 13:16:12 GMT
 
 ### Updates
 
-- Add support for a feature flag to control the display of the keyin palette.
+- Add support for a feature flag to control the display of the keyin palette.     
 - BadgeType support for Backstage items
 - add itemschanged handler so that items provided can be conditionally hidden
 - Lower case syncEventIds prior to comparison
@@ -708,7 +880,7 @@ Thu, 28 May 2020 22:48:59 GMT
 ### Updates
 
 - Add missing @itwin/core-markup peerDependency
-- Add commandItemDef to clearHiddenIsolatedEmphasized elements.
+- Add commandItemDef to clearHiddenIsolatedEmphasized elements. 
 - Fix z-index of Modeless dialogs.
 - Address React warnings about deprecated methods.
 - Make methods in HideIsolateEmphasizeManager static so they can be called by other packages.
@@ -749,7 +921,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - react to renaming of imodeljs-clients
 - Moved KeyinBrowser component to @beta for 2.0
 - Using center of Messages indicator as target. Added CSS classname overrides to StatusBarComposer for sections. UI 2.0 color tweaks.
-- Fixed FrontendAuthorizationClient type guard.
+- Fixed FrontendAuthorizationClient type guard. 
 - Update GroupButton definition to use ReadonlyArray for child items.
 - Modal Frontstage styling
 - Ui 2.0 - Blur the toolbar item background
@@ -757,7 +929,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - Renamed OIDC constructs for consistency; Removed SAML support.
 - Fixed popup location when passing htmlElement to UiAdmin functions
 - Clean up deprecated APIs
-- Hide stage panel when panel state is off.
+- Hide stage panel when panel state is off. 
 - Added ability to customize selection handling in VisibilityWidget's Models tree
 - Made React functional component specifications consistent across UI packages
 - Slider component tooltipBelow prop & tooltip styling
@@ -804,7 +976,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - Ability to switch to 9-Zone 2.0
 - Refactor to remove duplicate ComponentGenerator instatiation. Rename filea nd components to remove React reference.
 - Update auto-generated dialog items to work with the Tool Settings Bar.
-- Moved Property classes and interfaces to ui-abstract package. Created a "DefaultDialogGridContainer" to turn specifications from abstract DialogItems UI into React components.
+- Moved Property classes and interfaces to ui-abstract package. Created a "DefaultDialogGridContainer" to turn specifications from abstract DialogItems UI into React components. 
 - Refactor DefaultToolSettingsProvider to use DialogItemsManager and remove duplicate code.
 - Fix Indicator to properly load SVG icons.
 - Refactor DefaultToolSettingsProvider to use the DialogItem interfaces in place of ToolSettings classes.
@@ -874,7 +1046,7 @@ Tue, 10 Dec 2019 18:08:56 GMT
 
 - Add useActiveIModelConnection hook.
 - Allow setting App Iconspec.
-- Setup OidcDesktopClient for Electron use cases.
+- Setup OidcDesktopClient for Electron use cases. 
 - Fix styling of footer Indicator to work with Themes.
 - Disallow plugins from adding tools anywhere but the end of a toolbar.
 - [ModelsTree] Merge same-label Subject nodes to avoid duplication
@@ -893,7 +1065,7 @@ Tue, 10 Dec 2019 18:08:56 GMT
 - Use exhaustive-deps linter rule.
 - Ability to opt-in to toolbar drag interaction.
 - Prevent unnecessary resubscribe in useActiveViewport hook.
-- Visibility Widget: Treat dictionary model as never private in Categories tree.
+- Visibility Widget: Treat dictionary model as never private in Categories tree. 
 - Ability to specify initialWidth for Zone component.
 - Removed unused React state variables. Removed unsupported setState calls from render() methods.
 - Code cleanup based on code analysis report from lgtm. Updated status field fade-in/out animation.
@@ -1117,7 +1289,7 @@ Mon, 03 Jun 2019 18:09:39 GMT
 - Release tag cleanup and ui-framework unit tests
 - Updated UI package release tags for 1.0 release.
 - Fixed release tag warnings in UI packages
-- Removed use of OidcClientWrapper.
+- Removed use of OidcClientWrapper. 
 - Remove console log message output by SyncUiEventDispatcher. Add Logging.
 - Changed some release tags from @hidden to @internal
 - Add alpha level support for solar timeline
@@ -1164,9 +1336,9 @@ Mon, 13 May 2019 15:52:05 GMT
 - Added SignIn presentational component to ui-components. Removed --ignoreMissingTags extract-api option.
 - Require React & React-dom 16.8
 - Remove IModelApp subclasses
-- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
+- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization. 
 - Added ViewportDialog in ui-test-app, ui-core/ContributeGuidelines.md. TSLint rules in ui-core for no-default-export & completed-docs. @beta release tags.
-- Minimized serialization/deserialization costs when round tripping SAML based AccessToken-s.
+- Minimized serialization/deserialization costs when round tripping SAML based AccessToken-s. 
 - Rename AppState to SessionState to avoid collision with acutal App's state. Add AvailableSectionScopes to SessionState.
 - Move SelectionScope status field from test app to ui-framework. Update icons-generic-webfont version to latest available.
 - Remove need to sync SelectionMethod since it is not changed within tool code.
@@ -1433,7 +1605,7 @@ Thu, 08 Nov 2018 17:59:21 GMT
 
 ### Updates
 
-- OIDC related enhancments (WIP).
+- OIDC related enhancments (WIP). 
 - Updated to TypeScript 3.1
 - ui-core unit tests. Fixed backstage open issue.
 - Zone & Widget initial state, more ui-core unit tests, cleaned up ui-framework index.ts files.

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 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/README.md

@@ -6,11 +6,11 @@ Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md
 
 The __@itwin/appui-react__ package contains application fragments for Login, Project, iModel and View selection, and configuration of the application UI including the Backstage, Frontstages, Widgets, etc.
 
-The ui-framework package is a portion of the iTwin.js User Interface library. It consists of major fragments of code that combine the
-functionality from the imodeljs-frontend and imodeljs client packages with the ui-core, ui-components and ui-ninezone packages to implement substantial
+The AppUI React package is a portion of the iTwin.js User Interface library. It consists of major fragments of code that combine the
+functionality from the `@itwin/core-frontend` with the core-react, imodel-components and appui-layout-react packages to implement substantial
 functionality that can be used within an iTwin.js application.
 
-The ui-framework package makes use of React for rendering of the user interface, and uses react-redux and its concept of the state store for
+The package makes use of React for rendering of the user interface, and uses react-redux and its concept of the state store for
 actions using reducers.
 
 There are a number of sub-frameworks, each which has a set of components, actions, and reducers, and contributes to the overall State. Each such

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

@@ -5,26 +5,26 @@ import { Store } from "redux";
 import { GuidString } from "@itwin/core-bentley";
 import { Localization } from "@itwin/core-common";
 import { IModelConnection, SnapMode, ViewState } from "@itwin/core-frontend";
-import { SettingsManager, UiEvent, UiSettingsStorage } from "@itwin/core-react";
+import { UiEvent } from "@itwin/appui-abstract";
+import { SettingsManager, UiStateStorage } from "@itwin/core-react";
 import { BackstageManager } from "./backstage/BackstageManager";
 import { ChildWindowManager } from "./childwindow/ChildWindowManager";
 import { FrameworkState } from "./redux/FrameworkState";
 import { CursorMenuData, PresentationSelectionScope } from "./redux/SessionState";
 import { HideIsolateEmphasizeActionHandler } from "./selection/HideIsolateEmphasizeManager";
-import { UserInfo } from "./UserInfo";
 import { WidgetManager } from "./widgets/WidgetManager";
-/** Defined that available Ui Versions. It is recommended to always use the latest version available.
+/** Defined that available UI Versions. It is recommended to always use the latest version available.
  * @public
  */
 export declare type FrameworkVersionId = "1" | "2";
-/** Interface to be implemented but any classes that wants to load their user settings when the UiSetting storage class is set.
+/** Interface to be implemented but any classes that wants to load their user settings when the UiStateEntry storage class is set.
  * @public
  */
 export interface UserSettingsProvider {
     /** Unique provider Id */
     providerId: string;
     /** Function to load settings from settings storage */
-    loadUserSettings(storage: UiSettingsStorage): Promise<void>;
+    loadUserSettings(storage: UiStateStorage): Promise<void>;
 }
 /** UiVisibility Event Args interface.
  * @public
@@ -69,7 +69,8 @@ export declare class UiFramework {
     private static _widgetManager?;
     private static _uiVersion;
     private static _hideIsolateEmphasizeActionHandler?;
-    private static _uiSettingsStorage;
+    /** this provides a default state storage handler */
+    private static _uiStateStorage;
     private static _settingsManager?;
     private static _uiSettingsProviderRegistry;
     private static _PopupWindowManager;
@@ -105,7 +106,8 @@ export declare class UiFramework {
     /** Determines if UiFramework has been initialized */
     static get initialized(): boolean;
     /** Property that returns the SettingManager used by AppUI-based applications.
-     *  @public */
+     * @public
+     */
     static get settingsManager(): SettingsManager;
     /** @public */
     static get frameworkStateKey(): string;
@@ -152,14 +154,18 @@ export declare class UiFramework {
     static setActiveIModelId(iModelId: string): void;
     static setIModelConnection(iModelConnection: IModelConnection | undefined, immediateSync?: boolean): void;
     static getIModelConnection(): IModelConnection | undefined;
+    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders
+     * @public
+     */
+    static initializeStateFromUserSettingsProviders(immediateSync?: boolean): Promise<void>;
     /** @public */
-    static setUiSettingsStorage(storage: UiSettingsStorage, immediateSync?: boolean): Promise<void>;
-    /** @public */
-    static getUiSettingsStorage(): UiSettingsStorage;
-    /** @public */
-    static setUserInfo(userInfo: UserInfo | undefined, immediateSync?: boolean): void;
-    /** @public */
-    static getUserInfo(): UserInfo | undefined;
+    static setUiStateStorage(storage: UiStateStorage, immediateSync?: boolean): Promise<void>;
+    /** The UI Settings Storage is a convenient wrapper around Local Storage to assist in caching state information across user sessions.
+     * It was previously used to conflate both the state information across session and the information driven directly from user explicit action,
+     * which are now handled with user preferences.
+     * @public
+     */
+    static getUiStateStorage(): UiStateStorage;
     static setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync?: boolean): void;
     static getDefaultIModelViewportControlId(): string | undefined;
     static setDefaultViewId(viewId: string, immediateSync?: boolean): void;
@@ -180,15 +186,24 @@ export declare class UiFramework {
      */
     static get uiVersion(): FrameworkVersionId;
     static setUiVersion(version: FrameworkVersionId): void;
+    static get showWidgetIcon(): boolean;
+    static setShowWidgetIcon(value: boolean): void;
     static get useDragInteraction(): boolean;
     static setUseDragInteraction(useDragInteraction: boolean): void;
+    /** Returns the variable controlling whether the overlay is displayed in a Viewport
+     * @public
+     */
+    static get viewOverlayDisplay(): boolean;
+    /** Set the variable that controls display of the view overlay. Applies to all viewports in the app
+   * @public
+   */
+    static setViewOverlayDisplay(display: boolean): void;
     /** Send logging message to the telemetry system
      * @internal
      */
     static postTelemetry(eventName: string, eventId?: GuidString, iTwinId?: GuidString, iModeId?: GuidString, changeSetId?: string, time?: TrackingTime, additionalProperties?: {
         [key: string]: any;
     }): Promise<void>;
-    private static _handleFrameworkVersionChangedEvent;
     /** Determines whether a ContextMenu is open
      * @alpha
      * */

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;AAIxF,OAAO,EAAwB,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtG,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,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAKxD;;GAEG;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,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;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,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAiD;IAClF,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;;;;OAIG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;;;;;OAMG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiD1G,0EAA0E;WAC5D,SAAS;IAiBvB,qDAAqD;IACrD,WAAkB,WAAW,IAAI,OAAO,CAAqC;IAE7E;kBACc;IACd,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,cAAc;WACM,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,UAAQ;IAmB1F,cAAc;WACA,oBAAoB,IAAI,iBAAiB;IAIvD,cAAc;WACA,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,EAAE,aAAa,UAAQ;IAI/E,cAAc;WACA,WAAW,IAAI,QAAQ,GAAG,SAAS;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;WAIvB,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;OAEG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;WAEa,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;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,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAMhD;IAEF;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CAEF"}
+{"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;;GAEG;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;;;;OAIG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;;;;;OAMG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiD1G,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;WAIvB,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;OAEG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;WAEa,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,cAAc,IAAI,OAAO,CAE1C;WAEa,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAO9C,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

@@ -11,7 +11,7 @@ exports.UiFramework = exports.FrameworkVersionChangedEvent = exports.UiVisibilit
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
 const presentation_frontend_1 = require("@itwin/presentation-frontend");
-const telemetry_client_1 = require("@bentley/telemetry-client");
+const core_telemetry_1 = require("@itwin/core-telemetry");
 const appui_abstract_1 = require("@itwin/appui-abstract");
 const core_react_1 = require("@itwin/core-react");
 const imodel_components_react_1 = require("@itwin/imodel-components-react");
@@ -34,13 +34,13 @@ const FrontstageManager_1 = require("./frontstage/FrontstageManager");
 /** UiVisibility Event class.
  * @public
  */
-class UiVisibilityChangedEvent extends core_react_1.UiEvent {
+class UiVisibilityChangedEvent extends appui_abstract_1.UiEvent {
 }
 exports.UiVisibilityChangedEvent = UiVisibilityChangedEvent;
 /** FrameworkVersion Changed Event class.
  * @internal
  */
-class FrameworkVersionChangedEvent extends core_react_1.UiEvent {
+class FrameworkVersionChangedEvent extends appui_abstract_1.UiEvent {
 }
 exports.FrameworkVersionChangedEvent = FrameworkVersionChangedEvent;
 /**
@@ -136,7 +136,8 @@ class UiFramework {
     /** Determines if UiFramework has been initialized */
     static get initialized() { return UiFramework._initialized; }
     /** Property that returns the SettingManager used by AppUI-based applications.
-     *  @public */
+     * @public
+     */
     static get settingsManager() {
         if (undefined === UiFramework._settingsManager)
             UiFramework._settingsManager = new core_react_1.SettingsManager();
@@ -286,33 +287,35 @@ class UiFramework {
     static getIModelConnection() {
         return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.iModelConnection : /* istanbul ignore next */ undefined;
     }
-    /** @public */
-    static async setUiSettingsStorage(storage, immediateSync = false) {
-        if (UiFramework._uiSettingsStorage === storage)
-            return;
-        UiFramework._uiSettingsStorage = storage;
+    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders
+     * @public
+     */
+    static async initializeStateFromUserSettingsProviders(immediateSync = false) {
         // let any registered providers to load values from the new storage location
         const providerKeys = [...this._uiSettingsProviderRegistry.keys()];
         for await (const key of providerKeys) {
-            await this._uiSettingsProviderRegistry.get(key).loadUserSettings(storage);
+            await this._uiSettingsProviderRegistry.get(key).loadUserSettings(UiFramework._uiStateStorage);
         }
         // istanbul ignore next
         if (immediateSync)
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiSettingsChanged);
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged);
         else
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiSettingsChanged);
-    }
-    /** @public */
-    static getUiSettingsStorage() {
-        return UiFramework._uiSettingsStorage;
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged);
     }
     /** @public */
-    static setUserInfo(userInfo, immediateSync = false) {
-        UiFramework.dispatchActionToStore(SessionState_1.SessionStateActionId.SetUserInfo, userInfo, immediateSync);
+    static async setUiStateStorage(storage, immediateSync = false) {
+        if (UiFramework._uiStateStorage === storage)
+            return;
+        UiFramework._uiStateStorage = storage;
+        await this.initializeStateFromUserSettingsProviders(immediateSync);
     }
-    /** @public */
-    static getUserInfo() {
-        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.userInfo : /* istanbul ignore next */ undefined;
+    /** The UI Settings Storage is a convenient wrapper around Local Storage to assist in caching state information across user sessions.
+     * It was previously used to conflate both the state information across session and the information driven directly from user explicit action,
+     * which are now handled with user preferences.
+     * @public
+     */
+    static getUiStateStorage() {
+        return UiFramework._uiStateStorage;
     }
     static setDefaultIModelViewportControlId(iModelViewportControlId, immediateSync = false) {
         UiFramework.dispatchActionToStore(SessionState_1.SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId, immediateSync);
@@ -378,12 +381,34 @@ class UiFramework {
             return;
         UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetFrameworkVersion, version === "1" ? "1" : "2", true);
     }
+    static get showWidgetIcon() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.showWidgetIcon : /* istanbul ignore next */ false;
+    }
+    static setShowWidgetIcon(value) {
+        if (UiFramework.showWidgetIcon === value)
+            return;
+        UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetShowWidgetIcon, value, true);
+    }
     static get useDragInteraction() {
         return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.useDragInteraction : false;
     }
     static setUseDragInteraction(useDragInteraction) {
         UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetDragInteraction, useDragInteraction, true);
     }
+    /** Returns the variable controlling whether the overlay is displayed in a Viewport
+     * @public
+     */
+    static get viewOverlayDisplay() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.viewOverlayDisplay : /* istanbul ignore next */ true;
+    }
+    /** Set the variable that controls display of the view overlay. Applies to all viewports in the app
+   * @public
+   */
+    static setViewOverlayDisplay(display) {
+        if (UiFramework.viewOverlayDisplay === display)
+            return;
+        UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetViewOverlayDisplay, display);
+    }
     /** Send logging message to the telemetry system
      * @internal
      */
@@ -400,7 +425,7 @@ class UiFramework {
                 applicationVersion: core_frontend_1.IModelApp.applicationVersion,
                 accessToken: (_a = (await core_frontend_1.IModelApp.authorizationClient.getAccessToken())) !== null && _a !== void 0 ? _a : "",
             };
-            const telemetryEvent = new telemetry_client_1.TelemetryEvent(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties);
+            const telemetryEvent = new core_telemetry_1.TelemetryEvent(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties);
             await core_frontend_1.IModelApp.telemetry.postTelemetry(activity, telemetryEvent);
         }
         catch { }
@@ -418,7 +443,8 @@ UiFramework._initialized = false;
 UiFramework._complaint = "UiFramework not initialized";
 UiFramework._frameworkStateKeyInStore = "frameworkState"; // default name
 UiFramework._uiVersion = "2";
-UiFramework._uiSettingsStorage = new core_react_1.LocalSettingsStorage(); // this provides a default storage location for settings
+/** 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.useDefaultPopoutUrl = false;
@@ -426,11 +452,4 @@ UiFramework.useDefaultPopoutUrl = false;
  * @public
  */
 UiFramework.onUiVisibilityChanged = new UiVisibilityChangedEvent();
-UiFramework._handleFrameworkVersionChangedEvent = (args) => {
-    // Log Ui Version used
-    core_bentley_1.Logger.logInfo(UiFramework.loggerCategory(UiFramework), `Ui Version changed to ${args.version} `);
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    UiFramework.postTelemetry(`Ui Version changed to ${args.version} `, "F2772C81-962D-4755-807C-2D675A5FF399");
-    UiFramework.setUiVersion(args.version);
-};
 //# sourceMappingURL=UiFramework.js.map