@itwin/appui-react 4.1.0 → 4.2.0-dev.1

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

@@ -1,7 +1,7 @@
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
 /** @packageDocumentation
  * @module Frontstage
  */
@@ -19,7 +19,7 @@ import { UiFramework } from "../UiFramework";
 import { useUiStateStorageHandler } from "../uistate/useUiStateStorage";
 import { WidgetContent } from "./Content";
 import { WidgetPanelsFrontstageContent } from "./FrontstageContent";
-import { ModalFrontstageComposer, useActiveModalFrontstageInfo } from "./ModalFrontstageComposer";
+import { ModalFrontstageComposer, useActiveModalFrontstageInfo, } from "./ModalFrontstageComposer";
 import { WidgetPanelsStatusBar } from "./StatusBar";
 import { WidgetPanelsTab } from "./Tab";
 import { WidgetPanelsToolbars } from "./Toolbars";
@@ -63,9 +63,12 @@ export function useLayoutStore() {
     }, []);
     React.useEffect(() => {
         return InternalFrontstageManager.onFrontstageNineZoneStateChangedEvent.addListener((args) => {
-            if (args.frontstageDef !== def || def.isStageClosing || def.isApplicationClosing)
+            if (args.frontstageDef !== def ||
+                def.isStageClosing ||
+                def.isApplicationClosing)
                 return;
             unstable_batchedUpdates(() => {
+                // https://github.com/pmndrs/zustand/blob/main/docs/guides/event-handler-in-pre-react-18.md
                 layout.setState(args.state || defaultNineZone);
             });
         });
@@ -119,13 +122,11 @@ export function useNineZoneDispatch(frontstageDef) {
         }
         // istanbul ignore if
         if (action.type === "TOOL_SETTINGS_DRAG_START") {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            UiFramework.postTelemetry("Tool Settings Undocking", "28B04E07-AE73-4533-A0BA-8E2A8DC99ADF");
+            void UiFramework.postTelemetry("Tool Settings Undocking", "28B04E07-AE73-4533-A0BA-8E2A8DC99ADF");
         }
         // istanbul ignore if
         if (action.type === "TOOL_SETTINGS_DOCK") {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            UiFramework.postTelemetry("Tool Settings Docking to Settings Bar", "BEDE684B-B3DB-4637-B3AF-DC3CBA223F94");
+            void UiFramework.postTelemetry("Tool Settings Docking to Settings Bar", "BEDE684B-B3DB-4637-B3AF-DC3CBA223F94");
         }
         if (action.type === "WIDGET_TAB_POPOUT") {
             const tabId = action.id;
@@ -160,7 +161,7 @@ const defaultNineZone = createNineZoneState();
 const tabElement = React.createElement(WidgetPanelsTab, null);
 const floatingWidgetElement = React.createElement(FloatingWidget, null);
 /** @internal */
-export function ActiveFrontstageDefProvider({ frontstageDef, layout }) {
+export function ActiveFrontstageDefProvider({ frontstageDef, layout, }) {
     const dispatch = useNineZoneDispatch(frontstageDef);
     useUpdateNineZoneSize(frontstageDef);
     useSavedFrontstageState(frontstageDef);
@@ -206,7 +207,7 @@ export function useLabels() {
 /** @internal */
 export function addWidgets(state, widgets, side, widgetId) {
     var _a;
-    const visibleWidgets = widgets.filter((w) => w.isVisible && (w.defaultState !== WidgetState.Floating));
+    const visibleWidgets = widgets.filter((w) => w.isVisible && w.defaultState !== WidgetState.Floating);
     if (visibleWidgets.length === 0)
         return state;
     const tabs = new Array();
@@ -246,10 +247,17 @@ export function appendWidgets(state, widgetDefs, location, section) {
     for (const widgetDef of widgetDefs) {
         const label = getWidgetLabel(widgetDef.label);
         const saveTab = state.tabs[widgetDef.id];
-        const preferredPanelWidgetSize = saveTab ? saveTab.preferredPanelWidgetSize : widgetDef.preferredPanelSize;
-        const preferredFloatingWidgetSize = saveTab ? saveTab.preferredFloatingWidgetSize : widgetDef.defaultFloatingSize;
+        const preferredPanelWidgetSize = saveTab
+            ? saveTab.preferredPanelWidgetSize
+            : widgetDef.preferredPanelSize;
+        const preferredFloatingWidgetSize = saveTab
+            ? saveTab.preferredFloatingWidgetSize
+            : widgetDef.defaultFloatingSize;
         // if a defaultFloatingSize is specified then this mean the widget can't determine its intrinsic size and must be explicitly sized
-        const userSized = saveTab ? (saveTab.userSized || !!widgetDef.defaultFloatingSize && !!saveTab.preferredFloatingWidgetSize)
+        const userSized = saveTab
+            ? saveTab.userSized ||
+                (!!widgetDef.defaultFloatingSize &&
+                    !!saveTab.preferredFloatingWidgetSize)
             : !!widgetDef.defaultFloatingSize;
         state = addTab(state, widgetDef.id, {
             label,
@@ -262,18 +270,30 @@ export function appendWidgets(state, widgetDefs, location, section) {
             hideWithUiWhenFloating: !!widgetDef.hideWithUiWhenFloating,
             allowedPanelTargets: (_a = widgetDef.allowedPanelTargets) === null || _a === void 0 ? void 0 : _a.map((l) => toPanelSide(l)),
         });
-        if (widgetDef.isFloatingStateSupported && widgetDef.defaultState === WidgetState.Floating) {
+        if (widgetDef.isFloatingStateSupported &&
+            widgetDef.defaultState === WidgetState.Floating) {
             const floatingContainerId = (_b = widgetDef.floatingContainerId) !== null && _b !== void 0 ? _b : getUniqueId();
             const widgetContainerId = getWidgetId(location, section);
-            const home = { side, widgetId: widgetContainerId, widgetIndex: 0 };
+            const home = {
+                side,
+                widgetId: widgetContainerId,
+                widgetIndex: 0,
+            };
             const preferredPosition = widgetDef.defaultFloatingPosition;
             if (floatingContainerId in state.widgets) {
                 state = addTabToWidget(state, widgetDef.id, floatingContainerId);
             }
             else {
                 const tab = state.tabs[widgetDef.id];
-                const size = { height: 200, width: 300, ...tab.preferredFloatingWidgetSize };
-                const preferredPoint = preferredPosition !== null && preferredPosition !== void 0 ? preferredPosition : { x: (state.size.width - size.width) / 2, y: (state.size.height - size.height) / 2 };
+                const size = {
+                    height: 200,
+                    width: 300,
+                    ...tab.preferredFloatingWidgetSize,
+                };
+                const preferredPoint = preferredPosition !== null && preferredPosition !== void 0 ? preferredPosition : {
+                    x: (state.size.width - size.width) / 2,
+                    y: (state.size.height - size.height) / 2,
+                };
                 const nzBounds = Rectangle.createFromSize(state.size);
                 const bounds = Rectangle.createFromSize(size).offset(preferredPoint);
                 const containedBounds = bounds.containIn(nzBounds);
@@ -295,7 +315,9 @@ export function appendWidgets(state, widgetDefs, location, section) {
             else {
                 const panel = state.panels[side];
                 if (panel.widgets.length < panel.maxWidgetCount) {
-                    state = addPanelWidget(state, side, widgetPanelSectionId, [widgetDef.id]);
+                    state = addPanelWidget(state, side, widgetPanelSectionId, [
+                        widgetDef.id,
+                    ]);
                 }
                 else {
                     const widgetIndex = Math.min(preferredWidgetIndex, panel.widgets.length - 1);
@@ -313,7 +335,8 @@ function processPopoutWidgets(initialState, frontstageDef) {
         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) {
+        if (initialState.popoutWidgets.allIds.length &&
+            ProcessDetector.isElectronAppFrontend) {
             for (const widgetContainerId of initialState.popoutWidgets.allIds) {
                 frontstageDef.openPopoutWidgetContainer(initialState, widgetContainerId);
             }
@@ -444,7 +467,10 @@ export function initializePanel(state, frontstageDef, location) {
             panel.maxSize = getPanelMaxSize(panelDef.maxSizeSpec, panelSide, state.size);
         }
         const size = panelDef === null || panelDef === void 0 ? void 0 : panelDef.size;
-        panel.size = size === undefined ? size : Math.min(Math.max(size, panel.minSize), panel.maxSize);
+        panel.size =
+            size === undefined
+                ? size
+                : Math.min(Math.max(size, panel.minSize), panel.maxSize);
     });
     return state;
 }
@@ -452,8 +478,10 @@ function getPanelMaxSize(maxSizeSpec, panel, nineZoneSize) {
     if (typeof maxSizeSpec === "number") {
         return maxSizeSpec;
     }
-    const size = isHorizontalPanelSide(panel) ? nineZoneSize.height : nineZoneSize.width;
-    return maxSizeSpec.percentage / 100 * size;
+    const size = isHorizontalPanelSide(panel)
+        ? nineZoneSize.height
+        : nineZoneSize.width;
+    return (maxSizeSpec.percentage / 100) * size;
 }
 const stateVersion = 13; // this needs to be bumped when NineZoneState is changed (to recreate the layout).
 /** @internal */
@@ -476,7 +504,9 @@ export function initializeNineZoneState(frontstageDef) {
         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;
+            const firstWidget = panel.widgets.length > 0
+                ? stateDraft.widgets[panel.widgets[0]]
+                : undefined;
             // istanbul ignore next
             if (!expanded && firstWidget) {
                 firstWidget.minimized = false;
@@ -489,7 +519,8 @@ export function initializeNineZoneState(frontstageDef) {
         const toolSettingsWidgetDef = frontstageDef.toolSettings;
         if (toolSettingsWidgetDef) {
             const toolSettingsTab = stateDraft.tabs[toolSettingsTabId];
-            toolSettingsTab.preferredPanelWidgetSize = toolSettingsWidgetDef.preferredPanelSize;
+            toolSettingsTab.preferredPanelWidgetSize =
+                toolSettingsWidgetDef.preferredPanelSize;
         }
     });
     nineZone = addMissingWidgets(frontstageDef, nineZone);
@@ -560,7 +591,9 @@ export function restoreNineZoneState(frontstageDef, saved) {
         }
         return;
     });
-    if (InternalFrontstageManager.nineZoneSize && (0 !== InternalFrontstageManager.nineZoneSize.height || 0 !== InternalFrontstageManager.nineZoneSize.width)) {
+    if (InternalFrontstageManager.nineZoneSize &&
+        (0 !== InternalFrontstageManager.nineZoneSize.height ||
+            0 !== InternalFrontstageManager.nineZoneSize.width)) {
         restored = FrameworkStateReducer(restored, {
             type: "RESIZE",
             size: {
@@ -768,7 +801,9 @@ function hideWidget(state, widgetDef) {
     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 widgetIndex = isPanelTabLocation(location)
+            ? state.panels[side].widgets.indexOf(widgetId)
+            : 0;
         const tabIndex = state.widgets[location.widgetId].tabs.indexOf(widgetDef.id);
         widgetDef.tabLocation = {
             side,
@@ -808,8 +843,9 @@ export function expandWidget(state, id) {
         if (isPanelTabLocation(location)) {
             const panel = draft.panels[location.side];
             panel.splitterPercent =
-                panel.widgets.findIndex((wId) => wId === location.widgetId) === 0 ?
-                    100 : 0;
+                panel.widgets.findIndex((wId) => wId === location.widgetId) === 0
+                    ? 100
+                    : 0;
         }
         widget.minimized = false;
     });
@@ -830,7 +866,9 @@ export function useSavedFrontstageState(frontstageDef) {
     const isMountedRef = React.useRef(false);
     React.useEffect(() => {
         isMountedRef.current = true;
-        return () => { isMountedRef.current = false; };
+        return () => {
+            isMountedRef.current = false;
+        };
     }, []);
     React.useEffect(() => {
         uiStateStorageRef.current = uiStateStorage;
@@ -848,7 +886,8 @@ export function useSavedFrontstageState(frontstageDef) {
                 return;
             if (isFrontstageStateSettingResult(settingResult)) {
                 const setting = settingResult.setting;
-                if (setting.version >= version && setting.stateVersion >= stateVersion) {
+                if (setting.version >= version &&
+                    setting.stateVersion >= stateVersion) {
                     const restored = restoreNineZoneState(frontstageDef, setting.nineZone);
                     frontstageDef.savedWidgetDefs = setting.widgets;
                     restoreSavedWidgets(frontstageDef);
@@ -974,7 +1013,8 @@ export function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel)
             // 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) {
-                args.frontstageDef.nineZoneState = initializeNineZoneState(frontstageDef);
+                args.frontstageDef.nineZoneState =
+                    initializeNineZoneState(frontstageDef);
             }
             else {
                 args.frontstageDef.nineZoneState = undefined;
@@ -1002,8 +1042,9 @@ export function useFrontstageManager(frontstageDef, useToolAsToolSettingsLabel)
             var _a;
             const toolId = UiFramework.frontstages.activeToolId;
             assert(!!frontstageDef.nineZoneState);
-            const label = useToolAsToolSettingsLabel ?
-                ((_a = IModelApp.tools.find(toolId)) === null || _a === void 0 ? void 0 : _a.flyover) || defaultLabel : defaultLabel;
+            const label = useToolAsToolSettingsLabel
+                ? ((_a = IModelApp.tools.find(toolId)) === null || _a === void 0 ? void 0 : _a.flyover) || defaultLabel
+                : defaultLabel;
             frontstageDef.nineZoneState = setWidgetLabel(frontstageDef.nineZoneState, toolSettingsTabId, label);
         });
         // Whenever the frontstageDef or the useTool... changes, keep the label up to date.