@itwin/appui-react 4.2.1 → 4.3.0

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

@@ -7,7 +7,7 @@
  * @module Frontstage
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useItemsManager = exports.useFrontstageManager = exports.getFrontstageStateSettingName = exports.FRONTSTAGE_SETTINGS_NAMESPACE = exports.useSaveFrontstageSettings = exports.useSavedFrontstageState = exports.setWidgetLabel = exports.expandWidget = exports.showWidget = exports.setWidgetState = exports.isPanelCollapsed = exports.packNineZoneState = exports.restoreNineZoneState = exports.initializeNineZoneState = exports.initializePanel = exports.isFrontstageStateSettingResult = exports.addPanelWidgets = exports.getPanelSectionWidgets = exports.getWidgetId = exports.removeMissingWidgets = exports.addMissingWidgets = exports.appendWidgets = exports.addWidgets = exports.useLabels = exports.ActiveFrontstageDefProvider = exports.WidgetPanelsFrontstage = exports.useNineZoneDispatch = exports.FrameworkStateReducer = exports.useUpdateNineZoneSize = exports.useLayoutStore = void 0;
+exports.useItemsManager = exports.useFrontstageManager = exports.getFrontstageStateSettingName = exports.FRONTSTAGE_SETTINGS_NAMESPACE = exports.useSaveFrontstageSettings = exports.useSavedFrontstageState = exports.setWidgetLabel = exports.expandWidget = exports.showWidget = exports.setWidgetState = exports.isPanelCollapsed = exports.packNineZoneState = exports.restoreNineZoneState = exports.initializeNineZoneState = exports.stateVersion = exports.initializePanel = exports.isFrontstageStateSettingResult = exports.addPanelWidgets = exports.getPanelSectionWidgets = exports.getWidgetId = exports.removeMissingWidgets = exports.addMissingWidgets = exports.appendWidgets = exports.addWidgets = exports.useLabels = exports.ActiveFrontstageDefProvider = exports.WidgetPanelsFrontstage = exports.useNineZoneDispatch = exports.FrameworkStateReducer = exports.useUpdateNineZoneSize = exports.useLayoutStore = void 0;
 // cSpell:ignore popout
 require("./Frontstage.scss");
 const immer_1 = require("immer");
@@ -126,14 +126,6 @@ function useNineZoneDispatch(frontstageDef) {
         if (action.type === "RESIZE") {
             InternalFrontstageManager_1.InternalFrontstageManager.nineZoneSize = core_react_1.Size.create(action.size);
         }
-        // istanbul ignore if
-        if (action.type === "TOOL_SETTINGS_DRAG_START") {
-            void UiFramework_1.UiFramework.postTelemetry("Tool Settings Undocking", "28B04E07-AE73-4533-A0BA-8E2A8DC99ADF");
-        }
-        // istanbul ignore if
-        if (action.type === "TOOL_SETTINGS_DOCK") {
-            void UiFramework_1.UiFramework.postTelemetry("Tool Settings Docking to Settings Bar", "BEDE684B-B3DB-4637-B3AF-DC3CBA223F94");
-        }
         if (action.type === "WIDGET_TAB_POPOUT") {
             const tabId = action.id;
             frontstageDef.popoutWidget(tabId);
@@ -214,25 +206,28 @@ function useLabels() {
     }), []);
 }
 exports.useLabels = useLabels;
+function toTabArgs(widget) {
+    var _a;
+    const label = getWidgetLabel(widget.label);
+    return {
+        allowedPanelTargets: (_a = widget.allowedPanelTargets) === null || _a === void 0 ? void 0 : _a.map((location) => (0, StagePanelDef_1.toPanelSide)(location)),
+        hideWithUiWhenFloating: !!widget.hideWithUiWhenFloating,
+        canPopout: widget.canPopout,
+        iconSpec: widget.iconSpec,
+        isFloatingStateWindowResizable: widget.isFloatingStateWindowResizable,
+        label,
+        preferredFloatingWidgetSize: widget.defaultFloatingSize,
+        preferredPanelWidgetSize: widget.preferredPanelSize,
+    };
+}
 /** @internal */
 function addWidgets(state, widgets, side, widgetId) {
-    var _a;
     const visibleWidgets = widgets.filter((w) => w.isVisible && w.defaultState !== WidgetState_1.WidgetState.Floating);
     if (visibleWidgets.length === 0)
         return state;
     const tabs = new Array();
     for (const widget of visibleWidgets) {
-        const label = getWidgetLabel(widget.label);
-        state = (0, appui_layout_react_1.addTab)(state, widget.id, {
-            label,
-            iconSpec: widget.iconSpec,
-            preferredPanelWidgetSize: widget.preferredPanelSize,
-            preferredFloatingWidgetSize: widget.defaultFloatingSize,
-            canPopout: widget.canPopout,
-            isFloatingStateWindowResizable: widget.isFloatingStateWindowResizable,
-            hideWithUiWhenFloating: !!widget.hideWithUiWhenFloating,
-            allowedPanelTargets: (_a = widget.allowedPanelTargets) === null || _a === void 0 ? void 0 : _a.map((location) => (0, StagePanelDef_1.toPanelSide)(location)),
-        });
+        state = (0, appui_layout_react_1.addTab)(state, widget.id, toTabArgs(widget));
         tabs.push(widget.id);
     }
     const activeWidget = visibleWidgets.find((widget) => widget.isActive);
@@ -250,13 +245,10 @@ exports.addWidgets = addWidgets;
 /** @internal */
 // istanbul ignore next
 function appendWidgets(state, widgetDefs, location, section) {
-    var _a, _b;
-    if (widgetDefs.length === 0)
-        return state;
+    var _a;
     const side = (0, StagePanelDef_1.toPanelSide)(location);
     // Add missing widget tabs.
     for (const widgetDef of widgetDefs) {
-        const label = getWidgetLabel(widgetDef.label);
         const saveTab = state.tabs[widgetDef.id];
         const preferredPanelWidgetSize = saveTab
             ? saveTab.preferredPanelWidgetSize
@@ -271,19 +263,14 @@ function appendWidgets(state, widgetDefs, location, section) {
                     !!saveTab.preferredFloatingWidgetSize)
             : !!widgetDef.defaultFloatingSize;
         state = (0, appui_layout_react_1.addTab)(state, widgetDef.id, {
-            label,
-            iconSpec: widgetDef.iconSpec,
-            canPopout: widgetDef.canPopout,
-            preferredPanelWidgetSize,
+            ...toTabArgs(widgetDef),
             preferredFloatingWidgetSize,
+            preferredPanelWidgetSize,
             userSized,
-            isFloatingStateWindowResizable: widgetDef.isFloatingStateWindowResizable,
-            hideWithUiWhenFloating: !!widgetDef.hideWithUiWhenFloating,
-            allowedPanelTargets: (_a = widgetDef.allowedPanelTargets) === null || _a === void 0 ? void 0 : _a.map((l) => (0, StagePanelDef_1.toPanelSide)(l)),
         });
         if (widgetDef.isFloatingStateSupported &&
             widgetDef.defaultState === WidgetState_1.WidgetState.Floating) {
-            const floatingContainerId = (_b = widgetDef.floatingContainerId) !== null && _b !== void 0 ? _b : (0, appui_layout_react_1.getUniqueId)();
+            const floatingContainerId = (_a = widgetDef.floatingContainerId) !== null && _a !== void 0 ? _a : (0, appui_layout_react_1.getUniqueId)();
             const widgetContainerId = getWidgetId(location, section);
             const home = {
                 side,
@@ -371,6 +358,12 @@ function addMissingWidgets(frontstageDef, initialState) {
     state = appendWidgets(state, determineNewWidgets((_f = frontstageDef.topPanel) === null || _f === void 0 ? void 0 : _f.getPanelSectionDef(StagePanelSection_1.StagePanelSection.End).widgetDefs, state), StagePanelLocation_1.StagePanelLocation.Top, StagePanelSection_1.StagePanelSection.End);
     state = appendWidgets(state, determineNewWidgets((_g = frontstageDef.bottomPanel) === null || _g === void 0 ? void 0 : _g.getPanelSectionDef(StagePanelSection_1.StagePanelSection.Start).widgetDefs, state), StagePanelLocation_1.StagePanelLocation.Bottom, StagePanelSection_1.StagePanelSection.Start);
     state = appendWidgets(state, determineNewWidgets((_h = frontstageDef.bottomPanel) === null || _h === void 0 ? void 0 : _h.getPanelSectionDef(StagePanelSection_1.StagePanelSection.End).widgetDefs, state), StagePanelLocation_1.StagePanelLocation.Bottom, StagePanelSection_1.StagePanelSection.End);
+    if (frontstageDef.toolSettings) {
+        const newToolSettingsWidgets = determineNewWidgets([frontstageDef.toolSettings], state);
+        for (const newToolSettingsWidget of newToolSettingsWidgets) {
+            state = (0, appui_layout_react_1.addTab)(state, newToolSettingsWidget.id, toTabArgs(newToolSettingsWidget));
+        }
+    }
     return state;
 }
 exports.addMissingWidgets = addMissingWidgets;
@@ -390,10 +383,11 @@ function hideWidgets(state, frontstageDef) {
 /** Removes NineZoneState widgets that are missing in frontstageDef.
  * @internal
  */
-function removeMissingWidgets(frontstageDef, initialState) {
-    let state = initialState;
+function removeMissingWidgets(frontstageDef, state) {
+    var _a;
+    const toolSettingsTabId = (_a = state.toolSettings) === null || _a === void 0 ? void 0 : _a.tabId;
     for (const [, tab] of Object.entries(state.tabs)) {
-        if (tab.id === appui_layout_react_1.toolSettingsTabId)
+        if (tab.id === toolSettingsTabId)
             continue;
         const widgetDef = frontstageDef.findWidgetDef(tab.id);
         if (widgetDef)
@@ -502,7 +496,8 @@ function getPanelMaxSize(maxSizeSpec, panel, nineZoneSize) {
         : nineZoneSize.width;
     return (maxSizeSpec.percentage / 100) * size;
 }
-const stateVersion = 13; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
+/** @internal */
+exports.stateVersion = 14; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
 /** @internal */
 function initializeNineZoneState(frontstageDef) {
     let nineZone = defaultNineZone;
@@ -519,30 +514,27 @@ function initializeNineZoneState(frontstageDef) {
     nineZone = initializePanel(nineZone, frontstageDef, StagePanelLocation_1.StagePanelLocation.Right);
     nineZone = initializePanel(nineZone, frontstageDef, StagePanelLocation_1.StagePanelLocation.Top);
     nineZone = initializePanel(nineZone, frontstageDef, StagePanelLocation_1.StagePanelLocation.Bottom);
-    nineZone = (0, immer_1.default)(nineZone, (stateDraft) => {
+    nineZone = (0, immer_1.default)(nineZone, (draft) => {
         var _a, _b, _c, _d;
-        for (const [, panel] of Object.entries(stateDraft.panels)) {
-            const expanded = panel.widgets.find((widgetId) => stateDraft.widgets[widgetId].minimized === false);
-            const firstWidget = panel.widgets.length > 0
-                ? stateDraft.widgets[panel.widgets[0]]
-                : undefined;
+        for (const [, panel] of Object.entries(draft.panels)) {
+            const expanded = panel.widgets.find((widgetId) => draft.widgets[widgetId].minimized === false);
+            const firstWidget = panel.widgets.length > 0 ? draft.widgets[panel.widgets[0]] : undefined;
             // istanbul ignore next
             if (!expanded && firstWidget) {
                 firstWidget.minimized = false;
             }
         }
-        stateDraft.panels.left.collapsed = isPanelCollapsed((_a = frontstageDef.leftPanel) === null || _a === void 0 ? void 0 : _a.panelState);
-        stateDraft.panels.right.collapsed = isPanelCollapsed((_b = frontstageDef.rightPanel) === null || _b === void 0 ? void 0 : _b.panelState);
-        stateDraft.panels.top.collapsed = isPanelCollapsed((_c = frontstageDef.topPanel) === null || _c === void 0 ? void 0 : _c.panelState);
-        stateDraft.panels.bottom.collapsed = isPanelCollapsed((_d = frontstageDef.bottomPanel) === null || _d === void 0 ? void 0 : _d.panelState);
-        const toolSettingsWidgetDef = frontstageDef.toolSettings;
-        if (toolSettingsWidgetDef) {
-            const toolSettingsTab = stateDraft.tabs[appui_layout_react_1.toolSettingsTabId];
-            toolSettingsTab.preferredPanelWidgetSize =
-                toolSettingsWidgetDef.preferredPanelSize;
-        }
+        draft.panels.left.collapsed = isPanelCollapsed((_a = frontstageDef.leftPanel) === null || _a === void 0 ? void 0 : _a.panelState);
+        draft.panels.right.collapsed = isPanelCollapsed((_b = frontstageDef.rightPanel) === null || _b === void 0 ? void 0 : _b.panelState);
+        draft.panels.top.collapsed = isPanelCollapsed((_c = frontstageDef.topPanel) === null || _c === void 0 ? void 0 : _c.panelState);
+        draft.panels.bottom.collapsed = isPanelCollapsed((_d = frontstageDef.bottomPanel) === null || _d === void 0 ? void 0 : _d.panelState);
     });
     nineZone = addMissingWidgets(frontstageDef, nineZone);
+    const toolSettingsWidgetDef = frontstageDef.toolSettings;
+    if (toolSettingsWidgetDef) {
+        const toolSettingsTabId = toolSettingsWidgetDef.id;
+        nineZone = (0, appui_layout_react_1.addDockedToolSettings)(nineZone, toolSettingsTabId);
+    }
     nineZone = hideWidgets(nineZone, frontstageDef);
     nineZone = processPopoutWidgets(nineZone, frontstageDef);
     return nineZone;
@@ -556,7 +548,7 @@ exports.initializeNineZoneState = initializeNineZoneState;
 function restoreNineZoneState(frontstageDef, saved) {
     let restored = {
         ...saved,
-        tabs: defaultNineZone.tabs,
+        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.
@@ -571,15 +563,11 @@ function restoreNineZoneState(frontstageDef, saved) {
             continue;
         }
         restored = (0, immer_1.default)(restored, (draft) => {
-            var _a;
             draft.tabs[tab.id] = {
                 ...tab,
-                label: getWidgetLabel(widgetDef.label),
-                hideWithUiWhenFloating: widgetDef.hideWithUiWhenFloating,
-                iconSpec: widgetDef.iconSpec,
-                canPopout: widgetDef.canPopout,
-                isFloatingStateWindowResizable: widgetDef.isFloatingStateWindowResizable,
-                allowedPanelTargets: (_a = widgetDef.allowedPanelTargets) === null || _a === void 0 ? void 0 : _a.map((location) => (0, StagePanelDef_1.toPanelSide)(location)),
+                ...toTabArgs(widgetDef),
+                preferredFloatingWidgetSize: tab.preferredFloatingWidgetSize,
+                preferredPanelWidgetSize: tab.preferredPanelWidgetSize,
             };
         });
     }
@@ -637,12 +625,9 @@ function packNineZoneState(state) {
     };
     packed = (0, immer_1.default)(packed, (draft) => {
         for (const [, tab] of Object.entries(state.tabs)) {
-            if (tab.id === appui_layout_react_1.toolSettingsTabId)
-                continue;
             draft.tabs[tab.id] = {
                 id: tab.id,
                 preferredFloatingWidgetSize: tab.preferredFloatingWidgetSize,
-                allowedPanelTargets: tab.allowedPanelTargets,
                 userSized: tab.userSized,
             };
         }
@@ -737,16 +722,26 @@ function addHiddenWidget(state, widgetDef) {
 }
 /** @internal */
 function setWidgetState(state, widgetDef, widgetState) {
-    var _a, _b;
+    var _a, _b, _c, _d, _e;
     if (widgetState === WidgetState_1.WidgetState.Hidden) {
         return hideWidget(state, widgetDef);
     }
     else if (widgetState === WidgetState_1.WidgetState.Open) {
         const id = widgetDef.id;
+        if (widgetDef.isToolSettings) {
+            if (!state.toolSettings && !widgetDef.tabLocation) {
+                state = (0, appui_layout_react_1.addDockedToolSettings)(state, id);
+            }
+            if (((_a = state.toolSettings) === null || _a === void 0 ? void 0 : _a.type) === "docked")
+                return state;
+        }
         let location = (0, appui_layout_react_1.getTabLocation)(state, id);
         if (!location) {
             state = addHiddenWidget(state, widgetDef);
             location = (0, appui_layout_react_1.getTabLocation)(state, id);
+            if (widgetDef.isToolSettings) {
+                state = (0, appui_layout_react_1.addWidgetToolSettings)(state, id);
+            }
         }
         return (0, immer_1.default)(state, (draft) => {
             var _a;
@@ -771,6 +766,9 @@ function setWidgetState(state, widgetDef, widgetState) {
     }
     else if (widgetState === WidgetState_1.WidgetState.Closed) {
         const id = widgetDef.id;
+        if (widgetDef.isToolSettings && ((_b = state.toolSettings) === null || _b === void 0 ? void 0 : _b.type) !== "widget") {
+            return state;
+        }
         let location = (0, appui_layout_react_1.getTabLocation)(state, id);
         if (!location) {
             state = addHiddenWidget(state, widgetDef);
@@ -799,14 +797,32 @@ function setWidgetState(state, widgetDef, widgetState) {
             return state;
         // Widget is not floating.
         state = (0, appui_layout_react_1.removeTabFromWidget)(state, id);
-        const bounds = (_b = (_a = widgetDef.tabLocation) === null || _a === void 0 ? void 0 : _a.floatingWidget) === null || _b === void 0 ? void 0 : _b.bounds;
+        const bounds = (_d = (_c = widgetDef.tabLocation) === null || _c === void 0 ? void 0 : _c.floatingWidget) === null || _d === void 0 ? void 0 : _d.bounds;
         state = (0, appui_layout_react_1.addFloatingWidget)(state, (0, appui_layout_react_1.getUniqueId)(), [id], { bounds });
+        if (widgetDef.isToolSettings) {
+            if (((_e = state.toolSettings) === null || _e === void 0 ? void 0 : _e.type) === "docked") {
+                state = (0, appui_layout_react_1.removeToolSettings)(state);
+            }
+            if (!state.toolSettings) {
+                state = (0, appui_layout_react_1.addWidgetToolSettings)(state, id);
+            }
+        }
     }
     return state;
 }
 exports.setWidgetState = setWidgetState;
 /** Stores widget location and hides it in the UI. */
 function hideWidget(state, widgetDef) {
+    var _a, _b;
+    const toolSettingsTabId = (_a = state.toolSettings) === null || _a === void 0 ? void 0 : _a.tabId;
+    if (widgetDef.id === toolSettingsTabId) {
+        widgetDef.tabLocation = undefined;
+        state = (0, immer_1.default)(state, (draft) => {
+            draft.toolSettings = undefined;
+        });
+        if (((_b = state.toolSettings) === null || _b === void 0 ? void 0 : _b.type) === "docked")
+            return state;
+    }
     const location = (0, appui_layout_react_1.getTabLocation)(state, widgetDef.id);
     if (!location)
         return state;
@@ -913,8 +929,8 @@ function useSavedFrontstageState(frontstageDef) {
                 return;
             if (isFrontstageStateSettingResult(settingResult)) {
                 const setting = settingResult.setting;
-                if (setting.version >= version &&
-                    setting.stateVersion >= stateVersion) {
+                if (setting.version === version &&
+                    setting.stateVersion === exports.stateVersion) {
                     const restored = restoreNineZoneState(frontstageDef, setting.nineZone);
                     frontstageDef.savedWidgetDefs = setting.widgets;
                     restoreSavedWidgets(frontstageDef);
@@ -942,7 +958,7 @@ function useSaveFrontstageSettings(frontstageDef, store) {
             const setting = {
                 id,
                 version: frontstage.version,
-                stateVersion,
+                stateVersion: exports.stateVersion,
                 nineZone: packNineZoneState(state),
                 widgets,
             };
@@ -1004,14 +1020,11 @@ const createListener = (frontstageDef, listener) => {
 /** @internal */
 function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel) {
     React.useEffect(() => {
-        const listener = createListener(frontstageDef, ({ widgetDef, widgetState }) => {
-            (0, core_bentley_1.assert)(!!frontstageDef.nineZoneState);
+        return UiFramework_1.UiFramework.frontstages.onWidgetStateChangedEvent.addListener(({ widgetDef, widgetState }) => {
+            if (!frontstageDef.nineZoneState)
+                return;
             frontstageDef.nineZoneState = setWidgetState(frontstageDef.nineZoneState, widgetDef, widgetState);
         });
-        UiFramework_1.UiFramework.frontstages.onWidgetStateChangedEvent.addListener(listener);
-        return () => {
-            UiFramework_1.UiFramework.frontstages.onWidgetStateChangedEvent.removeListener(listener);
-        };
     }, [frontstageDef]);
     React.useEffect(() => {
         const listener = createListener(frontstageDef, ({ widgetDef }) => {
@@ -1069,13 +1082,16 @@ function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel) {
     const defaultLabel = React.useMemo(() => UiFramework_1.UiFramework.translate("widget.labels.toolSettings"), []);
     React.useEffect(() => {
         const updateLabel = createListener(frontstageDef, () => {
-            var _a;
+            var _a, _b;
             const toolId = UiFramework_1.UiFramework.frontstages.activeToolId;
             (0, core_bentley_1.assert)(!!frontstageDef.nineZoneState);
             const label = useToolAsToolSettingsLabel
                 ? ((_a = core_frontend_1.IModelApp.tools.find(toolId)) === null || _a === void 0 ? void 0 : _a.flyover) || defaultLabel
                 : defaultLabel;
-            frontstageDef.nineZoneState = setWidgetLabel(frontstageDef.nineZoneState, appui_layout_react_1.toolSettingsTabId, label);
+            const toolSettingsTabId = (_b = frontstageDef.nineZoneState.toolSettings) === null || _b === void 0 ? void 0 : _b.tabId;
+            if (!toolSettingsTabId)
+                return;
+            frontstageDef.nineZoneState = setWidgetLabel(frontstageDef.nineZoneState, toolSettingsTabId, label);
         });
         // Whenever the frontstageDef or the useTool... changes, keep the label up to date.
         updateLabel();