@itwin/appui-react 4.5.1 → 4.6.1

package/lib/esm/appui-react/widget-panels/Frontstage.js

@@ -10,10 +10,11 @@ import "./Frontstage.scss";
 import produce from "immer";
 import * as React from "react";
 import { unstable_batchedUpdates } from "react-dom";
-import { assert, Logger, ProcessDetector } from "@itwin/core-bentley";
-import { Rectangle, Size, UiStateStorageStatus } from "@itwin/core-react";
+import { Logger, ProcessDetector } from "@itwin/core-bentley";
+import { Rectangle, UiStateStorageStatus } from "@itwin/core-react";
 import { ToolbarPopupAutoHideContext } from "@itwin/components-react";
-import { addDockedToolSettings, addFloatingWidget, addPanelWidget, addTab, addTabToWidget, addWidgetToolSettings, convertAllPopupWidgetContainersToFloating, createLayoutStore, createNineZoneState, floatingWidgetBringToFront, FloatingWidgets, getTabLocation, getUniqueId, getWidgetPanelSectionId, insertPanelWidget, insertTabToWidget, isFloatingTabLocation, isHorizontalPanelSide, isPanelTabLocation, isPopoutTabLocation, NineZone, NineZoneStateReducer, panelSides, removeTab, removeTabFromWidget, removeToolSettings, WidgetPanels, } from "@itwin/appui-layout-react";
+import { addDockedToolSettings, addFloatingWidget, addPanelWidget, addRemovedTab, addTab, addTabToWidget, createLayoutStore, createNineZoneState, floatingWidgetBringToFront, FloatingWidgets, getTabLocation, getUniqueId, getWidgetPanelSectionId, isFloatingTabLocation, isPanelTabLocation, NineZone, NineZoneStateReducer, removeTab, WidgetPanels, } from "@itwin/appui-layout-react";
+import { useActiveFrontstageDef, } from "../frontstage/FrontstageDef";
 import { StagePanelState, toPanelSide } from "../stagepanels/StagePanelDef";
 import { UiFramework } from "../UiFramework";
 import { useUiStateStorageHandler } from "../uistate/useUiStateStorage";
@@ -50,30 +51,19 @@ const widgetContent = React.createElement(WidgetContent, null);
 const toolSettingsContent = React.createElement(ToolSettingsContent, null);
 const widgetPanelsFrontstage = React.createElement(WidgetPanelsFrontstageComponent, null);
 /** @internal */
-export function useLayoutStore() {
-    const [def, setDef] = React.useState(UiFramework.frontstages.activeFrontstageDef);
-    const [layout, setLayout] = React.useState(() => createLayoutStore(def?.nineZoneState));
-    React.useEffect(() => {
-        return UiFramework.frontstages.onFrontstageActivatedEvent.addListener((args) => {
-            unstable_batchedUpdates(() => {
-                setDef(args.activatedFrontstageDef);
-                setLayout(createLayoutStore(args.activatedFrontstageDef.nineZoneState));
-            });
-        });
-    }, []);
+export function useLayoutStore(frontstageDef) {
+    const layoutStore = React.useMemo(() => createLayoutStore(frontstageDef?.nineZoneState), [frontstageDef]);
     React.useEffect(() => {
         return InternalFrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener((args) => {
-            if (args.frontstageDef !== def ||
-                def.isStageClosing ||
-                def.isApplicationClosing)
+            if (args.frontstageDef !== frontstageDef)
                 return;
             unstable_batchedUpdates(() => {
                 // https://github.com/pmndrs/zustand/blob/main/docs/guides/event-handler-in-pre-react-18.md
-                layout.setState(args.state || defaultNineZone);
+                layoutStore.setState(args.state || defaultNineZone);
             });
         });
-    }, [def, layout]);
-    return [layout, def];
+    }, [frontstageDef, layoutStore]);
+    return layoutStore;
 }
 /** Update in-memory NineZoneState of newly activated frontstage with up to date size.
  * @internal
@@ -81,65 +71,30 @@ export function useLayoutStore() {
 export function useUpdateNineZoneSize(frontstageDef) {
     React.useEffect(() => {
         const size = InternalFrontstageManager.nineZoneSize;
-        let state = frontstageDef.nineZoneState;
+        const state = frontstageDef.nineZoneState;
         if (!size || !state)
             return;
-        state = FrameworkStateReducer(state, {
+        frontstageDef.dispatch({
             type: "RESIZE",
             size: {
                 height: size.height,
                 width: size.width,
             },
-        }, frontstageDef);
-        frontstageDef.nineZoneState = state;
-    }, [frontstageDef]);
-}
-/** @internal */
-export function FrameworkStateReducer(state, action, frontstageDef) {
-    state = NineZoneStateReducer(state, action);
-    if (action.type === "RESIZE") {
-        state = produce(state, (draft) => {
-            for (const panelSide of panelSides) {
-                const panel = draft.panels[panelSide];
-                const location = toStagePanelLocation(panelSide);
-                const panelDef = frontstageDef.getStagePanelDef(location);
-                if (panelDef?.maxSizeSpec) {
-                    panel.maxSize = getPanelMaxSize(panelDef.maxSizeSpec, panelSide, action.size);
-                    if (panel.size) {
-                        panel.size = Math.min(Math.max(panel.size, panel.minSize), panel.maxSize);
-                    }
-                }
-            }
         });
-    }
-    return state;
+    }, [frontstageDef]);
 }
 /** @internal */
 export function useNineZoneDispatch(frontstageDef) {
-    const dispatch = React.useCallback((action) => {
-        if (action.type === "RESIZE") {
-            InternalFrontstageManager.nineZoneSize = Size.create(action.size);
-        }
-        if (action.type === "WIDGET_TAB_POPOUT") {
-            const tabId = action.id;
-            frontstageDef.popoutWidget(tabId);
-            return;
-        }
-        const state = frontstageDef.nineZoneState;
-        if (!state)
-            return;
-        frontstageDef.nineZoneState = FrameworkStateReducer(state, action, frontstageDef);
-    }, [frontstageDef]);
-    return dispatch;
+    return React.useMemo(() => frontstageDef.dispatch, [frontstageDef]);
 }
 /** @internal */
 export function WidgetPanelsFrontstage() {
-    const [layout, frontstageDef] = useLayoutStore();
+    const frontstageDef = useActiveFrontstageDef();
+    const layout = useLayoutStore(frontstageDef);
     React.useEffect(() => {
         const triggerWidowCloseProcessing = () => {
             frontstageDef && frontstageDef.setIsApplicationClosing(true);
         };
-        frontstageDef && frontstageDef.setIsApplicationClosing(false);
         window.addEventListener("unload", triggerWidowCloseProcessing);
         return () => {
             window.removeEventListener("unload", triggerWidowCloseProcessing);
@@ -198,16 +153,17 @@ export function useLabels() {
 }
 function toTabArgs(widget) {
     const label = getWidgetLabel(widget.label);
-    return {
+    const args = {
         allowedPanelTargets: widget.allowedPanelTargets?.map((location) => toPanelSide(location)),
         hideWithUiWhenFloating: !!widget.hideWithUiWhenFloating,
         canPopout: widget.canPopout,
         iconSpec: widget.iconSpec,
-        isFloatingStateWindowResizable: widget.isFloatingStateWindowResizable,
+        isFloatingWidgetResizable: widget.isFloatingStateWindowResizable,
         label,
         preferredFloatingWidgetSize: widget.defaultFloatingSize,
         preferredPanelWidgetSize: widget.preferredPanelSize,
     };
+    return args;
 }
 /** @internal */
 export function addWidgets(state, widgets, side, widgetId) {
@@ -255,9 +211,15 @@ export function appendWidgets(state, widgetDefs, location, section) {
             preferredPanelWidgetSize,
             userSized,
         });
-        if (widgetDef.isFloatingStateSupported &&
+        const savedTab = state.savedTabs.byId[widgetDef.id];
+        if (savedTab) {
+            state = addRemovedTab(state, widgetDef.id);
+        }
+        else if (widgetDef.isFloatingStateSupported &&
             widgetDef.defaultState === WidgetState.Floating) {
-            const floatingContainerId = widgetDef.floatingContainerId ?? getUniqueId();
+            const floatingContainerId = widgetDef.floatingContainerId
+                ? widgetDef.floatingContainerId
+                : getUniqueId();
             const widgetContainerId = getWidgetId(location, section);
             const home = {
                 side,
@@ -286,8 +248,6 @@ export function appendWidgets(state, widgetDefs, location, section) {
                     bounds: containedBounds.toProps(),
                     home,
                     userSized,
-                }, {
-                    isFloatingStateWindowResizable: widgetDef.isFloatingStateWindowResizable,
                 });
             }
         }
@@ -311,24 +271,29 @@ export function appendWidgets(state, widgetDefs, location, section) {
                 }
             }
         }
+        if (widgetDef.defaultState === WidgetState.Hidden) {
+            state = NineZoneStateReducer(state, {
+                type: "WIDGET_TAB_HIDE",
+                id: widgetDef.id,
+            });
+        }
     }
     return state;
 }
-function processPopoutWidgets(initialState, frontstageDef) {
-    // istanbul ignore next
-    if (!initialState.popoutWidgets)
-        return initialState;
-    // istanbul ignore next - not unit testing electron case that reopens popout windows
-    if (initialState.popoutWidgets && ProcessDetector.isElectronAppFrontend) {
-        if (initialState.popoutWidgets.allIds.length &&
-            ProcessDetector.isElectronAppFrontend) {
-            for (const widgetContainerId of initialState.popoutWidgets.allIds) {
-                frontstageDef.openPopoutWidgetContainer(initialState, widgetContainerId);
-            }
-        }
-        return initialState;
+function processPopoutWidgets(state) {
+    // Electron reopens popout windows
+    if (ProcessDetector.isElectronAppFrontend) {
+        return state;
     }
-    return convertAllPopupWidgetContainersToFloating(initialState);
+    for (const popoutWidgetId of state.popoutWidgets.allIds) {
+        const widget = state.widgets[popoutWidgetId];
+        const id = widget.tabs[0];
+        state = NineZoneStateReducer(state, {
+            type: "WIDGET_TAB_FLOAT",
+            id,
+        });
+    }
+    return state;
 }
 /** Adds frontstageDef widgets that are missing in NineZoneState.
  * @internal
@@ -367,7 +332,10 @@ function hideWidgets(state, frontstageDef) {
         if (!widgetDef)
             continue;
         if (widgetDef.defaultState === WidgetState.Hidden) {
-            state = hideWidget(state, widgetDef);
+            state = NineZoneStateReducer(state, {
+                type: "WIDGET_TAB_HIDE",
+                id: widgetDef.id,
+            });
         }
     }
     return state;
@@ -375,7 +343,7 @@ function hideWidgets(state, frontstageDef) {
 /** Removes NineZoneState widgets that are missing in frontstageDef.
  * @internal
  */
-export function removeMissingWidgets(frontstageDef, state) {
+function removeMissingWidgets(frontstageDef, state) {
     const toolSettingsTabId = state.toolSettings?.tabId;
     for (const [, tab] of Object.entries(state.tabs)) {
         if (tab.id === toolSettingsTabId)
@@ -383,6 +351,10 @@ export function removeMissingWidgets(frontstageDef, state) {
         const widgetDef = frontstageDef.findWidgetDef(tab.id);
         if (widgetDef)
             continue;
+        state = NineZoneStateReducer(state, {
+            type: "WIDGET_TAB_HIDE",
+            id: tab.id,
+        });
         state = removeTab(state, tab.id);
     }
     return state;
@@ -390,18 +362,6 @@ export function removeMissingWidgets(frontstageDef, state) {
 function getWidgetLabel(label) {
     return label === "" ? "Widget" : label;
 }
-function toStagePanelLocation(side) {
-    switch (side) {
-        case "bottom":
-            return StagePanelLocation.Bottom;
-        case "left":
-            return StagePanelLocation.Left;
-        case "right":
-            return StagePanelLocation.Right;
-        case "top":
-            return StagePanelLocation.Top;
-    }
-}
 /** @internal */
 export function getWidgetId(location, section) {
     switch (location) {
@@ -452,36 +412,27 @@ export function isFrontstageStateSettingResult(settingsResult) {
 }
 /** @internal */
 export function initializePanel(state, frontstageDef, location) {
-    const panelSide = toPanelSide(location);
+    const side = toPanelSide(location);
     state = addPanelWidgets(state, frontstageDef, location);
     const panelDef = frontstageDef.getStagePanelDef(location);
     state = produce(state, (draft) => {
-        const panel = draft.panels[panelSide];
-        panel.minSize = panelDef?.minSize ?? panel.minSize;
+        const panel = draft.panels[side];
+        panel.minSize = panelDef?.initialConfig?.minSize ?? panel.minSize;
         panel.pinned = panelDef?.pinned ?? panel.pinned;
         panel.resizable = panelDef?.resizable ?? panel.resizable;
-        if (panelDef?.maxSizeSpec) {
-            panel.maxSize = getPanelMaxSize(panelDef.maxSizeSpec, panelSide, state.size);
-        }
-        const size = panelDef?.size;
-        panel.size =
-            size === undefined
-                ? size
-                : Math.min(Math.max(size, panel.minSize), panel.maxSize);
+        panel.maxSize = panelDef?.initialConfig?.maxSize ?? panel.maxSize;
     });
-    return state;
-}
-function getPanelMaxSize(maxSizeSpec, panel, nineZoneSize) {
-    if (typeof maxSizeSpec === "number") {
-        return maxSizeSpec;
+    if (panelDef?.size !== undefined) {
+        state = NineZoneStateReducer(state, {
+            type: "PANEL_SET_SIZE",
+            side,
+            size: panelDef.size,
+        });
     }
-    const size = isHorizontalPanelSide(panel)
-        ? nineZoneSize.height
-        : nineZoneSize.width;
-    return (maxSizeSpec.percentage / 100) * size;
+    return state;
 }
 /** @internal */
-export const stateVersion = 14; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
+export const stateVersion = 16; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
 /** @internal */
 export function initializeNineZoneState(frontstageDef) {
     let nineZone = defaultNineZone;
@@ -519,7 +470,7 @@ export function initializeNineZoneState(frontstageDef) {
         nineZone = addDockedToolSettings(nineZone, toolSettingsTabId);
     }
     nineZone = hideWidgets(nineZone, frontstageDef);
-    nineZone = processPopoutWidgets(nineZone, frontstageDef);
+    nineZone = processPopoutWidgets(nineZone);
     return nineZone;
 }
 /** Converts from saved NineZoneState to NineZoneState.
@@ -528,23 +479,23 @@ export function initializeNineZoneState(frontstageDef) {
  * @internal
  */
 export function restoreNineZoneState(frontstageDef, saved) {
-    let restored = {
+    let state = {
         ...saved,
         tabs: {},
     };
     for (const [, tab] of Object.entries(saved.tabs)) {
         // Re-add the placeholder tab in order to correctly remove it from the state if WidgetDef is not found.
-        restored = addTab(restored, tab.id);
+        state = addTab(state, tab.id);
         const widgetDef = frontstageDef.findWidgetDef(tab.id);
         if (!widgetDef) {
             Logger.logInfo(UiFramework.loggerCategory(restoreNineZoneState), "WidgetDef is not found for saved tab.", () => ({
                 frontstageId: frontstageDef.id,
                 tabId: tab.id,
             }));
-            restored = removeTab(restored, tab.id);
+            state = removeTab(state, tab.id);
             continue;
         }
-        restored = produce(restored, (draft) => {
+        state = produce(state, (draft) => {
             draft.tabs[tab.id] = {
                 ...tab,
                 ...toTabArgs(widgetDef),
@@ -553,7 +504,7 @@ export function restoreNineZoneState(frontstageDef, saved) {
             };
         });
     }
-    restored = produce(restored, (draft) => {
+    state = produce(state, (draft) => {
         // remove center panel section if one is found in left or right panels
         const oldLeftMiddleIndex = saved.panels.left.widgets.findIndex((value) => value === "leftMiddle");
         // istanbul ignore next
@@ -584,15 +535,18 @@ export function restoreNineZoneState(frontstageDef, saved) {
     if (InternalFrontstageManager.nineZoneSize &&
         (0 !== InternalFrontstageManager.nineZoneSize.height ||
             0 !== InternalFrontstageManager.nineZoneSize.width)) {
-        restored = FrameworkStateReducer(restored, {
+        state = NineZoneStateReducer(state, {
             type: "RESIZE",
             size: {
                 height: InternalFrontstageManager.nineZoneSize.height,
                 width: InternalFrontstageManager.nineZoneSize.width,
             },
-        }, frontstageDef);
+        });
     }
-    return restored;
+    state = addMissingWidgets(frontstageDef, state);
+    state = hideWidgets(state, frontstageDef);
+    state = processPopoutWidgets(state);
+    return state;
 }
 /** Prepares NineZoneState to be saved.
  * @note Removes toolSettings tab.
@@ -615,220 +569,10 @@ export function packNineZoneState(state) {
     });
     return packed;
 }
-// istanbul ignore next
-function packSavedWidgets(frontstageDef) {
-    let savedWidgets = [];
-    for (const widgetDef of frontstageDef.widgetDefs) {
-        const id = widgetDef.id;
-        const initialWidget = {
-            id,
-        };
-        const widget = produce(initialWidget, (draft) => {
-            if (widgetDef.tabLocation) {
-                draft.tabLocation = { ...widgetDef.tabLocation };
-            }
-            if (widgetDef.popoutBounds) {
-                draft.popoutBounds = widgetDef.popoutBounds.toProps();
-            }
-        });
-        if (widget === initialWidget)
-            continue;
-        savedWidgets.push(widget);
-    }
-    // Add previously saved widgets.
-    const prevSavedWidgets = frontstageDef.savedWidgetDefs || [];
-    for (const prevWidget of prevSavedWidgets) {
-        if (savedWidgets.find((w) => w.id === prevWidget.id))
-            continue;
-        savedWidgets.push(prevWidget);
-    }
-    // Limit number of saved widgets.
-    const maxWidgets = 100;
-    if (savedWidgets.length > maxWidgets)
-        savedWidgets = savedWidgets.slice(0, maxWidgets);
-    return savedWidgets;
-}
-// istanbul ignore next
-function restoreSavedWidgets(frontstage) {
-    const savedWidgets = frontstage.savedWidgetDefs || [];
-    for (const savedWidget of savedWidgets) {
-        const widgetId = savedWidget.id;
-        const widgetDef = frontstage.findWidgetDef(widgetId);
-        if (!widgetDef)
-            continue;
-        if (savedWidget.tabLocation) {
-            widgetDef.tabLocation = { ...savedWidget.tabLocation };
-        }
-        if (savedWidget.popoutBounds) {
-            widgetDef.popoutBounds = Rectangle.create(savedWidget.popoutBounds);
-        }
-    }
-}
 /** @internal */
 export function isPanelCollapsed(panelState) {
     return panelState !== StagePanelState.Open;
 }
-function addHiddenWidget(state, widgetDef) {
-    const tabLocation = widgetDef.tabLocation || widgetDef.defaultTabLocation;
-    const tabId = widgetDef.id;
-    const { widgetId, tabIndex } = tabLocation;
-    if (widgetId in state.widgets) {
-        // Add to an existing widget (by widget id).
-        return insertTabToWidget(state, tabId, widgetId, tabIndex);
-    }
-    else if (tabLocation.floatingWidget) {
-        const floatingWidget = tabLocation.floatingWidget;
-        assert(widgetId === floatingWidget.id);
-        // Add to a new floating widget.
-        const nzBounds = Rectangle.createFromSize(state.size);
-        const bounds = Rectangle.create(floatingWidget.bounds).containIn(nzBounds);
-        return addFloatingWidget(state, floatingWidget.id, [tabId], {
-            ...floatingWidget,
-            bounds: bounds.toProps(),
-        });
-    }
-    // Add to a panel section.
-    const panel = state.panels[tabLocation.side];
-    // Add to existing panel section.
-    if (panel.widgets.length >= panel.maxWidgetCount) {
-        const sectionIndex = Math.min(panel.maxWidgetCount - 1, tabLocation.widgetIndex);
-        const sectionId = panel.widgets[sectionIndex];
-        return insertTabToWidget(state, tabId, sectionId, tabLocation.tabIndex);
-    }
-    // Create a new panel section.
-    const newSectionId = getUniqueId();
-    return insertPanelWidget(state, panel.side, newSectionId, [tabId], tabLocation.widgetIndex);
-}
-/** @internal */
-export function setWidgetState(state, widgetDef, widgetState) {
-    if (widgetState === WidgetState.Hidden) {
-        return hideWidget(state, widgetDef);
-    }
-    else if (widgetState === WidgetState.Open) {
-        const id = widgetDef.id;
-        if (widgetDef.isToolSettings) {
-            if (!state.toolSettings && !widgetDef.tabLocation) {
-                state = addDockedToolSettings(state, id);
-            }
-            if (state.toolSettings?.type === "docked")
-                return state;
-        }
-        let location = getTabLocation(state, id);
-        if (!location) {
-            state = addHiddenWidget(state, widgetDef);
-            location = getTabLocation(state, id);
-            if (widgetDef.isToolSettings) {
-                state = addWidgetToolSettings(state, id);
-            }
-        }
-        return produce(state, (draft) => {
-            assert(!!location);
-            const widget = draft.widgets[location.widgetId];
-            widget.minimized = false;
-            widget.activeTabId = id;
-            if (isFloatingTabLocation(location)) {
-                const floatingWidget = draft.floatingWidgets.byId[location.floatingWidgetId];
-                floatingWidget.hidden = false;
-                // istanbul ignore else
-            }
-            else if (isPanelTabLocation(location)) {
-                const panel = draft.panels[location.side];
-                panel.collapsed = false;
-                if (undefined === panel.size || 0 === panel.size) {
-                    // istanbul ignore next
-                    panel.size = panel.minSize ?? 200;
-                }
-            }
-        });
-    }
-    else if (widgetState === WidgetState.Closed) {
-        const id = widgetDef.id;
-        if (widgetDef.isToolSettings && state.toolSettings?.type !== "widget") {
-            return state;
-        }
-        let location = getTabLocation(state, id);
-        if (!location) {
-            state = addHiddenWidget(state, widgetDef);
-            location = getTabLocation(state, id);
-        }
-        // TODO: should change activeTabId of a widget with multiple tabs.
-        return produce(state, (draft) => {
-            assert(!!location);
-            const widget = draft.widgets[location.widgetId];
-            if (isFloatingTabLocation(location)) {
-                if (id === widget.activeTabId) {
-                    widget.minimized = true;
-                }
-            }
-        });
-    }
-    else if (widgetState === WidgetState.Floating) {
-        const id = widgetDef.id;
-        let location = getTabLocation(state, id);
-        if (!location) {
-            state = addHiddenWidget(state, widgetDef);
-            location = getTabLocation(state, id);
-        }
-        assert(!!location);
-        if (isFloatingTabLocation(location))
-            return state;
-        // Widget is not floating.
-        state = removeTabFromWidget(state, id);
-        const bounds = widgetDef.tabLocation?.floatingWidget?.bounds;
-        state = addFloatingWidget(state, getUniqueId(), [id], { bounds });
-        if (widgetDef.isToolSettings) {
-            if (state.toolSettings?.type === "docked") {
-                state = removeToolSettings(state);
-            }
-            if (!state.toolSettings) {
-                state = addWidgetToolSettings(state, id);
-            }
-        }
-    }
-    return state;
-}
-/** Stores widget location and hides it in the UI. */
-function hideWidget(state, widgetDef) {
-    const toolSettingsTabId = state.toolSettings?.tabId;
-    if (widgetDef.id === toolSettingsTabId) {
-        widgetDef.tabLocation = undefined;
-        state = produce(state, (draft) => {
-            draft.toolSettings = undefined;
-        });
-        if (state.toolSettings?.type === "docked")
-            return state;
-    }
-    const location = getTabLocation(state, widgetDef.id);
-    if (!location)
-        return state;
-    // istanbul ignore else
-    if (isFloatingTabLocation(location)) {
-        const floatingWidget = state.floatingWidgets.byId[location.widgetId];
-        widgetDef.setFloatingContainerId(location.floatingWidgetId);
-        widgetDef.tabLocation = {
-            side: floatingWidget.home.side,
-            tabIndex: floatingWidget.home.widgetIndex,
-            widgetId: floatingWidget.id,
-            widgetIndex: floatingWidget.home.widgetIndex,
-            floatingWidget,
-        };
-    }
-    else if (!isPopoutTabLocation(location)) {
-        const widgetId = location.widgetId;
-        const side = isPanelTabLocation(location) ? location.side : "left";
-        const widgetIndex = isPanelTabLocation(location)
-            ? state.panels[side].widgets.indexOf(widgetId)
-            : 0;
-        const tabIndex = state.widgets[location.widgetId].tabs.indexOf(widgetDef.id);
-        widgetDef.tabLocation = {
-            side,
-            tabIndex,
-            widgetId,
-            widgetIndex,
-        };
-    }
-    return removeTabFromWidget(state, widgetDef.id);
-}
 /** @internal */
 export function showWidget(state, id) {
     const location = getTabLocation(state, id);
@@ -866,15 +610,6 @@ export function expandWidget(state, id) {
     });
 }
 /** @internal */
-export function setWidgetLabel(state, id, label) {
-    if (!(id in state.tabs))
-        return state;
-    return produce(state, (draft) => {
-        const tab = draft.tabs[id];
-        tab.label = label;
-    });
-}
-/** @internal */
 export function useSavedFrontstageState(frontstageDef) {
     const uiStateStorage = useUiStateStorageHandler();
     const uiStateStorageRef = React.useRef(uiStateStorage);
@@ -891,7 +626,7 @@ export function useSavedFrontstageState(frontstageDef) {
     React.useEffect(() => {
         async function fetchFrontstageState() {
             if (frontstageDef.nineZoneState) {
-                frontstageDef.nineZoneState = processPopoutWidgets(frontstageDef.nineZoneState, frontstageDef);
+                frontstageDef.nineZoneState = processPopoutWidgets(frontstageDef.nineZoneState);
                 return;
             }
             const id = frontstageDef.id;
@@ -903,13 +638,7 @@ export function useSavedFrontstageState(frontstageDef) {
                 const setting = settingResult.setting;
                 if (setting.version === version &&
                     setting.stateVersion === stateVersion) {
-                    const restored = restoreNineZoneState(frontstageDef, setting.nineZone);
-                    frontstageDef.savedWidgetDefs = setting.widgets;
-                    restoreSavedWidgets(frontstageDef);
-                    let state = addMissingWidgets(frontstageDef, restored);
-                    state = hideWidgets(state, frontstageDef);
-                    state = processPopoutWidgets(state, frontstageDef);
-                    frontstageDef.nineZoneState = state;
+                    frontstageDef.nineZoneState = restoreNineZoneState(frontstageDef, setting.nineZone);
                     return;
                 }
             }
@@ -924,14 +653,11 @@ export function useSaveFrontstageSettings(frontstageDef, store) {
     const saveSetting = React.useMemo(() => {
         const debounced = debounce(async (frontstage, state) => {
             const id = frontstage.id;
-            const widgets = packSavedWidgets(frontstage);
-            frontstage.savedWidgetDefs = widgets;
             const setting = {
                 id,
                 version: frontstage.version,
                 stateVersion,
                 nineZone: packNineZoneState(state),
-                widgets,
             };
             await uiSettingsStorage.saveSetting(FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(id), setting);
         }, 1000);
@@ -979,49 +705,11 @@ function debounce(func, duration) {
     };
     return debounced;
 }
-const createListener = (frontstageDef, listener) => {
-    return (...args) => {
-        if (!frontstageDef.nineZoneState)
-            return;
-        listener(...args);
-    };
-};
 /** @internal */
 export function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel) {
-    React.useEffect(() => {
-        return UiFramework.frontstages.onWidgetStateChangedEvent.addListener(({ widgetDef, widgetState }) => {
-            if (!frontstageDef.nineZoneState)
-                return;
-            frontstageDef.nineZoneState = setWidgetState(frontstageDef.nineZoneState, widgetDef, widgetState);
-        });
-    }, [frontstageDef]);
-    React.useEffect(() => {
-        const listener = createListener(frontstageDef, ({ widgetDef }) => {
-            assert(!!frontstageDef.nineZoneState);
-            const nineZoneState = setWidgetState(frontstageDef.nineZoneState, widgetDef, WidgetState.Open);
-            frontstageDef.nineZoneState = showWidget(nineZoneState, widgetDef.id);
-        });
-        InternalFrontstageManager.onWidgetShowEvent.addListener(listener);
-        return () => {
-            InternalFrontstageManager.onWidgetShowEvent.removeListener(listener);
-        };
-    }, [frontstageDef]);
-    React.useEffect(() => {
-        const listener = createListener(frontstageDef, ({ widgetDef }) => {
-            assert(!!frontstageDef.nineZoneState);
-            let nineZoneState = setWidgetState(frontstageDef.nineZoneState, widgetDef, WidgetState.Open);
-            nineZoneState = showWidget(nineZoneState, widgetDef.id);
-            nineZoneState = expandWidget(nineZoneState, widgetDef.id);
-            frontstageDef.nineZoneState = nineZoneState;
-        });
-        InternalFrontstageManager.onWidgetExpandEvent.addListener(listener);
-        return () => {
-            InternalFrontstageManager.onWidgetExpandEvent.removeListener(listener);
-        };
-    }, [frontstageDef]);
     const uiSettingsStorage = useUiStateStorageHandler();
     React.useEffect(() => {
-        const listener = (args) => {
+        return InternalFrontstageManager.onFrontstageRestoreLayoutEvent.addListener((args) => {
             // TODO: track restoring frontstages to support workflows:  i.e. prevent loading frontstage OR saving layout when delete is pending
             void uiSettingsStorage.deleteSetting(FRONTSTAGE_SETTINGS_NAMESPACE, getFrontstageStateSettingName(args.frontstageDef.id));
             if (frontstageDef.id === args.frontstageDef.id) {
@@ -1031,52 +719,36 @@ export function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel)
             else {
                 args.frontstageDef.nineZoneState = undefined;
             }
-        };
-        InternalFrontstageManager.onFrontstageRestoreLayoutEvent.addListener(listener);
-        return () => {
-            InternalFrontstageManager.onFrontstageRestoreLayoutEvent.removeListener(listener);
-        };
-    }, [uiSettingsStorage, frontstageDef]);
-    React.useEffect(() => {
-        const listener = createListener(frontstageDef, ({ widgetDef }) => {
-            assert(!!frontstageDef.nineZoneState);
-            const label = widgetDef.label;
-            frontstageDef.nineZoneState = setWidgetLabel(frontstageDef.nineZoneState, widgetDef.id, label);
         });
-        InternalFrontstageManager.onWidgetLabelChangedEvent.addListener(listener);
-        return () => {
-            InternalFrontstageManager.onWidgetLabelChangedEvent.removeListener(listener);
-        };
-    }, [frontstageDef]);
+    }, [uiSettingsStorage, frontstageDef]);
     const defaultLabel = React.useMemo(() => UiFramework.translate("widget.labels.toolSettings"), []);
     React.useEffect(() => {
-        const updateLabel = createListener(frontstageDef, () => {
+        const updateLabel = () => {
+            const state = frontstageDef.nineZoneState;
+            if (!state)
+                return;
+            const toolSettingsTabId = state.toolSettings?.tabId;
+            if (!toolSettingsTabId)
+                return;
             const toolId = UiFramework.frontstages.activeToolId;
-            assert(!!frontstageDef.nineZoneState);
             const label = useToolAsToolSettingsLabel
                 ? IModelApp.tools.find(toolId)?.flyover || defaultLabel
                 : defaultLabel;
-            const toolSettingsTabId = frontstageDef.nineZoneState.toolSettings?.tabId;
-            if (!toolSettingsTabId)
-                return;
-            frontstageDef.nineZoneState = setWidgetLabel(frontstageDef.nineZoneState, toolSettingsTabId, label);
-        });
+            frontstageDef.dispatch({
+                type: "WIDGET_TAB_SET_LABEL",
+                id: toolSettingsTabId,
+                label,
+            });
+        };
         // Whenever the frontstageDef or the useTool... changes, keep the label up to date.
         updateLabel();
+        const removeListenerFuncs = [];
         // If useTool... is true, listen for events to keep up the label up to date.
         if (useToolAsToolSettingsLabel) {
-            UiFramework.frontstages.onFrontstageReadyEvent.addListener(updateLabel);
-            InternalFrontstageManager.onFrontstageRestoreLayoutEvent.addListener(updateLabel);
-            UiFramework.frontstages.onToolActivatedEvent.addListener(updateLabel);
-            UiFramework.frontstages.onToolSettingsReloadEvent.addListener(updateLabel);
+            removeListenerFuncs.push(UiFramework.frontstages.onFrontstageReadyEvent.addListener(updateLabel), InternalFrontstageManager.onFrontstageRestoreLayoutEvent.addListener(updateLabel), UiFramework.frontstages.onToolActivatedEvent.addListener(updateLabel), UiFramework.frontstages.onToolSettingsReloadEvent.addListener(updateLabel));
         }
         return () => {
-            if (useToolAsToolSettingsLabel) {
-                UiFramework.frontstages.onFrontstageReadyEvent.removeListener(updateLabel);
-                InternalFrontstageManager.onFrontstageRestoreLayoutEvent.removeListener(updateLabel);
-                UiFramework.frontstages.onToolActivatedEvent.removeListener(updateLabel);
-                UiFramework.frontstages.onToolSettingsReloadEvent.removeListener(updateLabel);
-            }
+            removeListenerFuncs.forEach((removeListener) => removeListener());
         };
     }, [frontstageDef, useToolAsToolSettingsLabel, defaultLabel]);
 }
@@ -1086,23 +758,22 @@ export function useItemsManager(frontstageDef) {
     const refreshNineZoneState = (def) => {
         // Fired for both registered/unregistered. Update definitions and remove/add missing widgets.
         def.updateWidgetDefs();
-        restoreSavedWidgets(def);
         let state = def.nineZoneState;
         if (!state)
             return;
         state = addMissingWidgets(def, state);
         state = removeMissingWidgets(def, state);
-        state = hideWidgets(state, def); // TODO: should only apply to widgets provided by registered provider in onUiProviderRegisteredEvent.
         def.nineZoneState = state;
     };
     React.useEffect(() => {
-        const remove = UiItemsManager.onUiProviderRegisteredEvent.addListener(() => {
-            refreshNineZoneState(frontstageDef);
-        });
         // Need to refresh anytime frontstageDef changes because uiItemsProvider may have added something to
         // another stage before it was possibly unloaded in this stage.
         refreshNineZoneState(frontstageDef);
-        return remove;
+    }, [frontstageDef]);
+    React.useEffect(() => {
+        return UiItemsManager.onUiProviderRegisteredEvent.addListener(() => {
+            refreshNineZoneState(frontstageDef);
+        });
     }, [frontstageDef]);
 }
 // istanbul ignore next