@itwin/appui-react 4.14.0 → 4.15.0

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

@@ -6,7 +6,8 @@
  * @module Utilities
  */
 import { Logger, ProcessDetector } from "@itwin/core-bentley";
-import { IModelApp, SnapMode } from "@itwin/core-frontend";
+import { SnapMode } from "@itwin/core-frontend";
+import { IModelApp } from "@itwin/core-frontend";
 import { UiAdmin, UiError, UiEvent } from "@itwin/appui-abstract";
 import { LocalStateStorage, SettingsManager } from "@itwin/core-react";
 import { getObjectClassName } from "@itwin/core-react";
@@ -14,11 +15,9 @@ import { UiIModelComponents } from "@itwin/imodel-components-react";
 import { BackstageManager } from "./backstage/BackstageManager";
 import { InternalChildWindowManager } from "./childwindow/InternalChildWindowManager";
 import { InternalConfigurableUiManager } from "./configurableui/InternalConfigurableUiManager";
-import { ConfigurableUiActionId } from "./configurableui/state";
 import { SessionStateActionId } from "./redux/SessionState";
 import { StateManager } from "./redux/StateManager";
 import { HideIsolateEmphasizeManager } from "./selection/HideIsolateEmphasizeManager";
-import { SYSTEM_PREFERRED_COLOR_THEME, TOOLBAR_OPACITY_DEFAULT, WIDGET_OPACITY_DEFAULT, } from "./theme/ThemeManager";
 import * as keyinPaletteTools from "./tools/KeyinPaletteTools";
 import * as openSettingTools from "./tools/OpenSettingsTool";
 import * as restoreLayoutTools from "./tools/RestoreLayoutTool";
@@ -37,9 +36,12 @@ import { AccuDrawPopupManager } from "./accudraw/AccuDrawPopupManager";
 import { UiDataProvidedDialog } from "./dialog/UiDataProvidedDialog";
 import { createElement } from "react";
 import { mapToRelativePosition } from "./utils/Placement";
+import { SYSTEM_PREFERRED_COLOR_THEME, TOOLBAR_OPACITY_DEFAULT, WIDGET_OPACITY_DEFAULT, } from "./theme/ThemeId";
+import { ConfigurableUiActionId } from "./redux/ConfigurableUiState";
+import { useGlobalStore } from "./uistate/useGlobalStore";
 /** UiVisibility Event class.
  * @public
- * @deprecated in 4.13.x. This class should not be used by applications to instantiate objects.
+ * @deprecated in 4.13.0. This class should not be used by applications to instantiate objects.
  */
 // eslint-disable-next-line deprecation/deprecation
 export class UiVisibilityChangedEvent extends UiEvent {
@@ -48,84 +50,57 @@ export class UiVisibilityChangedEvent extends UiEvent {
  * @public
  */
 export class UiFramework {
-    /**
-     * Operation on the backstage component.
-     * @public
-     */
+    /** Operation on the backstage component. */
     static get backstage() {
         if (!UiFramework._backstageManager)
             // eslint-disable-next-line deprecation/deprecation
             throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
         return UiFramework._backstageManager;
     }
-    /**
-     * Manage access to the child windows.
-     * @public
-     */
+    /** Manage access to the child windows. */
     static get childWindows() {
         return this._childWindowManager;
     }
-    /**
-     * Manage registered controls
-     * @public
-     */
+    /** Manage registered controls. */
     static get controls() {
         return InternalConfigurableUiManager;
     }
-    /**
-     * Manage access to frontstages and related helper methods.
-     * @public
-     */
+    /** Manage access to frontstages and related helper methods. */
     static get frontstages() {
         return InternalFrontstageManager;
     }
-    /**
-     * Manage access and behavior of the tool settings.
-     * @public
-     */
+    /** Manage access and behavior of the tool settings. */
     static get toolSettings() {
         return InternalToolSettingsManager;
     }
-    /**
-     * Manage content presented by the frontstages.
-     * @public
-     */
+    /** Manage content presented by the frontstages. */
     static get content() {
         return InternalContentViewManager;
     }
-    /**
-     * Manage displayed dialogs.
-     * @public
-     */
+    /** Manage displayed dialogs. */
     static get dialogs() {
         return {
             modal: InternalModalDialogManager,
             modeless: InternalModelessDialogManager,
         };
     }
-    /**
-     * Manages global keyboard shortcuts
+    /** Manages global keyboard shortcuts
      *
      * Note: This only manages the list of available shortcuts registered with it. It does not listens to the actual
      * keyboard events. In order for these shortcuts to be called upon a keyboard event, the application can
      * override the `IModelApp.toolAdmin` and assign it [[FrameworkToolAdmin]] or create an event listener
      * and call `UiFramework.keyboardShortcuts.processKey`.
-     * @public
      */
     static get keyboardShortcuts() {
         return InternalKeyboardShortcutManager;
     }
-    /**
-     * Manages UI visibility (Show/Hide)
-     * @public
-     */
+    /** Manages UI visibility (Show/Hide). */
     static get visibility() {
         return InternalUiShowHideManager;
     }
     /** 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
      * local storage, or the iTwin Product Settings cloud storage available via the SettingsAdmin see `IModelApp.settingsAdmin`.
-     * @public
      */
     static registerUserSettingsProvider(entry) {
         if (this._uiSettingsProviderRegistry.has(entry.providerId))
@@ -133,19 +108,17 @@ export class UiFramework {
         this._uiSettingsProviderRegistry.set(entry.providerId, entry);
         return true;
     }
-    /**
-     * 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".
-     */
     static async initialize(store, frameworkStateKey) {
+        // TODO: check `arguments` to determine between redux & no-redux initializers.
         if (UiFramework._initialized) {
             Logger.logInfo(UiFramework.loggerCategory(UiFramework), `UiFramework.initialize already called`);
             return;
         }
         /* if store is undefined then the StateManager class should have been initialized by parent app and the apps default set of reducers registered with it.
           If the app has no reducers to add and does not initialize a StateManager then just initialize the StateManager with the default framework reducer now */
+        // eslint-disable-next-line deprecation/deprecation
         if (undefined === store && !StateManager.isInitialized(true))
+            // eslint-disable-next-line deprecation/deprecation
             new StateManager();
         UiFramework._store = store;
         // ignore setting _frameworkStateKeyInStore if not using store
@@ -159,6 +132,7 @@ export class UiFramework {
             openSettingTools,
             toolSettingTools,
         ].forEach((tool) => IModelApp.tools.registerModule(tool, this.localizationNamespace));
+        // eslint-disable-next-line deprecation/deprecation
         UiFramework._backstageManager = new BackstageManager();
         UiFramework._hideIsolateEmphasizeActionHandler =
             new HideIsolateEmphasizeManager(); // this allows user to override the default HideIsolateEmphasizeManager implementation.
@@ -166,7 +140,7 @@ export class UiFramework {
         // Initialize ui-imodel-components, ui-components, ui-core & ui-abstract
         await UiIModelComponents.initialize();
         UiFramework.settingsManager.onSettingsProvidersChanged.addListener(() => {
-            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SettingsProvidersChanged);
+            dispatchSyncUiEvent(SyncUiEventId.SettingsProvidersChanged);
         });
         // Initialize the MessagePresenter interface in UiAdmin for Editor notifications
         UiAdmin.messagePresenter = IModelApp.notifications;
@@ -176,10 +150,12 @@ export class UiFramework {
         InternalConfigurableUiManager.initialize();
         return frameworkNamespace;
     }
-    /** Un-registers the UiFramework internationalization service namespace */
+    /** Un-registers the UiFramework internationalization service namespace. */
     static terminate() {
+        InternalKeyboardShortcutManager.shortcutContainer.emptyData();
         UiFramework._store = undefined;
         UiFramework._frameworkStateKeyInStore = "frameworkState";
+        // eslint-disable-next-line deprecation/deprecation
         if (StateManager.isInitialized(true))
             StateManager.clearStore();
         IModelApp.localization?.unregisterNamespace(UiFramework.localizationNamespace);
@@ -195,50 +171,22 @@ export class UiFramework {
     static get initialized() {
         return UiFramework._initialized;
     }
-    /** Property that returns the SettingManager used by AppUI-based applications.
-     * @public
-     */
+    /** Property that returns the SettingManager used by AppUI-based applications. */
     static get settingsManager() {
         if (undefined === UiFramework._settingsManager)
             UiFramework._settingsManager = new SettingsManager();
         return UiFramework._settingsManager;
     }
-    /** @public */
-    static get frameworkStateKey() {
-        return UiFramework._frameworkStateKeyInStore;
-    }
-    /** The UiFramework state maintained by Redux
-     * @public
-     */
-    static get frameworkState() {
-        try {
-            return UiFramework.store.getState()[UiFramework.frameworkStateKey];
-        }
-        catch (_e) {
-            return undefined;
-        }
-    }
-    /** The Redux store */
-    static get store() {
-        if (UiFramework._store)
-            return UiFramework._store;
-        if (!StateManager.isInitialized(true))
-            // eslint-disable-next-line deprecation/deprecation
-            throw new UiError(UiFramework.loggerCategory(this), `Error trying to access redux store before either store or StateManager has been initialized.`);
-        return StateManager.store;
-    }
     /** The internationalization service namespace. */
     static get localizationNamespace() {
         return "UiFramework";
     }
-    /** @public */
     static get hideIsolateEmphasizeActionHandler() {
         if (!UiFramework._hideIsolateEmphasizeActionHandler)
             // eslint-disable-next-line deprecation/deprecation
             throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
         return UiFramework._hideIsolateEmphasizeActionHandler;
     }
-    /** @public */
     static setHideIsolateEmphasizeActionHandler(handler) {
         if (handler)
             UiFramework._hideIsolateEmphasizeActionHandler = handler;
@@ -269,45 +217,6 @@ export class UiFramework {
         const category = UiFramework.packageName + (className ? `.${className}` : "");
         return category;
     }
-    static dispatchActionToStore(type, payload, immediateSync = false) {
-        UiFramework.store.dispatch({ type, payload });
-        if (immediateSync)
-            SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(type);
-        else
-            SyncUiEventDispatcher.dispatchSyncUiEvent(type);
-    }
-    static setAccudrawSnapMode(snapMode) {
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetSnapMode, snapMode, true);
-    }
-    static getAccudrawSnapMode() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.snapMode
-            : SnapMode.NearestKeypoint;
-    }
-    /**
-     * Returns the stored active selection scope id.
-     */
-    static getActiveSelectionScope() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.activeSelectionScope
-            : "element";
-    }
-    /**
-     * This method stores the active selection scope to the supplied scope id, and triggers
-     * a `SessionStateActionId.SetSelectionScope` event in the `SyncUiEventDispatcher`.
-     * Note: As of 4.0, this method *does not change* the active selection scope in the `Presentation.selection.scopes.activeScope` property.
-     * This event should be listened to and the change should typically be applied to
-     * `Presentation.selection.scopes.activeScope` property from the `@itwin/presentation-frontend` package.
-     */
-    static setActiveSelectionScope(selectionScopeId) {
-        if (UiFramework.frameworkState) {
-            const foundIndex = UiFramework.frameworkState.sessionState.availableSelectionScopes.findIndex((selectionScope) => selectionScope.id === selectionScopeId);
-            if (-1 !== foundIndex) {
-                const scope = UiFramework.frameworkState.sessionState.availableSelectionScopes[foundIndex];
-                UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, scope.id);
-            }
-        }
-    }
     /** Show a context menu at a particular location.
      * @param items Properties of the menu items to display.
      * @param location Location of the context menu, relative to the origin of anchorElement or the overall window.
@@ -337,30 +246,46 @@ export class UiFramework {
         UiFramework.openCursorMenu(cursorMenuData);
         return true;
     }
-    /** @public */
     static openCursorMenu(
     // eslint-disable-next-line deprecation/deprecation
     menuData) {
-        UiFramework.dispatchActionToStore(SessionStateActionId.UpdateCursorMenu, menuData);
+        // eslint-disable-next-line deprecation/deprecation
+        if (this.frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework.dispatchActionToStore(
+            // eslint-disable-next-line deprecation/deprecation
+            SessionStateActionId.UpdateCursorMenu, menuData);
+            return;
+        }
+        useGlobalStore.setState({ cursorMenuPayload: menuData });
+        // eslint-disable-next-line deprecation/deprecation
+        dispatchSyncUiEvent(SessionStateActionId.UpdateCursorMenu);
     }
-    /** @public */
     static closeCursorMenu() {
-        UiFramework.dispatchActionToStore(SessionStateActionId.UpdateCursorMenu, undefined);
+        // eslint-disable-next-line deprecation/deprecation
+        if (UiFramework.frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework.dispatchActionToStore(
+            // eslint-disable-next-line deprecation/deprecation
+            SessionStateActionId.UpdateCursorMenu, undefined);
+            return;
+        }
+        useGlobalStore.setState({ cursorMenuPayload: undefined });
+        // eslint-disable-next-line deprecation/deprecation
+        dispatchSyncUiEvent(SessionStateActionId.UpdateCursorMenu);
     }
-    /** @public */
+    /** @note Returned value is immutable.  */
     static getCursorMenuData() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.cursorMenuPayload ??
-                UiFramework.frameworkState.sessionState.cursorMenuData
-            : undefined;
-    }
-    static getActiveIModelId() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.iModelId
-            : "";
-    }
-    static setActiveIModelId(iModelId) {
-        UiFramework.dispatchActionToStore(SessionStateActionId.SetActiveIModelId, iModelId);
+        // eslint-disable-next-line deprecation/deprecation
+        const state = this.frameworkState;
+        if (state) {
+            return (
+            // eslint-disable-next-line deprecation/deprecation
+            state.sessionState.cursorMenuPayload ??
+                // eslint-disable-next-line deprecation/deprecation
+                state.sessionState.cursorMenuData);
+        }
+        return useGlobalStore.getState().cursorMenuPayload;
     }
     static setIModelConnection(iModelConnection, immediateSync = false) {
         const oldConnection = UiFramework.getIModelConnection();
@@ -370,21 +295,57 @@ export class UiFramework {
         oldConnection && SyncUiEventDispatcher.clearConnectionEvents(oldConnection);
         iModelConnection &&
             SyncUiEventDispatcher.initializeConnectionEvents(iModelConnection);
-        UiFramework.dispatchActionToStore(SessionStateActionId.SetIModelConnection, iModelConnection, immediateSync);
+        // eslint-disable-next-line deprecation/deprecation
+        if (UiFramework.frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework.dispatchActionToStore(
+            // eslint-disable-next-line deprecation/deprecation
+            SessionStateActionId.SetIModelConnection, iModelConnection, immediateSync);
+        }
+        else {
+            useGlobalStore.setState({ iModelConnection });
+            // eslint-disable-next-line deprecation/deprecation
+            dispatchSyncUiEvent(SessionStateActionId.SetIModelConnection);
+        }
         const itemsSelected = iModelConnection
             ? iModelConnection.selectionSet.elements.size
             : 0;
-        UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, itemsSelected);
+        UiFramework.setNumItemsSelected(itemsSelected);
+        // eslint-disable-next-line deprecation/deprecation
         UiFramework.setActiveIModelId(iModelConnection?.iModelId ?? "");
     }
     static getIModelConnection() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.iModelConnection
-            : undefined;
+        // eslint-disable-next-line deprecation/deprecation
+        const frameworkState = UiFramework.frameworkState;
+        if (frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            return frameworkState.sessionState.iModelConnection;
+        }
+        return useGlobalStore.getState().iModelConnection;
     }
-    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders
-     * @public
-     */
+    static setNumItemsSelected(numSelected) {
+        // eslint-disable-next-line deprecation/deprecation
+        if (UiFramework.frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework.dispatchActionToStore(
+            // eslint-disable-next-line deprecation/deprecation
+            SessionStateActionId.SetNumItemsSelected, numSelected);
+            return;
+        }
+        useGlobalStore.setState({ numItemsSelected: numSelected });
+        // eslint-disable-next-line deprecation/deprecation
+        dispatchSyncUiEvent(SessionStateActionId.SetNumItemsSelected);
+    }
+    static getNumItemsSelected() {
+        // eslint-disable-next-line deprecation/deprecation
+        const state = this.frameworkState;
+        if (state) {
+            // eslint-disable-next-line deprecation/deprecation
+            return state.sessionState.numItemsSelected;
+        }
+        return useGlobalStore.getState().numItemsSelected;
+    }
+    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders. */
     static async initializeStateFromUserSettingsProviders(immediateSync = false) {
         // let any registered providers to load values from the new storage location
         const providerKeys = [...this._uiSettingsProviderRegistry.keys()];
@@ -393,12 +354,8 @@ export class UiFramework {
                 .get(key)
                 .loadUserSettings(UiFramework._uiStateStorage);
         }
-        if (immediateSync)
-            SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.UiStateStorageChanged);
-        else
-            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.UiStateStorageChanged);
+        dispatchSyncUiEvent(SyncUiEventId.UiStateStorageChanged, immediateSync);
     }
-    /** @public */
     static async setUiStateStorage(storage, immediateSync = false) {
         if (UiFramework._uiStateStorage === storage)
             return;
@@ -408,45 +365,32 @@ export class UiFramework {
     /** 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(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId, immediateSync);
-    }
-    static getDefaultIModelViewportControlId() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.defaultIModelViewportControlId
-            : undefined;
-    }
-    static setDefaultViewId(viewId, immediateSync = false) {
-        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultViewId, viewId, immediateSync);
-    }
-    static getDefaultViewId() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.defaultViewId
-            : undefined;
-    }
     static setDefaultViewState(viewState, immediateSync = false) {
-        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultViewState, viewState, immediateSync);
+        // eslint-disable-next-line deprecation/deprecation
+        if (UiFramework.frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            UiFramework.dispatchActionToStore(
+            // eslint-disable-next-line deprecation/deprecation
+            SessionStateActionId.SetDefaultViewState, viewState, immediateSync);
+            return;
+        }
+        useGlobalStore.setState({ viewState });
+        dispatchSyncUiEvent(
+        // eslint-disable-next-line deprecation/deprecation
+        SessionStateActionId.SetDefaultViewState, immediateSync);
     }
     static getDefaultViewState() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.defaultViewState
-            : undefined;
-    }
-    /**
-     * Returns the stored list of available selection scopes. This list should be set by the application
-     * by dispatching the `setAvailableSelectionScopes` action.
-     * The value for this action typically come from `Presentation.selection.scopes.getSelectionScopes()`
-     * method found in the `@itwin/presentation-frontend` package.
-     * @public */
-    static getAvailableSelectionScopes() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.availableSelectionScopes
-            : [{ id: "element", label: "Element" }];
+        // eslint-disable-next-line deprecation/deprecation
+        const frameworkState = UiFramework.frameworkState;
+        if (frameworkState) {
+            // eslint-disable-next-line deprecation/deprecation
+            return frameworkState.sessionState.defaultViewState;
+        }
+        return useGlobalStore.getState().viewState;
     }
     static getIsUiVisible() {
         return UiFramework.visibility.isUiVisible;
@@ -457,129 +401,14 @@ export class UiFramework {
             UiFramework.onUiVisibilityChanged.emit({ visible });
         }
     }
-    /**
-     * Set the theme value used by the [[ThemeManager]] component.
-     */
-    static setColorTheme(theme) {
-        if (UiFramework.getColorTheme() === theme)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetTheme, theme, true);
-    }
-    static getColorTheme() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.theme
-            : SYSTEM_PREFERRED_COLOR_THEME;
-    }
-    /** UiFramework.setToolbarOpacity() sets the non-hovered opacity to the value specified.
-     * @param opacity a value between 0 and 1. The default value is 0.5. IT IS NOT ADVISED TO USE A VALUE BELOW 0.2
-     * @public
-     */
-    static setToolbarOpacity(opacity) {
-        if (UiFramework.getToolbarOpacity() === opacity)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetToolbarOpacity, opacity, true);
-    }
-    /** UiFramework.getToolbarOpacity() returns a number between 0 and 1 that is the non-hovered opacity for toolbars.
-     * @public
-     */
-    static getToolbarOpacity() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.toolbarOpacity
-            : TOOLBAR_OPACITY_DEFAULT;
-    }
-    static setWidgetOpacity(opacity) {
-        if (UiFramework.getWidgetOpacity() === opacity)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetWidgetOpacity, opacity, true);
-    }
-    static getWidgetOpacity() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.widgetOpacity
-            : WIDGET_OPACITY_DEFAULT;
-    }
-    /** @deprecated in 4.13.x. Use {@link @itwin/core-bentley#ProcessDetector.isMobileBrowser} instead. */
+    /** @deprecated in 4.13.0. Use {@link @itwin/core-bentley#ProcessDetector.isMobileBrowser} instead. */
     // eslint-disable-next-line @itwin/prefer-get
     static isMobile() {
         return ProcessDetector.isMobileBrowser;
     }
-    static get showWidgetIcon() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.showWidgetIcon
-            : false;
-    }
-    static setShowWidgetIcon(value) {
-        if (UiFramework.showWidgetIcon === value)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetShowWidgetIcon, value, true);
-    }
-    /** Animate Tool Settings on appear  */
-    static get animateToolSettings() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.animateToolSettings
-            : false;
-    }
-    static setAnimateToolSettings(value) {
-        if (UiFramework.animateToolSettings === value)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.AnimateToolSettings, value, true);
-    }
-    /** Use Tool Name As Tool Settings Widget Tab Label */
-    static get useToolAsToolSettingsLabel() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState
-                .useToolAsToolSettingsLabel
-            : false;
-    }
-    static setUseToolAsToolSettingsLabel(value) {
-        if (UiFramework.useToolAsToolSettingsLabel === value)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.UseToolAsToolSettingsLabel, value, true);
-    }
-    /** When `true`, panels will close as soon as the mouse leave the panel.
-     * When `false` (default), panels will close on next click outside the panel.
-     * @public */
-    static get autoCollapseUnpinnedPanels() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState
-                .autoCollapseUnpinnedPanels
-            : false;
-    }
-    /** Method used to enable the automatic closing of an unpinned widget panel as soon as the
-     * mouse leaves the widget panel. The default behavior is to require a mouse click outside
-     * the panel before it is closed.
-     * @public */
-    static setAutoCollapseUnpinnedPanels(value) {
-        if (UiFramework.autoCollapseUnpinnedPanels === value)
-            return;
-        UiFramework.dispatchActionToStore(ConfigurableUiActionId.AutoCollapseUnpinnedPanels, value, true);
-    }
-    static get useDragInteraction() {
-        return UiFramework.frameworkState
-            ? UiFramework.frameworkState.configurableUiState.useDragInteraction
-            : false;
-    }
-    static setUseDragInteraction(useDragInteraction) {
-        UiFramework.dispatchActionToStore(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
-            : 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(ConfigurableUiActionId.SetViewOverlayDisplay, display);
-    }
     /** Determines whether a ContextMenu is open
      * @alpha
-     * */
+     */
     static get isContextMenuOpen() {
         const contextMenu = document.querySelector("div.core-context-menu-opened");
         return contextMenu !== null && contextMenu !== undefined;
@@ -788,6 +617,7 @@ export class UiFramework {
      * @internal
      */
     static openDialog(uiDataProvider, title, isModal, id, optionalProps) {
+        // eslint-disable-next-line deprecation/deprecation
         const dialog = createElement(UiDataProvidedDialog, {
             uiDataProvider,
             title,
@@ -831,6 +661,302 @@ export class UiFramework {
         const el = htmlElement ?? UiFramework.controls.getWrapperElement();
         return el;
     }
+    /* eslint-disable deprecation/deprecation */
+    /** @deprecated in 4.15.0. Use your preferred state management library instead and {@link SyncUiEventDispatcher} to dispatch sync UI events. */
+    static dispatchActionToStore(type, payload, immediateSync = false) {
+        const reduxStore = UiFramework.reduxStore;
+        const reduxState = reduxStore?.getState();
+        const frameworkState = reduxState?.[UiFramework.frameworkStateKey];
+        if (!frameworkState)
+            return;
+        reduxStore.dispatch({ type, payload });
+        dispatchSyncUiEvent(type, immediateSync);
+    }
+    /** Key used to access framework state from redux store.
+     * @deprecated in 4.15.0. Use your preferred state management library instead.
+     */
+    static get frameworkStateKey() {
+        return UiFramework._frameworkStateKeyInStore;
+    }
+    /** The Redux store.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use your preferred state management library instead.
+     */
+    static get store() {
+        const reduxStore = this.reduxStore;
+        if (!reduxStore) {
+            throw new UiError(UiFramework.loggerCategory(this), `Error trying to access redux store before either store or StateManager has been initialized.`);
+        }
+        return reduxStore;
+    }
+    /** @internal */
+    static get reduxStore() {
+        if (UiFramework._store) {
+            return UiFramework._store;
+        }
+        if (StateManager.isInitialized(true)) {
+            return StateManager.store;
+        }
+        return undefined;
+    }
+    /** The UiFramework state maintained by Redux.
+     * @note Returned fields should not be modified. Use the appropriate action dispatchers to modify the state.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use your preferred state management library instead.
+     */
+    static get frameworkState() {
+        const store = UiFramework.reduxStore;
+        const state = store?.getState();
+        const frameworkState = state?.[UiFramework.frameworkStateKey];
+        return frameworkState;
+    }
+    /** Set the theme value used by the [[ThemeManager]] component.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `theme` as a prop.
+     */
+    static getColorTheme() {
+        return (UiFramework.frameworkState?.configurableUiState.theme ??
+            SYSTEM_PREFERRED_COLOR_THEME);
+    }
+    /** Set the theme value used by the [[ThemeManager]] component.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use `theme` prop of {@link ThemeManager}.
+     */
+    static setColorTheme(theme) {
+        if (UiFramework.getColorTheme() === theme)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetTheme, theme, true);
+    }
+    /** Returns the variable controlling whether the overlay is displayed in a Viewport.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `viewOverlay` as a prop.
+     */
+    static get viewOverlayDisplay() {
+        return (UiFramework.frameworkState?.configurableUiState.viewOverlayDisplay ?? true);
+    }
+    /** Set the variable that controls display of the view overlay. Applies to all viewports in the app.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.viewOverlay} prop of {@link ConfigurableUiContent}.
+     */
+    static setViewOverlayDisplay(display) {
+        if (UiFramework.viewOverlayDisplay === display)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetViewOverlayDisplay, display);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `widgetOpacity` as a prop.
+     */
+    static getWidgetOpacity() {
+        return (UiFramework.frameworkState?.configurableUiState.widgetOpacity ??
+            WIDGET_OPACITY_DEFAULT);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.widgetOpacity} prop of {@link ConfigurableUiContent}.
+     */
+    static setWidgetOpacity(opacity) {
+        if (UiFramework.getWidgetOpacity() === opacity)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetWidgetOpacity, opacity, true);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `snapMode` as a prop.
+     */
+    static getAccudrawSnapMode() {
+        return (UiFramework.frameworkState?.configurableUiState.snapMode ??
+            SnapMode.NearestKeypoint);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use `snapMode` prop of {@link SnapModeField}.
+     */
+    static setAccudrawSnapMode(snapMode) {
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetSnapMode, snapMode, true);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `useDragInteraction` as a prop.
+     */
+    static get useDragInteraction() {
+        return (UiFramework.frameworkState?.configurableUiState.useDragInteraction ??
+            false);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use `useDragInteraction` prop of {@link Toolbar}.
+     */
+    static setUseDragInteraction(useDragInteraction) {
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetDragInteraction, useDragInteraction, true);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `widgetIcon` as a prop.
+     */
+    static get showWidgetIcon() {
+        return (UiFramework.frameworkState?.configurableUiState.showWidgetIcon ?? false);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.widgetIcon} prop of {@link ConfigurableUiContent}.
+     */
+    static setShowWidgetIcon(value) {
+        if (UiFramework.showWidgetIcon === value)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetShowWidgetIcon, value, true);
+    }
+    /** When `true`, panels will close as soon as the mouse leave the panel.
+     * When `false` (default), panels will close on next click outside the panel.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `collapsePanels` as a prop.
+     */
+    static get autoCollapseUnpinnedPanels() {
+        return (UiFramework.frameworkState?.configurableUiState
+            .autoCollapseUnpinnedPanels ?? false);
+    }
+    /** Method used to enable the automatic closing of an unpinned widget panel as soon as the
+     * mouse leaves the widget panel. The default behavior is to require a mouse click outside
+     * the panel before it is closed.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.collapsePanels} prop of {@link ConfigurableUiContent}.
+     */
+    static setAutoCollapseUnpinnedPanels(value) {
+        if (UiFramework.autoCollapseUnpinnedPanels === value)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.AutoCollapseUnpinnedPanels, value, true);
+    }
+    /** Animate Tool Settings on appear.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `animateToolSettings` as a prop.
+     */
+    static get animateToolSettings() {
+        return (UiFramework.frameworkState?.configurableUiState.animateToolSettings ??
+            false);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.animateToolSettings} prop of {@link ConfigurableUiContent}.
+     */
+    static setAnimateToolSettings(value) {
+        if (UiFramework.animateToolSettings === value)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.AnimateToolSettings, value, true);
+    }
+    /** Use Tool Name As Tool Settings Widget Tab Label.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `toolAsToolSettingsLabel` as a prop.
+     */
+    static get useToolAsToolSettingsLabel() {
+        return (UiFramework.frameworkState?.configurableUiState
+            .useToolAsToolSettingsLabel ?? false);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.toolAsToolSettingsLabel} prop of {@link ConfigurableUiContent}.
+     */
+    static setUseToolAsToolSettingsLabel(value) {
+        if (UiFramework.useToolAsToolSettingsLabel === value)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.UseToolAsToolSettingsLabel, value, true);
+    }
+    /** UiFramework.getToolbarOpacity() returns a number between 0 and 1 that is the non-hovered opacity for toolbars.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `opacity` as a prop.
+     */
+    static getToolbarOpacity() {
+        return (UiFramework.frameworkState?.configurableUiState.toolbarOpacity ??
+            TOOLBAR_OPACITY_DEFAULT);
+    }
+    /** UiFramework.setToolbarOpacity() sets the non-hovered opacity to the value specified.
+     * @param opacity a value between 0 and 1. The default value is 0.5. IT IS NOT ADVISED TO USE A VALUE BELOW 0.2
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use {@link ConfigurableUiContentProps.toolbarOpacity} prop of {@link ConfigurableUiContent}.
+     */
+    static setToolbarOpacity(opacity) {
+        if (UiFramework.getToolbarOpacity() === opacity)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetToolbarOpacity, opacity, true);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Get id from iModel connection.
+     */
+    static getActiveIModelId() {
+        return UiFramework.frameworkState?.sessionState.iModelId ?? "";
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Not used by AppUI components.
+     */
+    static setActiveIModelId(iModelId) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetActiveIModelId, iModelId);
+    }
+    /** Returns the stored active selection scope id.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `activeScope` as a prop.
+     */
+    static getActiveSelectionScope() {
+        return (UiFramework.frameworkState?.sessionState.activeSelectionScope ?? "element");
+    }
+    /** This method stores the active selection scope to the supplied scope id, and triggers
+     * a `SessionStateActionId.SetSelectionScope` event in the `SyncUiEventDispatcher`.
+     * Note: As of 4.0, this method *does not change* the active selection scope in the `Presentation.selection.scopes.activeScope` property.
+     * This event should be listened to and the change should typically be applied to
+     * `Presentation.selection.scopes.activeScope` property from the `@itwin/presentation-frontend` package.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Use `activeScope` prop of {@link SelectionScopeField}.
+     */
+    static setActiveSelectionScope(selectionScopeId) {
+        if (!UiFramework.frameworkState)
+            return;
+        const foundIndex = UiFramework.frameworkState.sessionState.availableSelectionScopes.findIndex((selectionScope) => selectionScope.id === selectionScopeId);
+        if (foundIndex < 0)
+            return;
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, selectionScopeId);
+    }
+    /** Returns the stored list of available selection scopes. This list should be set by the application
+     * by dispatching the `setAvailableSelectionScopes` action.
+     * The value for this action typically come from `Presentation.selection.scopes.getSelectionScopes()`
+     * method found in the `@itwin/presentation-frontend` package.
+     * @note Returned value is immutable.
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Components should take `selectionScopes` as a prop.
+     */
+    static getAvailableSelectionScopes() {
+        return (UiFramework.frameworkState?.sessionState.availableSelectionScopes ?? [
+            { id: "element", label: "Element" },
+        ]);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Not used by AppUI components.
+     */
+    static getDefaultIModelViewportControlId() {
+        return (UiFramework.frameworkState?.sessionState.defaultIModelViewportControlId ??
+            undefined);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Not used by AppUI components.
+     */
+    static setDefaultIModelViewportControlId(iModelViewportControlId, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId, immediateSync);
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Not used by AppUI components.
+     */
+    static getDefaultViewId() {
+        return UiFramework.frameworkState?.sessionState.defaultViewId ?? undefined;
+    }
+    /**
+     * @note Requires redux provider.
+     * @deprecated in 4.15.0. Not used by AppUI components.
+     */
+    static setDefaultViewId(viewId, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultViewId, viewId, immediateSync);
+    }
 }
 UiFramework._initialized = false;
 UiFramework._complaint = "UiFramework not initialized";
@@ -841,9 +967,14 @@ UiFramework._uiSettingsProviderRegistry = new Map();
 UiFramework._childWindowManager = new InternalChildWindowManager();
 UiFramework.useDefaultPopoutUrl = false;
 UiFramework.CONTEXT_MENU_OFFSET = -8;
-/** Get Show Ui event.
- * @public
- */
+/** Get Show Ui event. */
 // eslint-disable-next-line deprecation/deprecation
 UiFramework.onUiVisibilityChanged = new UiVisibilityChangedEvent();
+function dispatchSyncUiEvent(eventId, immediateSync = false) {
+    if (immediateSync) {
+        SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(eventId);
+        return;
+    }
+    SyncUiEventDispatcher.dispatchSyncUiEvent(eventId);
+}
 //# sourceMappingURL=UiFramework.js.map