@itwin/appui-react 4.10.0 → 4.12.0

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

@@ -32,6 +32,11 @@ import { InternalModelessDialogManager } from "./dialog/InternalModelessDialogMa
 import { InternalKeyboardShortcutManager } from "./keyboardshortcut/InternalKeyboardShortcut";
 import { InternalToolSettingsManager } from "./toolsettings/InternalToolSettingsManager";
 import { SyncUiEventDispatcher, SyncUiEventId, } from "./syncui/SyncUiEventDispatcher";
+import { PopupManager } from "./popup/PopupManager";
+import { AccuDrawPopupManager } from "./accudraw/AccuDrawPopupManager";
+import { UiDataProvidedDialog } from "./dialog/UiDataProvidedDialog";
+import { createElement } from "react";
+import { mapToRelativePosition } from "./utils/Placement";
 /** UiVisibility Event class.
  * @public
  */
@@ -134,6 +139,7 @@ class UiFramework {
      * @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) {
+        var _a;
         if (UiFramework._initialized) {
             Logger.logInfo(UiFramework.loggerCategory(UiFramework), `UiFramework.initialize already called`);
             return;
@@ -147,7 +153,7 @@ class UiFramework {
         if (frameworkStateKey && store)
             UiFramework._frameworkStateKeyInStore = frameworkStateKey;
         // set up namespace and register all tools from package
-        const frameworkNamespace = IModelApp.localization?.registerNamespace(UiFramework.localizationNamespace);
+        const frameworkNamespace = (_a = IModelApp.localization) === null || _a === void 0 ? void 0 : _a.registerNamespace(UiFramework.localizationNamespace);
         [
             restoreLayoutTools,
             keyinPaletteTools,
@@ -173,12 +179,13 @@ class UiFramework {
     }
     /** Un-registers the UiFramework internationalization service namespace */
     static terminate() {
+        var _a;
         UiFramework._store = undefined;
         UiFramework._frameworkStateKeyInStore = "frameworkState";
         if (StateManager.isInitialized(true))
             StateManager.clearStore();
         // istanbul ignore next
-        IModelApp.localization?.unregisterNamespace(UiFramework.localizationNamespace);
+        (_a = IModelApp.localization) === null || _a === void 0 ? void 0 : _a.unregisterNamespace(UiFramework.localizationNamespace);
         UiFramework._backstageManager = undefined;
         UiFramework._widgetManager = undefined;
         UiFramework._hideIsolateEmphasizeActionHandler = undefined;
@@ -225,16 +232,6 @@ class UiFramework {
         // istanbul ignore next
         return StateManager.store;
     }
-    /** The internationalization service created by the app.
-     * @internal
-     */
-    static get localization() {
-        // istanbul ignore next
-        if (!IModelApp.localization)
-            // eslint-disable-next-line deprecation/deprecation
-            throw new UiError(UiFramework.loggerCategory(this), `IModelApp.localization has not been defined.`);
-        return IModelApp.localization;
-    }
     /** The internationalization service namespace. */
     static get localizationNamespace() {
         return "UiFramework";
@@ -264,13 +261,11 @@ class UiFramework {
             throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
         return UiFramework._widgetManager;
     }
-    /** Calls localization.getLocalizedStringWithNamespace with the "UiFramework" namespace. Do NOT include the namespace in the key.
+    /** Calls localization.getLocalizedString with the "UiFramework" namespace. Do NOT include the namespace in the key.
      * @internal
      */
-    static translate(key) {
-        return IModelApp.localization.getLocalizedString(key, {
-            ns: UiFramework.localizationNamespace,
-        });
+    static translate(key, options) {
+        return IModelApp.localization.getLocalizedString(`${UiFramework.localizationNamespace}:${key}`, options);
     }
     /** @internal */
     static get packageName() {
@@ -322,8 +317,39 @@ class UiFramework {
             }
         }
     }
+    /** 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.
+     * @param anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @return true if the menu was displayed, false if the menu could not be displayed.
+     */
+    static openContextMenu(items, location, anchorElement) {
+        let position = location;
+        let childWindowId;
+        if (anchorElement) {
+            const anchorOffset = anchorElement.getBoundingClientRect();
+            position = {
+                x: anchorOffset.left + location.x,
+                y: anchorOffset.top + location.y,
+            };
+            childWindowId = UiFramework.childWindows.findId(anchorElement.ownerDocument.defaultView);
+        }
+        position = {
+            x: position.x + UiFramework.CONTEXT_MENU_OFFSET,
+            y: position.y + UiFramework.CONTEXT_MENU_OFFSET,
+        };
+        const cursorMenuData = {
+            position,
+            items,
+            childWindowId,
+        };
+        UiFramework.openCursorMenu(cursorMenuData);
+        return true;
+    }
     /** @public */
-    static openCursorMenu(menuData) {
+    static openCursorMenu(
+    // eslint-disable-next-line deprecation/deprecation
+    menuData) {
         UiFramework.dispatchActionToStore(SessionStateActionId.UpdateCursorMenu, menuData);
     }
     /** @public */
@@ -332,8 +358,9 @@ class UiFramework {
     }
     /** @public */
     static getCursorMenuData() {
+        var _a;
         return UiFramework.frameworkState
-            ? UiFramework.frameworkState.sessionState.cursorMenuData
+            ? (_a = UiFramework.frameworkState.sessionState.cursorMenuPayload) !== null && _a !== void 0 ? _a : UiFramework.frameworkState.sessionState.cursorMenuData
             : /* istanbul ignore next */ undefined;
     }
     static getActiveIModelId() {
@@ -345,10 +372,11 @@ class UiFramework {
         UiFramework.dispatchActionToStore(SessionStateActionId.SetActiveIModelId, iModelId);
     }
     static setIModelConnection(iModelConnection, immediateSync = false) {
+        var _a;
         const oldConnection = UiFramework.getIModelConnection();
         if (oldConnection === iModelConnection)
             return;
-        InternalFrontstageManager.clearFrontstageDefsForIModelId(oldConnection?.iModelId);
+        InternalFrontstageManager.clearFrontstageDefsForIModelId(oldConnection === null || oldConnection === void 0 ? void 0 : oldConnection.iModelId);
         oldConnection && SyncUiEventDispatcher.clearConnectionEvents(oldConnection);
         iModelConnection &&
             SyncUiEventDispatcher.initializeConnectionEvents(iModelConnection);
@@ -357,7 +385,7 @@ class UiFramework {
             ? iModelConnection.selectionSet.elements.size
             : 0;
         UiFramework.dispatchActionToStore(SessionStateActionId.SetNumItemsSelected, itemsSelected);
-        UiFramework.setActiveIModelId(iModelConnection?.iModelId ?? "");
+        UiFramework.setActiveIModelId((_a = iModelConnection === null || iModelConnection === void 0 ? void 0 : iModelConnection.iModelId) !== null && _a !== void 0 ? _a : "");
     }
     static getIModelConnection() {
         return UiFramework.frameworkState
@@ -567,6 +595,257 @@ class UiFramework {
         const contextMenu = document.querySelector("div.core-context-menu-opened");
         return contextMenu !== null && contextMenu !== undefined;
     }
+    /** Show a Card containing content, a title and a toolbar at a particular location.
+     * @param content The React component or HTMLElement of the content to display
+     * @param title Title to display at the top of the card.
+     * @param toolbarProps Properties of the Toolbar to display.
+     * @param location Location of the Card, relative to the origin of anchorElement or the window.
+     * @param offset Offset of the Card from the location.
+     * @param onItemExecuted Function invoked after a Toolbar item is executed
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
+     * @param placement {@link Placement} relative to the given location. Defaults to top-end.
+     * @param anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
+     * @return true if the Card was displayed, false if the Card could not be displayed.
+     * @internal
+     */
+    static showCard(content, title, toolbarProps, location, offset, onItemExecuted, onCancel, placement = "top-end", anchorElement) {
+        const anchor = this.resolveHtmlElement(anchorElement);
+        return PopupManager.displayCard({ reactNode: content }, {
+            title,
+            toolbarProps,
+            location,
+            offset,
+            onItemExecuted,
+            onCancel,
+            placement,
+            anchor,
+        });
+    }
+    /**
+     * Hides a Card displayed with {@link UiFramework.showCard}
+     * @internal
+     */
+    static hideCard() {
+        return PopupManager.hideCard();
+    }
+    /** Opens a Tool Settings Ui popup at a particular location.
+     * @param dataProvider The DialogLayoutDataProvider for the tool settings popup dialog.
+     * @param location Location of the tool settings, relative to the origin of anchorElement or the window
+     * @param offset Offset of the tool settings from the location
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
+     * @param placement {@link Placement} relative to the given location. Defaults to top-end.
+     * @param anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
+     * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
+     * @internal
+     */
+    static openToolSettingsPopup(dataProvider, location, offset, onCancel, placement = "top-end", anchorElement) {
+        const el = this.resolveHtmlElement(anchorElement);
+        const relativePosition = mapToRelativePosition(placement);
+        return PopupManager.openToolSettings(dataProvider, el, location, offset, onCancel, relativePosition);
+    }
+    /**
+     * Closes the Tool Settings Ui popup.
+     * @internal
+     */
+    static closeToolSettingsPopup() {
+        return PopupManager.closeToolSettings();
+    }
+    /** Show a Toolbar at a particular location.
+     * @param toolbarProps Properties of the Toolbar to display.
+     * @param location Location of the Toolbar, relative to the origin of anchorElement or the overall window.
+     * @param offset Offset of the Toolbar from the location.
+     * @param onItemExecuted Function invoked after a Toolbar item is executed
+     * @param onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
+     * @param placement {@link Placement} relative to the given location. Defaults to top-end.
+     * @param anchorElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
+     * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
+     */
+    static showToolbar(toolbarProps, location, offset, onItemExecuted, onCancel, placement = "top-end", anchorElement) {
+        const anchor = UiFramework.resolveHtmlElement(anchorElement);
+        return PopupManager.displayToolbar(toolbarProps.items, {
+            anchor,
+            location,
+            offset,
+            onItemExecuted,
+            onCancel,
+            placement,
+        });
+    }
+    /** Hides a toolbar displayed via {@link UiFramework.showToolbar} */
+    static hideToolbar() {
+        return PopupManager.hideToolbar();
+    }
+    /** Show a menu button at a particular location. A menu button opens a context menu.
+     * @param id Id of the menu button. Multiple menu buttons may be displayed.
+     * @param menuItemsProps Properties of the menu items to display.
+     * @param location Location of the context menu, relative to the origin of anchorElement or the window.
+     * @param anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @return true if the menu was displayed, false if the menu could not be displayed.
+     */
+    static showMenuButton(id, menuItemsProps, location, anchorElement) {
+        const el = this.resolveHtmlElement(anchorElement);
+        return AccuDrawPopupManager.showMenuButton(id, el, location, menuItemsProps);
+    }
+    /** Hides a menu button.
+     * @param id Id of the menu button. Multiple menu buttons may be displayed.
+     * @return true if the menu was hidden, false if the menu could not be hidden.
+     */
+    static hideMenuButton(id) {
+        return AccuDrawPopupManager.hideMenuButton(id);
+    }
+    /** Show a calculator at a particular location.
+     * @param initialValue Value initially displayed in the calculator.
+     * @param resultIcon Icon displayed to the left of the value.
+     * @param location Location of the calculator, relative to the origin of anchorElement or the window.
+     * @param onOk Function called when the OK button or the Enter key is pressed.
+     * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
+     * @param anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @return true if the menu was displayed, false if the menu could not be displayed.
+     */
+    static showCalculator(initialValue, resultIcon, location, onOk, onCancel, anchorElement) {
+        const el = this.resolveHtmlElement(anchorElement);
+        return AccuDrawPopupManager.showCalculator(el, location, initialValue, resultIcon, onOk, onCancel);
+    }
+    /** Hides the calculator. */
+    static hideCalculator() {
+        return AccuDrawPopupManager.hideCalculator();
+    }
+    /** Show a React Element at a particular location.
+     * @param component The ReactElement to display
+     * @param options - Optional {@link: ShowComponentParams}
+     */
+    static showComponent(...params) {
+        var _a;
+        const options = params[1] || {};
+        const component = params[0];
+        const { anchorRef, id } = options;
+        let { location, offset, onCancel, placement } = options;
+        if (!location)
+            location = { x: 0, y: 0 };
+        if (!offset)
+            offset = { x: 0, y: 0 };
+        if (!placement)
+            placement = "top-end";
+        if (!onCancel)
+            onCancel = () => UiFramework.hideComponent(id);
+        return PopupManager.showComponent(component, {
+            location,
+            offset,
+            onCancel,
+            placement,
+            anchor: (_a = anchorRef === null || anchorRef === void 0 ? void 0 : anchorRef.current) !== null && _a !== void 0 ? _a : undefined,
+            id,
+        });
+    }
+    /**
+     * Hides the Component previously shown with {@link UiFramework.showComponent}
+     */
+    static hideComponent(id) {
+        return PopupManager.hideComponent(id);
+    }
+    /** Show an input editor for an angle value at a particular location.
+     * @param initialValue Value initially displayed in the editor.
+     * @param location Location of the editor, relative to the origin of anchorElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
+     * @param anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @return true if the editor was displayed, false if the editor could not be displayed.
+     */
+    static showAngleEditor(initialValue, location, onCommit, onCancel, anchorElement) {
+        const el = this.resolveHtmlElement(anchorElement);
+        return AccuDrawPopupManager.showAngleEditor(el, location, initialValue, onCommit, onCancel);
+    }
+    /** Show an input editor for a length value at a particular location.
+     * @param ShowInputEditorOptions Options detailed below for the input editor
+     * @param ShowInputEditorOptions.anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @param ShowInputEditorOptions.propertyDescription Description of the primitive value property
+     * @param ShowInputEditorOptions.initialValue Value initially displayed in the editor.
+     * @param ShowInputEditorOptions.location Location of the editor, relative to the origin of anchorElement or the window.
+     * @param ShowInputEditorOptions.onCommit Function called when the OK button or the Enter key is pressed.
+     * @param ShowInputEditorOptions.onCancel Function called when the Cancel button or the Escape key is pressed.
+     * @return true if the editor was displayed, false if the editor could not be displayed.
+     * @internal
+     */
+    static showInputEditor({ anchorElement, initialValue, location, onCancel, onCommit, propertyDescription, }) {
+        const el = this.resolveHtmlElement(anchorElement);
+        PopupManager.showInputEditor(el, location, initialValue, propertyDescription, onCommit, onCancel);
+        return true;
+    }
+    /** Show an input editor for a length value at a particular location.
+     * @param dimension Dimension determining which editor to display.
+     * @param initialValue Value initially displayed in the editor.
+     * @param location Location of the editor, relative to the origin of anchorElement or the window.
+     * @param onCommit Function called when the OK button or the Enter key is pressed.
+     * @param onCancel Function called when the Cancel button or the Escape key  is pressed.
+     * @param anchorElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
+     * @return true if the editor was displayed, false if the editor could not be displayed.
+     */
+    static showDimensionEditor(dimension, initialValue, location, onCommit, onCancel, anchorElement) {
+        const el = this.resolveHtmlElement(anchorElement);
+        return AccuDrawPopupManager.showDimensionEditor(dimension, el, location, initialValue, onCommit, onCancel);
+    }
+    /** Hides the input editor.
+     * @internal
+     */
+    static hideInputEditor() {
+        return PopupManager.hideInputEditor();
+    }
+    /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
+     * @param uiDataProvider The UiDataProvider for the tool settings
+     * @param title Specify title for dialog.
+     * @param isModal Specify if the dialog is opened as a modal or modeless.
+     * @param id Id of the dialog that is used to close it.
+     * @param optionalProps Optional props for Dialog construction.
+     * @return true if the tool settings were displayed, false if the tool settings could not be displayed.
+     * @internal
+     */
+    static openDialog(uiDataProvider, title, isModal, id, optionalProps) {
+        const dialog = createElement(UiDataProvidedDialog, {
+            uiDataProvider,
+            title,
+            isModal,
+            id,
+            ...optionalProps,
+        });
+        const modalType = isModal ? "modal" : "modeless";
+        UiFramework.dialogs[modalType].open(dialog, id);
+        return true;
+    }
+    /** Closes the Dialog with the specified dialogId.
+     * @param dialogId Id of the dialog to close.
+     * @internal
+     */
+    static closeDialog(dialogId) {
+        const findFn = (info) => info.id === dialogId;
+        // istanbul ignore else
+        if (UiFramework.dialogs.modeless.dialogs.findIndex(findFn) !== -1) {
+            UiFramework.dialogs.modeless.close(dialogId);
+            return true;
+        }
+        // istanbul ignore else
+        if (UiFramework.dialogs.modal.dialogs.findIndex(findFn) !== -1) {
+            UiFramework.dialogs.modal.close();
+            return true;
+        }
+        // istanbul ignore next
+        return false;
+    }
+    /** Show the Key-in Palette to display key-in from all registered Tools.
+     * @param keyinEntries A list of KeyinEntry to display in the palette. These can be gathered and filtered from iModelApp.tools.getToolList()
+     * @param htmlElement The HTMLElement that anchors the Popup. If undefined, the location is relative to the overall window.
+     * @return true if the Command Palette was displayed, false if it could not be displayed.
+     */
+    static showKeyinPalette(keyinEntries, htmlElement) {
+        return PopupManager.showKeyinPalette(keyinEntries, UiFramework.resolveHtmlElement(htmlElement));
+    }
+    /** Hides the Key-in Palette. */
+    static hideKeyinPalette() {
+        return PopupManager.hideKeyinPalette();
+    }
+    static resolveHtmlElement(htmlElement) {
+        const el = htmlElement !== null && htmlElement !== void 0 ? htmlElement : UiFramework.controls.getWrapperElement();
+        return el;
+    }
 }
 UiFramework._initialized = false;
 UiFramework._complaint = "UiFramework not initialized";
@@ -576,6 +855,7 @@ UiFramework._uiStateStorage = new LocalStateStorage();
 UiFramework._uiSettingsProviderRegistry = new Map();
 UiFramework._childWindowManager = new InternalChildWindowManager();
 UiFramework.useDefaultPopoutUrl = false;
+UiFramework.CONTEXT_MENU_OFFSET = -8;
 /** Get Show Ui event.
  * @public
  */