@itwin/appui-react 3.8.0-dev.1 → 3.8.0

package/lib/cjs/appui-react/frontstage/ModalSettingsStage.js

@@ -1,88 +1,88 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SettingsModalFrontstage = void 0;
-require("./ModalSettingsStage.scss");
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const settings_svg_1 = require("@bentley/icons-generic/icons/settings.svg");
-const core_frontend_1 = require("@itwin/core-frontend");
-const core_bentley_1 = require("@itwin/core-bentley");
-const core_react_1 = require("@itwin/core-react");
-const UiFramework_1 = require("../UiFramework");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-const StageUsage_1 = require("./StageUsage");
-function ModalSettingsStage({ initialSettingsTabId }) {
-    var _a, _b, _c, _d;
-    const id = (_b = (_a = UiFramework_1.UiFramework.frontstages.activeFrontstageDef) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : "none";
-    const stageUsage = (_d = (_c = UiFramework_1.UiFramework.frontstages.activeFrontstageDef) === null || _c === void 0 ? void 0 : _c.usage) !== null && _d !== void 0 ? _d : StageUsage_1.StageUsage.General;
-    const tabEntries = UiFramework_1.UiFramework.settingsManager.getSettingEntries(id, stageUsage);
-    const noSettingsAvailableLabel = React.useRef(UiFramework_1.UiFramework.translate("settings.noSettingsAvailable"));
-    const currentSettingsTab = React.useCallback(() => {
-        const categoryToFind = initialSettingsTabId ? initialSettingsTabId.toLowerCase() : tabEntries[0].tabId.toLowerCase();
-        let foundTab = tabEntries.find((entry) => entry.tabId.toLowerCase() === categoryToFind);
-        if (!foundTab)
-            foundTab = tabEntries.find((entry) => entry.label.toLowerCase() === categoryToFind);
-        return foundTab;
-    }, [initialSettingsTabId, tabEntries]);
-    React.useEffect(() => {
-        const handleFrontstageCloseRequested = ({ modalFrontstage, stageCloseFunc }) => {
-            // istanbul ignore else
-            if (modalFrontstage instanceof SettingsModalFrontstage && stageCloseFunc) {
-                UiFramework_1.UiFramework.settingsManager.closeSettingsContainer(stageCloseFunc);
-            }
-        };
-        return UiFramework_1.UiFramework.frontstages.onCloseModalFrontstageRequestedEvent.addListener(handleFrontstageCloseRequested);
-    }, [tabEntries]);
-    return (React.createElement("div", { className: "uifw-settings-container" }, tabEntries.length ?
-        React.createElement(core_react_1.SettingsContainer, { tabs: tabEntries, currentSettingsTab: currentSettingsTab(), settingsManager: UiFramework_1.UiFramework.settingsManager }) :
-        React.createElement(core_react_1.Centered, null, noSettingsAvailableLabel.current)));
-}
-/** Modal frontstage displaying and editing settings from registered settings providers. See [SettingsManager]($core-react)
- * and [SettingsContainer]($core-react).
- * @beta
- */
-class SettingsModalFrontstage {
-    constructor(initialSettingsTabId) {
-        this.initialSettingsTabId = initialSettingsTabId;
-        this.title = UiFramework_1.UiFramework.translate("settings.settingsStageLabel");
-        this.notifyCloseRequest = true;
-    }
-    get content() {
-        return (React.createElement(ModalSettingsStage, { initialSettingsTabId: this.initialSettingsTabId }));
-    }
-    static getBackstageActionItem(groupPriority, itemPriority) {
-        return appui_abstract_1.BackstageItemUtilities.createActionItem(SettingsModalFrontstage.id, groupPriority, itemPriority, () => UiFramework_1.UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage()), // eslint-disable-line deprecation/deprecation
-        UiFramework_1.UiFramework.translate("settings.settingsStageLabel"), undefined, appui_abstract_1.IconSpecUtilities.createWebComponentIconSpec(settings_svg_1.default), { isHidden: SettingsModalFrontstage.noSettingsAvailable() });
-    }
-    static showSettingsStage(initialSettingsTab) {
-        if (UiFramework_1.UiFramework.settingsManager.providers.length) {
-            // Check to see if it is already open
-            // istanbul ignore else
-            if (UiFramework_1.UiFramework.frontstages.activeModalFrontstage && UiFramework_1.UiFramework.frontstages.activeModalFrontstage instanceof SettingsModalFrontstage) {
-                if (initialSettingsTab) {
-                    UiFramework_1.UiFramework.settingsManager.activateSettingsTab(initialSettingsTab);
-                    return;
-                }
-            }
-            UiFramework_1.UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage(initialSettingsTab));
-        }
-        else {
-            const briefMessage = UiFramework_1.UiFramework.translate("settings.noSettingsAvailable");
-            const detailedMessage = UiFramework_1.UiFramework.translate("settings.noSettingsProvidersRegistered");
-            const info = new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, briefMessage, detailedMessage, core_frontend_1.OutputMessageType.Toast);
-            core_frontend_1.IModelApp.notifications.outputMessage(info);
-            core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(this), detailedMessage);
-        }
-    }
-}
-exports.SettingsModalFrontstage = SettingsModalFrontstage;
-SettingsModalFrontstage.id = "appui-react.modalSettingsStage";
-SettingsModalFrontstage.noSettingsAvailable = () => new appui_abstract_1.ConditionalBooleanValue(() => 0 === UiFramework_1.UiFramework.settingsManager.providers.length, [SyncUiEventDispatcher_1.SyncUiEventId.SettingsProvidersChanged]);
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsModalFrontstage = void 0;
+require("./ModalSettingsStage.scss");
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const settings_svg_1 = require("@bentley/icons-generic/icons/settings.svg");
+const core_frontend_1 = require("@itwin/core-frontend");
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_react_1 = require("@itwin/core-react");
+const UiFramework_1 = require("../UiFramework");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const StageUsage_1 = require("./StageUsage");
+function ModalSettingsStage({ initialSettingsTabId }) {
+    var _a, _b, _c, _d;
+    const id = (_b = (_a = UiFramework_1.UiFramework.frontstages.activeFrontstageDef) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : "none";
+    const stageUsage = (_d = (_c = UiFramework_1.UiFramework.frontstages.activeFrontstageDef) === null || _c === void 0 ? void 0 : _c.usage) !== null && _d !== void 0 ? _d : StageUsage_1.StageUsage.General;
+    const tabEntries = UiFramework_1.UiFramework.settingsManager.getSettingEntries(id, stageUsage);
+    const noSettingsAvailableLabel = React.useRef(UiFramework_1.UiFramework.translate("settings.noSettingsAvailable"));
+    const currentSettingsTab = React.useCallback(() => {
+        const categoryToFind = initialSettingsTabId ? initialSettingsTabId.toLowerCase() : tabEntries[0].tabId.toLowerCase();
+        let foundTab = tabEntries.find((entry) => entry.tabId.toLowerCase() === categoryToFind);
+        if (!foundTab)
+            foundTab = tabEntries.find((entry) => entry.label.toLowerCase() === categoryToFind);
+        return foundTab;
+    }, [initialSettingsTabId, tabEntries]);
+    React.useEffect(() => {
+        const handleFrontstageCloseRequested = ({ modalFrontstage, stageCloseFunc }) => {
+            // istanbul ignore else
+            if (modalFrontstage instanceof SettingsModalFrontstage && stageCloseFunc) {
+                UiFramework_1.UiFramework.settingsManager.closeSettingsContainer(stageCloseFunc);
+            }
+        };
+        return UiFramework_1.UiFramework.frontstages.onCloseModalFrontstageRequestedEvent.addListener(handleFrontstageCloseRequested);
+    }, [tabEntries]);
+    return (React.createElement("div", { className: "uifw-settings-container" }, tabEntries.length ?
+        React.createElement(core_react_1.SettingsContainer, { tabs: tabEntries, currentSettingsTab: currentSettingsTab(), settingsManager: UiFramework_1.UiFramework.settingsManager }) :
+        React.createElement(core_react_1.Centered, null, noSettingsAvailableLabel.current)));
+}
+/** Modal frontstage displaying and editing settings from registered settings providers. See [SettingsManager]($core-react)
+ * and [SettingsContainer]($core-react).
+ * @beta
+ */
+class SettingsModalFrontstage {
+    constructor(initialSettingsTabId) {
+        this.initialSettingsTabId = initialSettingsTabId;
+        this.title = UiFramework_1.UiFramework.translate("settings.settingsStageLabel");
+        this.notifyCloseRequest = true;
+    }
+    get content() {
+        return (React.createElement(ModalSettingsStage, { initialSettingsTabId: this.initialSettingsTabId }));
+    }
+    static getBackstageActionItem(groupPriority, itemPriority) {
+        return appui_abstract_1.BackstageItemUtilities.createActionItem(SettingsModalFrontstage.id, groupPriority, itemPriority, () => UiFramework_1.UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage()), // eslint-disable-line deprecation/deprecation
+        UiFramework_1.UiFramework.translate("settings.settingsStageLabel"), undefined, appui_abstract_1.IconSpecUtilities.createWebComponentIconSpec(settings_svg_1.default), { isHidden: SettingsModalFrontstage.noSettingsAvailable() });
+    }
+    static showSettingsStage(initialSettingsTab) {
+        if (UiFramework_1.UiFramework.settingsManager.providers.length) {
+            // Check to see if it is already open
+            // istanbul ignore else
+            if (UiFramework_1.UiFramework.frontstages.activeModalFrontstage && UiFramework_1.UiFramework.frontstages.activeModalFrontstage instanceof SettingsModalFrontstage) {
+                if (initialSettingsTab) {
+                    UiFramework_1.UiFramework.settingsManager.activateSettingsTab(initialSettingsTab);
+                    return;
+                }
+            }
+            UiFramework_1.UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage(initialSettingsTab));
+        }
+        else {
+            const briefMessage = UiFramework_1.UiFramework.translate("settings.noSettingsAvailable");
+            const detailedMessage = UiFramework_1.UiFramework.translate("settings.noSettingsProvidersRegistered");
+            const info = new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, briefMessage, detailedMessage, core_frontend_1.OutputMessageType.Toast);
+            core_frontend_1.IModelApp.notifications.outputMessage(info);
+            core_bentley_1.Logger.logInfo(UiFramework_1.UiFramework.loggerCategory(this), detailedMessage);
+        }
+    }
+}
+exports.SettingsModalFrontstage = SettingsModalFrontstage;
+SettingsModalFrontstage.id = "appui-react.modalSettingsStage";
+SettingsModalFrontstage.noSettingsAvailable = () => new appui_abstract_1.ConditionalBooleanValue(() => 0 === UiFramework_1.UiFramework.settingsManager.providers.length, [SyncUiEventDispatcher_1.SyncUiEventId.SettingsProvidersChanged]);
 //# sourceMappingURL=ModalSettingsStage.js.map

package/lib/cjs/appui-react/frontstage/ModalSettingsStage.js.map

@@ -1 +1 @@
-{"version":3,"file":"ModalSettingsStage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/ModalSettingsStage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAmC;AACnC,+BAA+B;AAC/B,0DAA2G;AAC3G,4EAAwE;AACxE,wDAAiH;AACjH,sDAA6C;AAC7C,kDAAgE;AAEhE,gDAA6C;AAC7C,2EAAgE;AAChE,6CAA0C;AAE1C,SAAS,kBAAkB,CAAC,EAAE,oBAAoB,EAAqC;;IACrF,MAAM,EAAE,GAAG,MAAA,MAAA,yBAAW,CAAC,WAAW,CAAC,mBAAmB,0CAAE,EAAE,mCAAI,MAAM,CAAC;IACrE,MAAM,UAAU,GAAG,MAAA,MAAA,yBAAW,CAAC,WAAW,CAAC,mBAAmB,0CAAE,KAAK,mCAAI,uBAAU,CAAC,OAAO,CAAC;IAC5F,MAAM,UAAU,GAAG,yBAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACjF,MAAM,wBAAwB,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAW,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAErG,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QAChD,MAAM,cAAc,GAAG,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACrH,IAAI,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,QAAQ;YACX,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEvC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,8BAA8B,GAAG,CAAC,EAAE,eAAe,EAAE,cAAc,EAA0C,EAAE,EAAE;YACrH,uBAAuB;YACvB,IAAI,eAAe,YAAY,uBAAuB,IAAI,cAAc,EAAE;gBACxE,yBAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;aACpE;QACH,CAAC,CAAC;QACF,OAAO,yBAAW,CAAC,WAAW,CAAC,oCAAoC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;IAClH,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,OAAO,CACL,6BAAK,SAAS,EAAC,yBAAyB,IACrC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClB,oBAAC,8BAAiB,IAAC,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,EAAE,eAAe,EAAE,yBAAW,CAAC,eAAe,GAAI,CAAC,CAAC;QACjI,oBAAC,qBAAQ,QAAE,wBAAwB,CAAC,OAAO,CAAY,CAErD,CACP,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAa,uBAAuB;IAGlC,YAAmB,oBAA6B;QAA7B,yBAAoB,GAApB,oBAAoB,CAAS;QADzC,UAAK,GAAW,yBAAW,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QAErE,uBAAkB,GAAG,IAAI,CAAC;IADmB,CAAC;IAErD,IAAW,OAAO;QAChB,OAAO,CAAC,oBAAC,kBAAkB,IAAC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,GAAI,CAAC,CAAC;IACnF,CAAC;IAGM,MAAM,CAAC,sBAAsB,CAAC,aAAqB,EAAE,YAAoB;QAC9E,OAAO,uCAAsB,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,yBAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,uBAAuB,EAAE,CAAC,EAAE,8CAA8C;QACtO,yBAAW,CAAC,SAAS,CAAC,6BAA6B,CAAC,EACpD,SAAS,EAAE,kCAAiB,CAAC,0BAA0B,CAAC,sBAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,uBAAuB,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,kBAA2B;QACzD,IAAI,yBAAW,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE;YAChD,qCAAqC;YACrC,uBAAuB;YACvB,IAAI,yBAAW,CAAC,WAAW,CAAC,qBAAqB,IAAI,yBAAW,CAAC,WAAW,CAAC,qBAAqB,YAAY,uBAAuB,EAAE;gBACrI,IAAI,kBAAkB,EAAE;oBACtB,yBAAW,CAAC,eAAe,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;oBACpE,OAAO;iBACR;aACF;YACD,yBAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;SAC9F;aAAM;YACL,MAAM,YAAY,GAAG,yBAAW,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;YAC3E,MAAM,eAAe,GAAG,yBAAW,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAAC;YACxF,MAAM,IAAI,GAAG,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,iCAAiB,CAAC,KAAK,CAAC,CAAC;YAC1H,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC5C,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC;SACnE;IACH,CAAC;;AAlCH,0DAmCC;AAlCe,0BAAE,GAAG,gCAAgC,CAAC;AAOrC,2CAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,wCAAuB,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,yBAAW,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,qCAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\n\r\nimport \"./ModalSettingsStage.scss\";\r\nimport * as React from \"react\";\r\nimport { BackstageItemUtilities, ConditionalBooleanValue, IconSpecUtilities } from \"@itwin/appui-abstract\";\r\nimport settingsIconSvg from \"@bentley/icons-generic/icons/settings.svg\";\r\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType } from \"@itwin/core-frontend\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { Centered, SettingsContainer } from \"@itwin/core-react\";\r\nimport { ModalFrontstageInfo, ModalFrontstageRequestedCloseEventArgs } from \"../framework/FrameworkFrontstages\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { StageUsage } from \"./StageUsage\";\r\n\r\nfunction ModalSettingsStage({ initialSettingsTabId }: { initialSettingsTabId?: string }) {\r\n  const id = UiFramework.frontstages.activeFrontstageDef?.id ?? \"none\";\r\n  const stageUsage = UiFramework.frontstages.activeFrontstageDef?.usage ?? StageUsage.General;\r\n  const tabEntries = UiFramework.settingsManager.getSettingEntries(id, stageUsage);\r\n  const noSettingsAvailableLabel = React.useRef(UiFramework.translate(\"settings.noSettingsAvailable\"));\r\n\r\n  const currentSettingsTab = React.useCallback(() => {\r\n    const categoryToFind = initialSettingsTabId ? initialSettingsTabId.toLowerCase() : tabEntries[0].tabId.toLowerCase();\r\n    let foundTab = tabEntries.find((entry) => entry.tabId.toLowerCase() === categoryToFind);\r\n    if (!foundTab)\r\n      foundTab = tabEntries.find((entry) => entry.label.toLowerCase() === categoryToFind);\r\n    return foundTab;\r\n  }, [initialSettingsTabId, tabEntries]);\r\n\r\n  React.useEffect(() => {\r\n    const handleFrontstageCloseRequested = ({ modalFrontstage, stageCloseFunc }: ModalFrontstageRequestedCloseEventArgs) => {\r\n      // istanbul ignore else\r\n      if (modalFrontstage instanceof SettingsModalFrontstage && stageCloseFunc) {\r\n        UiFramework.settingsManager.closeSettingsContainer(stageCloseFunc);\r\n      }\r\n    };\r\n    return UiFramework.frontstages.onCloseModalFrontstageRequestedEvent.addListener(handleFrontstageCloseRequested);\r\n  }, [tabEntries]);\r\n\r\n  return (\r\n    <div className=\"uifw-settings-container\">\r\n      {tabEntries.length ?\r\n        <SettingsContainer tabs={tabEntries} currentSettingsTab={currentSettingsTab()} settingsManager={UiFramework.settingsManager} /> :\r\n        <Centered>{noSettingsAvailableLabel.current}</Centered>\r\n      }\r\n    </div>\r\n  );\r\n}\r\n\r\n/** Modal frontstage displaying and editing settings from registered settings providers. See [SettingsManager]($core-react)\r\n * and [SettingsContainer]($core-react).\r\n * @beta\r\n */\r\nexport class SettingsModalFrontstage implements ModalFrontstageInfo {\r\n  public static id = \"appui-react.modalSettingsStage\";\r\n  public title: string = UiFramework.translate(\"settings.settingsStageLabel\");\r\n  constructor(public initialSettingsTabId?: string) { }\r\n  public notifyCloseRequest = true;\r\n  public get content(): React.ReactNode {\r\n    return (<ModalSettingsStage initialSettingsTabId={this.initialSettingsTabId} />);\r\n  }\r\n  private static noSettingsAvailable = () => new ConditionalBooleanValue(() => 0 === UiFramework.settingsManager.providers.length, [SyncUiEventId.SettingsProvidersChanged]);\r\n\r\n  public static getBackstageActionItem(groupPriority: number, itemPriority: number) {\r\n    return BackstageItemUtilities.createActionItem(SettingsModalFrontstage.id, groupPriority, itemPriority, () => UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage()), // eslint-disable-line deprecation/deprecation\r\n      UiFramework.translate(\"settings.settingsStageLabel\"),\r\n      undefined, IconSpecUtilities.createWebComponentIconSpec(settingsIconSvg), { isHidden: SettingsModalFrontstage.noSettingsAvailable() });\r\n  }\r\n\r\n  public static showSettingsStage(initialSettingsTab?: string) {\r\n    if (UiFramework.settingsManager.providers.length) {\r\n      // Check to see if it is already open\r\n      // istanbul ignore else\r\n      if (UiFramework.frontstages.activeModalFrontstage && UiFramework.frontstages.activeModalFrontstage instanceof SettingsModalFrontstage) {\r\n        if (initialSettingsTab) {\r\n          UiFramework.settingsManager.activateSettingsTab(initialSettingsTab);\r\n          return;\r\n        }\r\n      }\r\n      UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage(initialSettingsTab));\r\n    } else {\r\n      const briefMessage = UiFramework.translate(\"settings.noSettingsAvailable\");\r\n      const detailedMessage = UiFramework.translate(\"settings.noSettingsProvidersRegistered\");\r\n      const info = new NotifyMessageDetails(OutputMessagePriority.Info, briefMessage, detailedMessage, OutputMessageType.Toast);\r\n      IModelApp.notifications.outputMessage(info);\r\n      Logger.logInfo(UiFramework.loggerCategory(this), detailedMessage);\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ModalSettingsStage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/ModalSettingsStage.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,qCAAmC;AACnC,+BAA+B;AAC/B,0DAA2G;AAC3G,4EAAwE;AACxE,wDAAiH;AACjH,sDAA6C;AAC7C,kDAAgE;AAEhE,gDAA6C;AAC7C,2EAAgE;AAChE,6CAA0C;AAE1C,SAAS,kBAAkB,CAAC,EAAE,oBAAoB,EAAqC;;IACrF,MAAM,EAAE,GAAG,MAAA,MAAA,yBAAW,CAAC,WAAW,CAAC,mBAAmB,0CAAE,EAAE,mCAAI,MAAM,CAAC;IACrE,MAAM,UAAU,GAAG,MAAA,MAAA,yBAAW,CAAC,WAAW,CAAC,mBAAmB,0CAAE,KAAK,mCAAI,uBAAU,CAAC,OAAO,CAAC;IAC5F,MAAM,UAAU,GAAG,yBAAW,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC;IACjF,MAAM,wBAAwB,GAAG,KAAK,CAAC,MAAM,CAAC,yBAAW,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAErG,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QAChD,MAAM,cAAc,GAAG,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACrH,IAAI,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACxF,IAAI,CAAC,QAAQ;YACX,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAC;QACtF,OAAO,QAAQ,CAAC;IAClB,CAAC,EAAE,CAAC,oBAAoB,EAAE,UAAU,CAAC,CAAC,CAAC;IAEvC,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,8BAA8B,GAAG,CAAC,EAAE,eAAe,EAAE,cAAc,EAA0C,EAAE,EAAE;YACrH,uBAAuB;YACvB,IAAI,eAAe,YAAY,uBAAuB,IAAI,cAAc,EAAE;gBACxE,yBAAW,CAAC,eAAe,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC;aACpE;QACH,CAAC,CAAC;QACF,OAAO,yBAAW,CAAC,WAAW,CAAC,oCAAoC,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;IAClH,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IAEjB,OAAO,CACL,6BAAK,SAAS,EAAC,yBAAyB,IACrC,UAAU,CAAC,MAAM,CAAC,CAAC;QAClB,oBAAC,8BAAiB,IAAC,IAAI,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,EAAE,eAAe,EAAE,yBAAW,CAAC,eAAe,GAAI,CAAC,CAAC;QACjI,oBAAC,qBAAQ,QAAE,wBAAwB,CAAC,OAAO,CAAY,CAErD,CACP,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAa,uBAAuB;IAGlC,YAAmB,oBAA6B;QAA7B,yBAAoB,GAApB,oBAAoB,CAAS;QADzC,UAAK,GAAW,yBAAW,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QAErE,uBAAkB,GAAG,IAAI,CAAC;IADmB,CAAC;IAErD,IAAW,OAAO;QAChB,OAAO,CAAC,oBAAC,kBAAkB,IAAC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB,GAAI,CAAC,CAAC;IACnF,CAAC;IAGM,MAAM,CAAC,sBAAsB,CAAC,aAAqB,EAAE,YAAoB;QAC9E,OAAO,uCAAsB,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,EAAE,EAAE,aAAa,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,yBAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,uBAAuB,EAAE,CAAC,EAAE,8CAA8C;QACtO,yBAAW,CAAC,SAAS,CAAC,6BAA6B,CAAC,EACpD,SAAS,EAAE,kCAAiB,CAAC,0BAA0B,CAAC,sBAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,uBAAuB,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAAC,kBAA2B;QACzD,IAAI,yBAAW,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE;YAChD,qCAAqC;YACrC,uBAAuB;YACvB,IAAI,yBAAW,CAAC,WAAW,CAAC,qBAAqB,IAAI,yBAAW,CAAC,WAAW,CAAC,qBAAqB,YAAY,uBAAuB,EAAE;gBACrI,IAAI,kBAAkB,EAAE;oBACtB,yBAAW,CAAC,eAAe,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,CAAC;oBACpE,OAAO;iBACR;aACF;YACD,yBAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;SAC9F;aAAM;YACL,MAAM,YAAY,GAAG,yBAAW,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;YAC3E,MAAM,eAAe,GAAG,yBAAW,CAAC,SAAS,CAAC,wCAAwC,CAAC,CAAC;YACxF,MAAM,IAAI,GAAG,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,EAAE,iCAAiB,CAAC,KAAK,CAAC,CAAC;YAC1H,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC5C,qBAAM,CAAC,OAAO,CAAC,yBAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,eAAe,CAAC,CAAC;SACnE;IACH,CAAC;;AAlCH,0DAmCC;AAlCe,0BAAE,GAAG,gCAAgC,CAAC;AAOrC,2CAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,wCAAuB,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,yBAAW,CAAC,eAAe,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,qCAAa,CAAC,wBAAwB,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport \"./ModalSettingsStage.scss\";\nimport * as React from \"react\";\nimport { BackstageItemUtilities, ConditionalBooleanValue, IconSpecUtilities } from \"@itwin/appui-abstract\";\nimport settingsIconSvg from \"@bentley/icons-generic/icons/settings.svg\";\nimport { IModelApp, NotifyMessageDetails, OutputMessagePriority, OutputMessageType } from \"@itwin/core-frontend\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { Centered, SettingsContainer } from \"@itwin/core-react\";\nimport { ModalFrontstageInfo, ModalFrontstageRequestedCloseEventArgs } from \"../framework/FrameworkFrontstages\";\nimport { UiFramework } from \"../UiFramework\";\nimport { SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\nimport { StageUsage } from \"./StageUsage\";\n\nfunction ModalSettingsStage({ initialSettingsTabId }: { initialSettingsTabId?: string }) {\n  const id = UiFramework.frontstages.activeFrontstageDef?.id ?? \"none\";\n  const stageUsage = UiFramework.frontstages.activeFrontstageDef?.usage ?? StageUsage.General;\n  const tabEntries = UiFramework.settingsManager.getSettingEntries(id, stageUsage);\n  const noSettingsAvailableLabel = React.useRef(UiFramework.translate(\"settings.noSettingsAvailable\"));\n\n  const currentSettingsTab = React.useCallback(() => {\n    const categoryToFind = initialSettingsTabId ? initialSettingsTabId.toLowerCase() : tabEntries[0].tabId.toLowerCase();\n    let foundTab = tabEntries.find((entry) => entry.tabId.toLowerCase() === categoryToFind);\n    if (!foundTab)\n      foundTab = tabEntries.find((entry) => entry.label.toLowerCase() === categoryToFind);\n    return foundTab;\n  }, [initialSettingsTabId, tabEntries]);\n\n  React.useEffect(() => {\n    const handleFrontstageCloseRequested = ({ modalFrontstage, stageCloseFunc }: ModalFrontstageRequestedCloseEventArgs) => {\n      // istanbul ignore else\n      if (modalFrontstage instanceof SettingsModalFrontstage && stageCloseFunc) {\n        UiFramework.settingsManager.closeSettingsContainer(stageCloseFunc);\n      }\n    };\n    return UiFramework.frontstages.onCloseModalFrontstageRequestedEvent.addListener(handleFrontstageCloseRequested);\n  }, [tabEntries]);\n\n  return (\n    <div className=\"uifw-settings-container\">\n      {tabEntries.length ?\n        <SettingsContainer tabs={tabEntries} currentSettingsTab={currentSettingsTab()} settingsManager={UiFramework.settingsManager} /> :\n        <Centered>{noSettingsAvailableLabel.current}</Centered>\n      }\n    </div>\n  );\n}\n\n/** Modal frontstage displaying and editing settings from registered settings providers. See [SettingsManager]($core-react)\n * and [SettingsContainer]($core-react).\n * @beta\n */\nexport class SettingsModalFrontstage implements ModalFrontstageInfo {\n  public static id = \"appui-react.modalSettingsStage\";\n  public title: string = UiFramework.translate(\"settings.settingsStageLabel\");\n  constructor(public initialSettingsTabId?: string) { }\n  public notifyCloseRequest = true;\n  public get content(): React.ReactNode {\n    return (<ModalSettingsStage initialSettingsTabId={this.initialSettingsTabId} />);\n  }\n  private static noSettingsAvailable = () => new ConditionalBooleanValue(() => 0 === UiFramework.settingsManager.providers.length, [SyncUiEventId.SettingsProvidersChanged]);\n\n  public static getBackstageActionItem(groupPriority: number, itemPriority: number) {\n    return BackstageItemUtilities.createActionItem(SettingsModalFrontstage.id, groupPriority, itemPriority, () => UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage()), // eslint-disable-line deprecation/deprecation\n      UiFramework.translate(\"settings.settingsStageLabel\"),\n      undefined, IconSpecUtilities.createWebComponentIconSpec(settingsIconSvg), { isHidden: SettingsModalFrontstage.noSettingsAvailable() });\n  }\n\n  public static showSettingsStage(initialSettingsTab?: string) {\n    if (UiFramework.settingsManager.providers.length) {\n      // Check to see if it is already open\n      // istanbul ignore else\n      if (UiFramework.frontstages.activeModalFrontstage && UiFramework.frontstages.activeModalFrontstage instanceof SettingsModalFrontstage) {\n        if (initialSettingsTab) {\n          UiFramework.settingsManager.activateSettingsTab(initialSettingsTab);\n          return;\n        }\n      }\n      UiFramework.frontstages.openModalFrontstage(new SettingsModalFrontstage(initialSettingsTab));\n    } else {\n      const briefMessage = UiFramework.translate(\"settings.noSettingsAvailable\");\n      const detailedMessage = UiFramework.translate(\"settings.noSettingsProvidersRegistered\");\n      const info = new NotifyMessageDetails(OutputMessagePriority.Info, briefMessage, detailedMessage, OutputMessageType.Toast);\n      IModelApp.notifications.outputMessage(info);\n      Logger.logInfo(UiFramework.loggerCategory(this), detailedMessage);\n    }\n  }\n}\n"]}

package/lib/cjs/appui-react/frontstage/ModalSettingsStage.scss

@@ -1,14 +1,14 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
-@import "~@itwin/core-react/lib/cjs/core-react/base/base";
-
-.uifw-settings-container {
-  box-sizing: border-box;
-  height: 100%;
-  width: 100%;
-  overflow: hidden;
-  background-color: $buic-background-3;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+@import "~@itwin/core-react/lib/cjs/core-react/style/themecolors";
+@import "~@itwin/core-react/lib/cjs/core-react/base/base";
+
+.uifw-settings-container {
+  box-sizing: border-box;
+  height: 100%;
+  width: 100%;
+  overflow: hidden;
+  background-color: $buic-background-3;
 }

package/lib/cjs/appui-react/frontstage/NestedFrontstage.d.ts

@@ -1,13 +1,13 @@
-/** @packageDocumentation
- * @module Frontstage
- */
-import { CommandItemDef } from "../shared/CommandItemDef";
-/**
- * Nested Frontstage related classes and commands
- * @public
- */
-export declare class NestedFrontstage {
-    /** Command that returns to the previous Frontstage */
-    static get backToPreviousFrontstageCommand(): CommandItemDef;
-}
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import { CommandItemDef } from "../shared/CommandItemDef";
+/**
+ * Nested Frontstage related classes and commands
+ * @public
+ */
+export declare class NestedFrontstage {
+    /** Command that returns to the previous Frontstage */
+    static get backToPreviousFrontstageCommand(): CommandItemDef;
+}
 //# sourceMappingURL=NestedFrontstage.d.ts.map

package/lib/cjs/appui-react/frontstage/NestedFrontstage.js

@@ -1,31 +1,31 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NestedFrontstage = void 0;
-const CommandItemDef_1 = require("../shared/CommandItemDef");
-const UiFramework_1 = require("../UiFramework");
-/**
- * Nested Frontstage related classes and commands
- * @public
- */
-class NestedFrontstage {
-    /** Command that returns to the previous Frontstage */
-    static get backToPreviousFrontstageCommand() {
-        return new CommandItemDef_1.CommandItemDef({
-            commandId: "backToPreviousFrontstage",
-            iconSpec: "icon-progress-backward",
-            labelKey: "UiFramework:commands.backToPreviousFrontstage",
-            execute: async () => {
-                await UiFramework_1.UiFramework.frontstages.closeNestedFrontstage();
-            },
-        });
-    }
-}
-exports.NestedFrontstage = NestedFrontstage;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NestedFrontstage = void 0;
+const CommandItemDef_1 = require("../shared/CommandItemDef");
+const UiFramework_1 = require("../UiFramework");
+/**
+ * Nested Frontstage related classes and commands
+ * @public
+ */
+class NestedFrontstage {
+    /** Command that returns to the previous Frontstage */
+    static get backToPreviousFrontstageCommand() {
+        return new CommandItemDef_1.CommandItemDef({
+            commandId: "backToPreviousFrontstage",
+            iconSpec: "icon-progress-backward",
+            labelKey: "UiFramework:commands.backToPreviousFrontstage",
+            execute: async () => {
+                await UiFramework_1.UiFramework.frontstages.closeNestedFrontstage();
+            },
+        });
+    }
+}
+exports.NestedFrontstage = NestedFrontstage;
 //# sourceMappingURL=NestedFrontstage.js.map

package/lib/cjs/appui-react/frontstage/NestedFrontstage.js.map

@@ -1 +1 @@
-{"version":3,"file":"NestedFrontstage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/NestedFrontstage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6DAA0D;AAC1D,gDAA6C;AAE7C;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,sDAAsD;IAC/C,MAAM,KAAK,+BAA+B;QAC/C,OAAO,IAAI,+BAAc,CAAC;YACxB,SAAS,EAAE,0BAA0B;YACrC,QAAQ,EAAE,wBAAwB;YAClC,QAAQ,EAAE,+CAA+C;YACzD,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,MAAM,yBAAW,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC;YACxD,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAZD,4CAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\n\r\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/**\r\n * Nested Frontstage related classes and commands\r\n * @public\r\n */\r\nexport class NestedFrontstage {\r\n  /** Command that returns to the previous Frontstage */\r\n  public static get backToPreviousFrontstageCommand() {\r\n    return new CommandItemDef({\r\n      commandId: \"backToPreviousFrontstage\",\r\n      iconSpec: \"icon-progress-backward\",\r\n      labelKey: \"UiFramework:commands.backToPreviousFrontstage\",\r\n      execute: async () => {\r\n        await UiFramework.frontstages.closeNestedFrontstage();\r\n      },\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"NestedFrontstage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/NestedFrontstage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,6DAA0D;AAC1D,gDAA6C;AAE7C;;;GAGG;AACH,MAAa,gBAAgB;IAC3B,sDAAsD;IAC/C,MAAM,KAAK,+BAA+B;QAC/C,OAAO,IAAI,+BAAc,CAAC;YACxB,SAAS,EAAE,0BAA0B;YACrC,QAAQ,EAAE,wBAAwB;YAClC,QAAQ,EAAE,+CAA+C;YACzD,OAAO,EAAE,KAAK,IAAI,EAAE;gBAClB,MAAM,yBAAW,CAAC,WAAW,CAAC,qBAAqB,EAAE,CAAC;YACxD,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAZD,4CAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\nimport { UiFramework } from \"../UiFramework\";\n\n/**\n * Nested Frontstage related classes and commands\n * @public\n */\nexport class NestedFrontstage {\n  /** Command that returns to the previous Frontstage */\n  public static get backToPreviousFrontstageCommand() {\n    return new CommandItemDef({\n      commandId: \"backToPreviousFrontstage\",\n      iconSpec: \"icon-progress-backward\",\n      labelKey: \"UiFramework:commands.backToPreviousFrontstage\",\n      execute: async () => {\n        await UiFramework.frontstages.closeNestedFrontstage();\n      },\n    });\n  }\n}\n"]}

package/lib/cjs/appui-react/frontstage/StageUsage.d.ts

@@ -1,15 +1,15 @@
-/** @packageDocumentation
- * @module Item
- */
-import { StageUsage as UIA_StageUsage } from "@itwin/appui-abstract";
-/** Standard stage uses. Allows extension to target ui item to include on a stage without
- * knowing the stage name defined in the host application.
- * @beta
- */
-export declare type StageUsage = UIA_StageUsage;
-/** Standard stage uses. Allows extension to target ui item to include on a stage without
- * knowing the stage name defined in the host application.
- * @beta
- */
-export declare const StageUsage: typeof UIA_StageUsage;
+/** @packageDocumentation
+ * @module Item
+ */
+import { StageUsage as UIA_StageUsage } from "@itwin/appui-abstract";
+/** Standard stage uses. Allows extension to target ui item to include on a stage without
+ * knowing the stage name defined in the host application.
+ * @beta
+ */
+export declare type StageUsage = UIA_StageUsage;
+/** Standard stage uses. Allows extension to target ui item to include on a stage without
+ * knowing the stage name defined in the host application.
+ * @beta
+ */
+export declare const StageUsage: typeof UIA_StageUsage;
 //# sourceMappingURL=StageUsage.d.ts.map

package/lib/cjs/appui-react/frontstage/StageUsage.js

@@ -1,17 +1,17 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Item
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StageUsage = void 0;
-const appui_abstract_1 = require("@itwin/appui-abstract");
-/** Standard stage uses. Allows extension to target ui item to include on a stage without
- * knowing the stage name defined in the host application.
- * @beta
- */
-exports.StageUsage = appui_abstract_1.StageUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Item
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StageUsage = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** Standard stage uses. Allows extension to target ui item to include on a stage without
+ * knowing the stage name defined in the host application.
+ * @beta
+ */
+exports.StageUsage = appui_abstract_1.StageUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation
 //# sourceMappingURL=StageUsage.js.map

package/lib/cjs/appui-react/frontstage/StageUsage.js.map

@@ -1 +1 @@
-{"version":3,"file":"StageUsage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StageUsage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAqE;AAQrE;;;GAGG;AACU,QAAA,UAAU,GAAG,2BAAc,CAAC,CAAC,+EAA+E","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\nimport { StageUsage as UIA_StageUsage } from \"@itwin/appui-abstract\";\r\n\r\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\r\n * knowing the stage name defined in the host application.\r\n * @beta\r\n */\r\nexport type StageUsage = UIA_StageUsage; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\r\n * knowing the stage name defined in the host application.\r\n * @beta\r\n */\r\nexport const StageUsage = UIA_StageUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation\r\n"]}
+{"version":3,"file":"StageUsage.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StageUsage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAAqE;AAQrE;;;GAGG;AACU,QAAA,UAAU,GAAG,2BAAc,CAAC,CAAC,+EAA+E","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Item\n */\n\nimport { StageUsage as UIA_StageUsage } from \"@itwin/appui-abstract\";\n\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\n * knowing the stage name defined in the host application.\n * @beta\n */\nexport type StageUsage = UIA_StageUsage; // eslint-disable-line deprecation/deprecation\n\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\n * knowing the stage name defined in the host application.\n * @beta\n */\nexport const StageUsage = UIA_StageUsage; // eslint-disable-line @typescript-eslint/no-redeclare, deprecation/deprecation\n"]}

package/lib/cjs/appui-react/frontstage/StandardFrontstageProvider.d.ts

@@ -1,77 +1,77 @@
-/** @packageDocumentation
- * @module Frontstage
- */
-import * as React from "react";
-import { StageUsage } from "@itwin/appui-abstract";
-import { StagePanelProps } from "../stagepanels/StagePanel";
-import { ContentGroupProps, ContentGroupProvider } from "../content/ContentGroup";
-import { FrontstageProvider } from "./FrontstageProvider";
-import { FrontstageProps } from "./Frontstage";
-import { ToolItemDef } from "../shared/ToolItemDef";
-/** Properties of a [[WidgetPanelProps]] component
- * @public
- */
-export declare type WidgetPanelProps = Omit<StagePanelProps, "widgets" | "runtimeProps" | "header" | "allowedZones" | "panelZones">;
-/**
- * Props for [[StandardFrontstageProvider]]
- * @public
- */
-export interface StandardFrontstageProps {
-    id: string;
-    version?: number;
-    usage: StageUsage | string;
-    /** Definition of available content groups or a function that provides them */
-    contentGroupProps: ContentGroupProps | ContentGroupProvider;
-    /** Specify button to use to open backstage. Leave undefined for no backstage button.
-     * ```
-     * <BackstageAppButton icon={"icon-bentley-systems"} />
-     * ```
-     * Custom corner button definition
-     * ```
-     * const cornerButton = <BackstageAppButton icon={"icon-bentley-systems"}
-     *   label="Toggle Backstage display",
-     *   execute={() => BackstageManager.getBackstageToggleCommand().execute()} />;
-     * ```
-     */
-    cornerButton?: React.ReactNode;
-    /** Set to true if default Navigation aid is not desired */
-    hideNavigationAid?: boolean;
-    /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */
-    hideToolSettings?: boolean;
-    /** Set to true if no status bar is needed in stage */
-    hideStatusBar?: boolean;
-    /** Props used to set initial size and state of panel. Defaults to:
-     *  {size: 300, pinned=false, defaultState:StagePanelState.Minimized} */
-    leftPanelProps?: WidgetPanelProps;
-    /** Props used to set initial size and state of panel. Defaults to:
-     *  {size: 90, pinned=false, defaultState:StagePanelState.Minimized} */
-    topPanelProps?: WidgetPanelProps;
-    /** Props used to set initial size and state of panel. Defaults to:
-     *  {size: 200, pinned=true, defaultState:StagePanelState.Open} */
-    rightPanelProps?: WidgetPanelProps;
-    /** Props used to set initial size and state of panel. Defaults to:
-     *  {size: 180, pinned=true, defaultState:StagePanelState.Open} */
-    bottomPanelProps?: WidgetPanelProps;
-    /** Application data is not require but exists for stages to pass feature settings to UiItemsProviders.
-     * It is expected that the UiItemsProvider supply an xxxAppData interface to define the properties it
-     * supports. See [[DefaultContentToolsAppData]] for an example.
-     */
-    applicationData?: any;
-    /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.
-     * Most of the time, this is the Element Selection Tool (CoreTools.selectElementCommand).
-     * Your app can specify its own tool or another core tool as default with this property.
-     */
-    defaultTool?: ToolItemDef;
-}
-/**
- * FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
- * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).
- * @public
- */
-export declare class StandardFrontstageProvider extends FrontstageProvider {
-    private props;
-    constructor(props: StandardFrontstageProps);
-    get id(): string;
-    get frontstage(): React.ReactElement<FrontstageProps>;
-}
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import * as React from "react";
+import { StageUsage } from "@itwin/appui-abstract";
+import { StagePanelProps } from "../stagepanels/StagePanel";
+import { ContentGroupProps, ContentGroupProvider } from "../content/ContentGroup";
+import { FrontstageProvider } from "./FrontstageProvider";
+import { FrontstageProps } from "./Frontstage";
+import { ToolItemDef } from "../shared/ToolItemDef";
+/** Properties of a [[WidgetPanelProps]] component
+ * @public
+ */
+export declare type WidgetPanelProps = Omit<StagePanelProps, "widgets" | "runtimeProps" | "header" | "allowedZones" | "panelZones">;
+/**
+ * Props for [[StandardFrontstageProvider]]
+ * @public
+ */
+export interface StandardFrontstageProps {
+    id: string;
+    version?: number;
+    usage: StageUsage | string;
+    /** Definition of available content groups or a function that provides them */
+    contentGroupProps: ContentGroupProps | ContentGroupProvider;
+    /** Specify button to use to open backstage. Leave undefined for no backstage button.
+     * ```
+     * <BackstageAppButton icon={"icon-bentley-systems"} />
+     * ```
+     * Custom corner button definition
+     * ```
+     * const cornerButton = <BackstageAppButton icon={"icon-bentley-systems"}
+     *   label="Toggle Backstage display",
+     *   execute={() => BackstageManager.getBackstageToggleCommand().execute()} />;
+     * ```
+     */
+    cornerButton?: React.ReactNode;
+    /** Set to true if default Navigation aid is not desired */
+    hideNavigationAid?: boolean;
+    /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */
+    hideToolSettings?: boolean;
+    /** Set to true if no status bar is needed in stage */
+    hideStatusBar?: boolean;
+    /** Props used to set initial size and state of panel. Defaults to:
+     *  {size: 300, pinned=false, defaultState:StagePanelState.Minimized} */
+    leftPanelProps?: WidgetPanelProps;
+    /** Props used to set initial size and state of panel. Defaults to:
+     *  {size: 90, pinned=false, defaultState:StagePanelState.Minimized} */
+    topPanelProps?: WidgetPanelProps;
+    /** Props used to set initial size and state of panel. Defaults to:
+     *  {size: 200, pinned=true, defaultState:StagePanelState.Open} */
+    rightPanelProps?: WidgetPanelProps;
+    /** Props used to set initial size and state of panel. Defaults to:
+     *  {size: 180, pinned=true, defaultState:StagePanelState.Open} */
+    bottomPanelProps?: WidgetPanelProps;
+    /** Application data is not require but exists for stages to pass feature settings to UiItemsProviders.
+     * It is expected that the UiItemsProvider supply an xxxAppData interface to define the properties it
+     * supports. See [[DefaultContentToolsAppData]] for an example.
+     */
+    applicationData?: any;
+    /** The defaultTool is is started when then frontstage loads and whenever any other tools exit.
+     * Most of the time, this is the Element Selection Tool (CoreTools.selectElementCommand).
+     * Your app can specify its own tool or another core tool as default with this property.
+     */
+    defaultTool?: ToolItemDef;
+}
+/**
+ * FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
+ * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).
+ * @public
+ */
+export declare class StandardFrontstageProvider extends FrontstageProvider {
+    private props;
+    constructor(props: StandardFrontstageProps);
+    get id(): string;
+    get frontstage(): React.ReactElement<FrontstageProps>;
+}
 //# sourceMappingURL=StandardFrontstageProvider.d.ts.map