@itwin/appui-react 4.0.0-dev.2 → 4.0.0-dev.4

package/lib/cjs/appui-react/backstage/BackstageComposerItem.d.ts

@@ -1,30 +1,30 @@
-/** @packageDocumentation
- * @module Backstage
- */
-/// <reference types="react" />
-import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "@itwin/appui-abstract";
-/** @internal */
-export interface BackstageComposerActionItemProps {
-    readonly item: BackstageActionItem;
-}
-/** @internal */
-export declare function BackstageComposerActionItem({ item }: BackstageComposerActionItemProps): JSX.Element;
-/** @internal */
-export interface BackstageComposerStageLauncherProps {
-    readonly item: BackstageStageLauncher;
-}
-/** @internal */
-export declare function BackstageComposerStageLauncher({ item }: BackstageComposerStageLauncherProps): JSX.Element;
-/** Props of [[BackstageComposerItem]] component.
- * @internal
- */
-export interface BackstageComposerItemProps {
-    /** Backstage item to render */
-    readonly item: BackstageItem;
-    readonly providerId?: string;
-}
-/** Item of [[BackstageComposer]].
- * @internal
- */
-export declare function BackstageComposerItem({ item }: BackstageComposerItemProps): JSX.Element;
+/** @packageDocumentation
+ * @module Backstage
+ */
+/// <reference types="react" />
+import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "@itwin/appui-abstract";
+/** @internal */
+export interface BackstageComposerActionItemProps {
+    readonly item: BackstageActionItem;
+}
+/** @internal */
+export declare function BackstageComposerActionItem({ item }: BackstageComposerActionItemProps): JSX.Element;
+/** @internal */
+export interface BackstageComposerStageLauncherProps {
+    readonly item: BackstageStageLauncher;
+}
+/** @internal */
+export declare function BackstageComposerStageLauncher({ item }: BackstageComposerStageLauncherProps): JSX.Element;
+/** Props of [[BackstageComposerItem]] component.
+ * @internal
+ */
+export interface BackstageComposerItemProps {
+    /** Backstage item to render */
+    readonly item: BackstageItem;
+    readonly providerId?: string;
+}
+/** Item of [[BackstageComposer]].
+ * @internal
+ */
+export declare function BackstageComposerItem({ item }: BackstageComposerItemProps): JSX.Element;
 //# sourceMappingURL=BackstageComposerItem.d.ts.map

package/lib/cjs/appui-react/backstage/BackstageComposerItem.js

@@ -1,56 +1,56 @@
-"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 Backstage
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BackstageComposerItem = exports.BackstageComposerStageLauncher = exports.BackstageComposerActionItem = void 0;
-const React = require("react");
-const core_bentley_1 = require("@itwin/core-bentley");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const core_react_1 = require("@itwin/core-react");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
-const FrontstageManager_1 = require("../frontstage/FrontstageManager");
-const BackstageManager_1 = require("./BackstageManager");
-const FrontstageDef_1 = require("../frontstage/FrontstageDef");
-/** @internal */
-function BackstageComposerActionItem({ item }) {
-    const manager = (0, BackstageManager_1.useBackstageManager)();
-    const iconSpec = core_react_1.IconHelper.getIconReactNode(item.icon, item.internalData);
-    const handleClick = React.useCallback(() => {
-        manager.close();
-        item.execute();
-    }, [manager, item]);
-    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: iconSpec }), isActive: appui_abstract_1.ConditionalBooleanValue.getValue(item.isActive), isDisabled: appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: appui_abstract_1.ConditionalStringValue.getValue(item.subtitle), badge: core_react_1.BadgeUtilities.getComponentForBadgeType(item.badgeType) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
-}
-exports.BackstageComposerActionItem = BackstageComposerActionItem;
-/** @internal */
-function BackstageComposerStageLauncher({ item }) {
-    var _a;
-    const manager = (0, BackstageManager_1.useBackstageManager)();
-    const handleClick = React.useCallback(() => {
-        manager.close();
-        if (!FrontstageManager_1.FrontstageManager.hasFrontstage(item.stageId))
-            return core_bentley_1.Logger.logError("BackstageComposerStageLauncher", `Frontstage with id '${item.stageId}' not found`);
-        void FrontstageManager_1.FrontstageManager.setActiveFrontstage(item.stageId);
-    }, [manager, item.stageId]);
-    const activeFrontstageId = (0, FrontstageDef_1.useActiveFrontstageId)();
-    const isActive = appui_abstract_1.ConditionalBooleanValue.getValue((_a = item.isActive) !== null && _a !== void 0 ? _a : item.stageId === activeFrontstageId);
-    const iconSpec = core_react_1.IconHelper.getIconReactNode(item.icon, item.internalData);
-    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: iconSpec }), isActive: isActive, isDisabled: appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: appui_abstract_1.ConditionalStringValue.getValue(item.subtitle), badge: core_react_1.BadgeUtilities.getComponentForBadgeType(item.badgeType) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
-}
-exports.BackstageComposerStageLauncher = BackstageComposerStageLauncher;
-/** Item of [[BackstageComposer]].
- * @internal
- */
-function BackstageComposerItem({ item }) {
-    if ((0, appui_abstract_1.isStageLauncher)(item)) {
-        return (React.createElement(BackstageComposerStageLauncher, { item: item }));
-    }
-    return (React.createElement(BackstageComposerActionItem, { item: item }));
-}
-exports.BackstageComposerItem = BackstageComposerItem;
+"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 Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackstageComposerItem = exports.BackstageComposerStageLauncher = exports.BackstageComposerActionItem = void 0;
+const React = require("react");
+const core_bentley_1 = require("@itwin/core-bentley");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const core_react_1 = require("@itwin/core-react");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const Frontstage_1 = require("../frontstage/Frontstage");
+const FrontstageManager_1 = require("../frontstage/FrontstageManager");
+const BackstageManager_1 = require("./BackstageManager");
+/** @internal */
+function BackstageComposerActionItem({ item }) {
+    const manager = (0, BackstageManager_1.useBackstageManager)();
+    const iconSpec = core_react_1.IconHelper.getIconReactNode(item.icon, item.internalData);
+    const handleClick = React.useCallback(() => {
+        manager.close();
+        item.execute();
+    }, [manager, item]);
+    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: iconSpec }), isActive: appui_abstract_1.ConditionalBooleanValue.getValue(item.isActive), isDisabled: appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: appui_abstract_1.ConditionalStringValue.getValue(item.subtitle), badge: core_react_1.BadgeUtilities.getComponentForBadgeType(item.badgeType) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
+}
+exports.BackstageComposerActionItem = BackstageComposerActionItem;
+/** @internal */
+function BackstageComposerStageLauncher({ item }) {
+    var _a;
+    const manager = (0, BackstageManager_1.useBackstageManager)();
+    const handleClick = React.useCallback(() => {
+        manager.close();
+        if (!FrontstageManager_1.FrontstageManager.hasFrontstage(item.stageId))
+            return core_bentley_1.Logger.logError("BackstageComposerStageLauncher", `Frontstage with id '${item.stageId}' not found`);
+        void FrontstageManager_1.FrontstageManager.setActiveFrontstage(item.stageId);
+    }, [manager, item.stageId]);
+    const activeFrontstageId = (0, Frontstage_1.useActiveFrontstageId)();
+    const isActive = appui_abstract_1.ConditionalBooleanValue.getValue((_a = item.isActive) !== null && _a !== void 0 ? _a : item.stageId === activeFrontstageId);
+    const iconSpec = core_react_1.IconHelper.getIconReactNode(item.icon, item.internalData);
+    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: iconSpec }), isActive: isActive, isDisabled: appui_abstract_1.ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: appui_abstract_1.ConditionalStringValue.getValue(item.subtitle), badge: core_react_1.BadgeUtilities.getComponentForBadgeType(item.badgeType) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
+}
+exports.BackstageComposerStageLauncher = BackstageComposerStageLauncher;
+/** Item of [[BackstageComposer]].
+ * @internal
+ */
+function BackstageComposerItem({ item }) {
+    if ((0, appui_abstract_1.isStageLauncher)(item)) { // eslint-disable-line deprecation/deprecation
+        return (React.createElement(BackstageComposerStageLauncher, { item: item }));
+    }
+    return (React.createElement(BackstageComposerActionItem, { item: item }));
+}
+exports.BackstageComposerItem = BackstageComposerItem;
 //# sourceMappingURL=BackstageComposerItem.js.map

package/lib/cjs/appui-react/backstage/BackstageComposerItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageComposerItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposerItem.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,sDAA6C;AAC7C,0DAE+B;AAC/B,kDAAqE;AACrE,kEAA8E;AAC9E,uEAAoE;AACpE,yDAAyD;AACzD,+DAAoE;AAOpE,gBAAgB;AAChB,SAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,MAAM,OAAO,GAAG,IAAA,sCAAmB,GAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,uBAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACpB,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzD,UAAU,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,2BAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAvBD,kEAuBC;AAOD,gBAAgB;AAChB,SAAgB,8BAA8B,CAAC,EAAE,IAAI,EAAuC;;IAC1F,MAAM,OAAO,GAAG,IAAA,sCAAmB,GAAE,CAAC;IACtC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,qCAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO,qBAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,kBAAkB,GAAG,IAAA,qCAAqB,GAAE,CAAC;IACnD,MAAM,QAAQ,GAAG,wCAAuB,CAAC,QAAQ,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,CAAC;IACxG,MAAM,QAAQ,GAAG,uBAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3E,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,2BAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AA3BD,wEA2BC;AAWD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,IAAA,gCAAe,EAAC,IAAI,CAAC,EAAE;QACzB,OAAO,CACL,oBAAC,8BAA8B,IAC7B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;KACH;IACD,OAAO,CACL,oBAAC,2BAA2B,IAC1B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;AACJ,CAAC;AAbD,sDAaC","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 Backstage\n */\n\nimport * as React from \"react\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport {\n  BackstageActionItem, BackstageItem, BackstageStageLauncher, ConditionalBooleanValue, ConditionalStringValue, isStageLauncher,\n} from \"@itwin/appui-abstract\";\nimport { BadgeUtilities, Icon, IconHelper } from \"@itwin/core-react\";\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\nimport { useBackstageManager } from \"./BackstageManager\";\nimport { useActiveFrontstageId } from \"../frontstage/FrontstageDef\";\n\n/** @internal */\nexport interface BackstageComposerActionItemProps {\n  readonly item: BackstageActionItem;\n}\n\n/** @internal */\nexport function BackstageComposerActionItem({ item }: BackstageComposerActionItemProps) {\n  const manager = useBackstageManager();\n  const iconSpec = IconHelper.getIconReactNode(item.icon, item.internalData);\n  const handleClick = React.useCallback(() => {\n    manager.close();\n    item.execute();\n  }, [manager, item]);\n  return (\n    <NZ_BackstageItem\n      itemId={item.id}\n      providerId={item.providerId}\n      itemPriority={item.itemPriority}\n      groupPriority={item.groupPriority}\n      icon={<Icon iconSpec={iconSpec} />}\n      isActive={ConditionalBooleanValue.getValue(item.isActive)}\n      isDisabled={ConditionalBooleanValue.getValue(item.isDisabled)}\n      onClick={handleClick}\n      subtitle={ConditionalStringValue.getValue(item.subtitle)}\n      badge={BadgeUtilities.getComponentForBadgeType(item.badgeType)}\n    >\n      {ConditionalStringValue.getValue(item.label)}\n    </NZ_BackstageItem>\n  );\n}\n\n/** @internal */\nexport interface BackstageComposerStageLauncherProps {\n  readonly item: BackstageStageLauncher;\n}\n\n/** @internal */\nexport function BackstageComposerStageLauncher({ item }: BackstageComposerStageLauncherProps) {\n  const manager = useBackstageManager();\n  const handleClick = React.useCallback(() => {\n    manager.close();\n    if (!FrontstageManager.hasFrontstage(item.stageId))\n      return Logger.logError(\"BackstageComposerStageLauncher\", `Frontstage with id '${item.stageId}' not found`);\n    void FrontstageManager.setActiveFrontstage(item.stageId);\n  }, [manager, item.stageId]);\n  const activeFrontstageId = useActiveFrontstageId();\n  const isActive = ConditionalBooleanValue.getValue(item.isActive ?? item.stageId === activeFrontstageId);\n  const iconSpec = IconHelper.getIconReactNode(item.icon, item.internalData);\n  return (\n    <NZ_BackstageItem\n      itemId={item.id}\n      providerId={item.providerId}\n      itemPriority={item.itemPriority}\n      groupPriority={item.groupPriority}\n      icon={<Icon iconSpec={iconSpec} />}\n      isActive={isActive}\n      isDisabled={ConditionalBooleanValue.getValue(item.isDisabled)}\n      onClick={handleClick}\n      subtitle={ConditionalStringValue.getValue(item.subtitle)}\n      badge={BadgeUtilities.getComponentForBadgeType(item.badgeType)}\n    >\n      {ConditionalStringValue.getValue(item.label)}\n    </NZ_BackstageItem>\n  );\n}\n\n/** Props of [[BackstageComposerItem]] component.\n * @internal\n */\nexport interface BackstageComposerItemProps {\n  /** Backstage item to render */\n  readonly item: BackstageItem;\n  readonly providerId?: string;\n}\n\n/** Item of [[BackstageComposer]].\n * @internal\n */\nexport function BackstageComposerItem({ item }: BackstageComposerItemProps) {\n  if (isStageLauncher(item)) {\n    return (\n      <BackstageComposerStageLauncher\n        item={item}\n      />\n    );\n  }\n  return (\n    <BackstageComposerActionItem\n      item={item}\n    />\n  );\n}\n"]}
+{"version":3,"file":"BackstageComposerItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposerItem.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,+BAA+B;AAC/B,sDAA6C;AAC7C,0DAE+B;AAC/B,kDAAqE;AACrE,kEAA8E;AAC9E,yDAAiE;AACjE,uEAAoE;AACpE,yDAAyD;AAOzD,gBAAgB;AAChB,SAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,MAAM,OAAO,GAAG,IAAA,sCAAmB,GAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,uBAAU,CAAC,gBAAgB,CAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5E,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IACpB,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzD,UAAU,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,2BAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAvBD,kEAuBC;AAOD,gBAAgB;AAChB,SAAgB,8BAA8B,CAAC,EAAE,IAAI,EAAuC;;IAC1F,MAAM,OAAO,GAAG,IAAA,sCAAmB,GAAE,CAAC;IACtC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,qCAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO,qBAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,qCAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,kBAAkB,GAAG,IAAA,kCAAqB,GAAE,CAAC;IACnD,MAAM,QAAQ,GAAG,wCAAuB,CAAC,QAAQ,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,CAAC;IACxG,MAAM,QAAQ,GAAG,uBAAU,CAAC,gBAAgB,CAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5E,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAI,CAAC,UAAU,EAC3B,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,iBAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,2BAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AA3BD,wEA2BC;AAWD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,IAAA,gCAAe,EAAC,IAAI,CAAC,EAAE,EAAE,8CAA8C;QACzE,OAAO,CACL,oBAAC,8BAA8B,IAC7B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;KACH;IACD,OAAO,CACL,oBAAC,2BAA2B,IAC1B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;AACJ,CAAC;AAbD,sDAaC","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 Backstage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  BackstageActionItem, BackstageItem, BackstageStageLauncher, ConditionalBooleanValue, ConditionalStringValue, isStageLauncher,\r\n} from \"@itwin/appui-abstract\";\r\nimport { BadgeUtilities, Icon, IconHelper } from \"@itwin/core-react\";\r\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { useActiveFrontstageId } from \"../frontstage/Frontstage\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { useBackstageManager } from \"./BackstageManager\";\r\n\r\n/** @internal */\r\nexport interface BackstageComposerActionItemProps {\r\n  readonly item: BackstageActionItem; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** @internal */\r\nexport function BackstageComposerActionItem({ item }: BackstageComposerActionItemProps) {\r\n  const manager = useBackstageManager();\r\n  const iconSpec = IconHelper.getIconReactNode (item.icon, item.internalData);\r\n  const handleClick = React.useCallback(() => {\r\n    manager.close();\r\n    item.execute();\r\n  }, [manager, item]);\r\n  return (\r\n    <NZ_BackstageItem\r\n      itemId={item.id}\r\n      providerId={item.providerId}\r\n      itemPriority={item.itemPriority}\r\n      groupPriority={item.groupPriority}\r\n      icon={<Icon iconSpec={iconSpec} />}\r\n      isActive={ConditionalBooleanValue.getValue(item.isActive)}\r\n      isDisabled={ConditionalBooleanValue.getValue(item.isDisabled)}\r\n      onClick={handleClick}\r\n      subtitle={ConditionalStringValue.getValue(item.subtitle)}\r\n      badge={BadgeUtilities.getComponentForBadgeType(item.badgeType)}\r\n    >\r\n      {ConditionalStringValue.getValue(item.label)}\r\n    </NZ_BackstageItem>\r\n  );\r\n}\r\n\r\n/** @internal */\r\nexport interface BackstageComposerStageLauncherProps {\r\n  readonly item: BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** @internal */\r\nexport function BackstageComposerStageLauncher({ item }: BackstageComposerStageLauncherProps) {\r\n  const manager = useBackstageManager();\r\n  const handleClick = React.useCallback(() => {\r\n    manager.close();\r\n    if (!FrontstageManager.hasFrontstage(item.stageId))\r\n      return Logger.logError(\"BackstageComposerStageLauncher\", `Frontstage with id '${item.stageId}' not found`);\r\n    void FrontstageManager.setActiveFrontstage(item.stageId);\r\n  }, [manager, item.stageId]);\r\n  const activeFrontstageId = useActiveFrontstageId();\r\n  const isActive = ConditionalBooleanValue.getValue(item.isActive ?? item.stageId === activeFrontstageId);\r\n  const iconSpec = IconHelper.getIconReactNode (item.icon, item.internalData);\r\n  return (\r\n    <NZ_BackstageItem\r\n      itemId={item.id}\r\n      providerId={item.providerId}\r\n      itemPriority={item.itemPriority}\r\n      groupPriority={item.groupPriority}\r\n      icon={<Icon iconSpec={iconSpec} />}\r\n      isActive={isActive}\r\n      isDisabled={ConditionalBooleanValue.getValue(item.isDisabled)}\r\n      onClick={handleClick}\r\n      subtitle={ConditionalStringValue.getValue(item.subtitle)}\r\n      badge={BadgeUtilities.getComponentForBadgeType(item.badgeType)}\r\n    >\r\n      {ConditionalStringValue.getValue(item.label)}\r\n    </NZ_BackstageItem>\r\n  );\r\n}\r\n\r\n/** Props of [[BackstageComposerItem]] component.\r\n * @internal\r\n */\r\nexport interface BackstageComposerItemProps {\r\n  /** Backstage item to render */\r\n  readonly item: BackstageItem; // eslint-disable-line deprecation/deprecation\r\n  readonly providerId?: string;\r\n}\r\n\r\n/** Item of [[BackstageComposer]].\r\n * @internal\r\n */\r\nexport function BackstageComposerItem({ item }: BackstageComposerItemProps) {\r\n  if (isStageLauncher(item)) { // eslint-disable-line deprecation/deprecation\r\n    return (\r\n      <BackstageComposerStageLauncher\r\n        item={item}\r\n      />\r\n    );\r\n  }\r\n  return (\r\n    <BackstageComposerActionItem\r\n      item={item}\r\n    />\r\n  );\r\n}\r\n"]}

package/lib/cjs/appui-react/backstage/BackstageItem.d.ts

@@ -0,0 +1,43 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BackstageActionItem as UIA_BackstageActionItem, BackstageItem as UIA_BackstageItem, BackstageStageLauncher as UIA_BackstageStageLauncher, CommonBackstageItem as UIA_CommonBackstageItem } from "@itwin/appui-abstract";
+/** Used to specify the item type added to the backstage menu.
+ * @deprecated in 3.0. Use type guards instead.
+ * @beta
+ */
+export declare enum BackstageItemType {
+    /** Item that executes an action function */
+    ActionItem = 1,
+    /** Item that activate a stage. */
+    StageLauncher = 2
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @beta
+ */
+export declare type CommonBackstageItem = UIA_CommonBackstageItem;
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @beta
+ */
+export interface BackstageActionItem extends UIA_BackstageActionItem {
+    readonly type: BackstageItemType.ActionItem;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @beta
+ */
+export interface BackstageStageLauncher extends UIA_BackstageStageLauncher {
+    readonly type: BackstageItemType.StageLauncher;
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @beta
+ */
+export declare type BackstageItem = UIA_BackstageItem;
+/** BackstageActionItem type guard.
+ * @beta
+ */
+export declare function isBackstageActionItem(item: BackstageItem): item is UIA_BackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @beta
+ */
+export declare function isBackstageStageLauncher(item: BackstageItem): item is UIA_BackstageStageLauncher;
+//# sourceMappingURL=BackstageItem.d.ts.map

package/lib/cjs/appui-react/backstage/BackstageItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAGL,mBAAmB,IAAI,uBAAuB,EAC9C,aAAa,IAAI,iBAAiB,EAClC,sBAAsB,IAAI,0BAA0B,EACpD,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,uBAAuB,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,aAAa,CAAC;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,CAAC;AAE9C;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,uBAAuB,CAE1F;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,0BAA0B,CAEhG"}

package/lib/cjs/appui-react/backstage/BackstageItem.js

@@ -0,0 +1,37 @@
+"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 Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isBackstageStageLauncher = exports.isBackstageActionItem = exports.BackstageItemType = void 0;
+const appui_abstract_1 = require("@itwin/appui-abstract");
+/** Used to specify the item type added to the backstage menu.
+ * @deprecated in 3.0. Use type guards instead.
+ * @beta
+ */
+var BackstageItemType;
+(function (BackstageItemType) {
+    /** Item that executes an action function */
+    BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
+    /** Item that activate a stage. */
+    BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
+})(BackstageItemType = exports.BackstageItemType || (exports.BackstageItemType = {}));
+/** BackstageActionItem type guard.
+ * @beta
+ */
+function isBackstageActionItem(item) {
+    return (0, appui_abstract_1.isActionItem)(item); // eslint-disable-line deprecation/deprecation
+}
+exports.isBackstageActionItem = isBackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @beta
+ */
+function isBackstageStageLauncher(item) {
+    return (0, appui_abstract_1.isStageLauncher)(item); // eslint-disable-line deprecation/deprecation
+}
+exports.isBackstageStageLauncher = isBackstageStageLauncher;
+//# sourceMappingURL=BackstageItem.js.map

package/lib/cjs/appui-react/backstage/BackstageItem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,0DAO+B;AAE/B;;;GAGG;AACH,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAK5B;AA0BD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,IAAmB;IACvD,OAAO,IAAA,6BAAY,EAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC3E,CAAC;AAFD,sDAEC;AAED;;GAEG;AACH,SAAgB,wBAAwB,CAAC,IAAmB;IAC1D,OAAO,IAAA,gCAAe,EAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC9E,CAAC;AAFD,4DAEC","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 Backstage\r\n */\r\n\r\nimport {\r\n  isActionItem,\r\n  isStageLauncher,\r\n  BackstageActionItem as UIA_BackstageActionItem,\r\n  BackstageItem as UIA_BackstageItem,\r\n  BackstageStageLauncher as UIA_BackstageStageLauncher,\r\n  CommonBackstageItem as UIA_CommonBackstageItem,\r\n} from \"@itwin/appui-abstract\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.0. Use type guards instead.\r\n * @beta\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @beta\r\n */\r\nexport type CommonBackstageItem = UIA_CommonBackstageItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @beta\r\n */\r\nexport interface BackstageActionItem extends UIA_BackstageActionItem { // eslint-disable-line deprecation/deprecation\r\n  readonly type: BackstageItemType.ActionItem; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @beta\r\n */\r\nexport interface BackstageStageLauncher extends UIA_BackstageStageLauncher { // eslint-disable-line deprecation/deprecation\r\n  readonly type: BackstageItemType.StageLauncher; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @beta\r\n */\r\nexport type BackstageItem = UIA_BackstageItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @beta\r\n */\r\nexport function isBackstageActionItem(item: BackstageItem): item is UIA_BackstageActionItem { // eslint-disable-line deprecation/deprecation\r\n  return isActionItem(item); // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @beta\r\n */\r\nexport function isBackstageStageLauncher(item: BackstageItem): item is UIA_BackstageStageLauncher { // eslint-disable-line deprecation/deprecation\r\n  return isStageLauncher(item); // eslint-disable-line deprecation/deprecation\r\n}\r\n"]}

package/lib/cjs/appui-react/backstage/BackstageItemProps.d.ts

@@ -0,0 +1,49 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { StringGetter } from "@itwin/appui-abstract";
+import { IconProps, IconSpec } from "@itwin/core-react";
+/** Base properties for a [[Backstage]] item.
+ * @public
+ * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead
+ */
+export interface BackstageItemProps extends IconProps {
+    /** if set, component will be enabled - defaults to true */
+    isEnabled?: boolean;
+    /** if set, component will be shown with as the active item - defaults to false */
+    isActive?: boolean;
+    /** optional function to set state of backstage item */
+    stateFunc?: (state: Readonly<BackstageItemState>) => BackstageItemState;
+    /** optional SyncUi event ids that will trigger the state function to run. */
+    stateSyncIds?: string[];
+    /** if set, it is used to explicitly set the label shown by a component. */
+    label?: string | StringGetter;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    labelKey?: string;
+    /** if set, it is used to explicitly set the description shown by a component. */
+    description?: string | StringGetter;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */
+    descriptionKey?: string;
+    /** used to explicitly set the tooltip shown by a component. */
+    tooltip?: string | StringGetter;
+    /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */
+    tooltipKey?: string;
+}
+/** Properties that define the state of a Backstage items.
+ * @public
+ * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead
+ */
+export interface BackstageItemState {
+    isEnabled: boolean;
+    label: string;
+    subtitle: string;
+    tooltip: string;
+    iconSpec: IconSpec;
+    isActive?: boolean;
+}
+/** Helper method to set backstage item state from props.
+ * @public
+ * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead
+ */
+export declare const getBackstageItemStateFromProps: (props: BackstageItemProps) => BackstageItemState;
+//# sourceMappingURL=BackstageItemProps.d.ts.map

package/lib/cjs/appui-react/backstage/BackstageItemProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemProps.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemProps.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAGxD;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACnD,2DAA2D;IAC3D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uDAAuD;IACvD,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,KAAK,kBAAkB,CAAC;IACxE,6EAA6E;IAC7E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IAC9B,6IAA6I;IAC7I,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IACpC,mJAAmJ;IACnJ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,+DAA+D;IAC/D,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC;IAChC,6IAA6I;IAC7I,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;GAGG;AAEH,eAAO,MAAM,8BAA8B,UAAW,kBAAkB,KAAG,kBAG1E,CAAC"}

package/lib/cjs/appui-react/backstage/BackstageItemProps.js

@@ -0,0 +1,22 @@
+"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 Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBackstageItemStateFromProps = void 0;
+const BackstageItemUtilities_1 = require("./BackstageItemUtilities");
+/** Helper method to set backstage item state from props.
+ * @public
+ * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead
+ */
+// istanbul ignore next
+const getBackstageItemStateFromProps = (props) => {
+    // eslint-disable-next-line deprecation/deprecation
+    return BackstageItemUtilities_1.BackstageItemUtilities.getBackstageItemStateFromProps(props);
+};
+exports.getBackstageItemStateFromProps = getBackstageItemStateFromProps;
+//# sourceMappingURL=BackstageItemProps.js.map

package/lib/cjs/appui-react/backstage/BackstageItemProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemProps.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemProps.tsx"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH,qEAAkE;AA0ClE;;;GAGG;AACH,uBAAuB;AAChB,MAAM,8BAA8B,GAAG,CAAC,KAAyB,EAAsB,EAAE;IAC9F,mDAAmD;IACnD,OAAO,+CAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;AACtE,CAAC,CAAC;AAHW,QAAA,8BAA8B,kCAGzC","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 Backstage\r\n */\r\n\r\nimport { StringGetter } from \"@itwin/appui-abstract\";\r\nimport { IconProps, IconSpec } from \"@itwin/core-react\";\r\nimport { BackstageItemUtilities } from \"./BackstageItemUtilities\";\r\n\r\n/** Base properties for a [[Backstage]] item.\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead\r\n */\r\nexport interface BackstageItemProps extends IconProps {\r\n  /** if set, component will be enabled - defaults to true */\r\n  isEnabled?: boolean;\r\n  /** if set, component will be shown with as the active item - defaults to false */\r\n  isActive?: boolean;\r\n  /** optional function to set state of backstage item */\r\n  stateFunc?: (state: Readonly<BackstageItemState>) => BackstageItemState; // eslint-disable-line deprecation/deprecation\r\n  /** optional SyncUi event ids that will trigger the state function to run. */\r\n  stateSyncIds?: string[];\r\n  /** if set, it is used to explicitly set the label shown by a component. */\r\n  label?: string | StringGetter;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\r\n  labelKey?: string;\r\n  /** if set, it is used to explicitly set the description shown by a component. */\r\n  description?: string | StringGetter;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if description is not explicitly set. */\r\n  descriptionKey?: string;\r\n  /** used to explicitly set the tooltip shown by a component. */\r\n  tooltip?: string | StringGetter;\r\n  /** if set, it is used to define a key that is used to look up a localized string. This value is used only if label is not explicitly set. */\r\n  tooltipKey?: string;\r\n}\r\n\r\n/** Properties that define the state of a Backstage items.\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead\r\n */\r\nexport interface BackstageItemState {\r\n  isEnabled: boolean;\r\n  label: string;\r\n  subtitle: string;\r\n  tooltip: string;\r\n  iconSpec: IconSpec;\r\n  isActive?: boolean;\r\n}\r\n\r\n/** Helper method to set backstage item state from props.\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageItem]($appui-abstract) instead\r\n */\r\n// istanbul ignore next\r\nexport const getBackstageItemStateFromProps = (props: BackstageItemProps): BackstageItemState => { // eslint-disable-line deprecation/deprecation\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  return BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n};\r\n"]}

package/lib/cjs/appui-react/backstage/BackstageItemUtilities.d.ts

@@ -0,0 +1,19 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BackstageActionItem, BackstageStageLauncher } from "./BackstageItem";
+import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
+/** Utilities for creating and maintaining backstage items
+ * @beta
+ */
+export declare class BackstageItemUtilities {
+    /** Creates a stage launcher backstage item. */
+    static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string | undefined, iconSpec?: string | undefined, overrides?: Partial<BackstageStageLauncher> | undefined) => BackstageStageLauncher;
+    /** Creates an action backstage item. */
+    static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string | undefined, iconSpec?: string | undefined, overrides?: Partial<BackstageActionItem> | undefined) => BackstageActionItem;
+    /** Helper method to set backstage item state from props.
+     * @deprecated in 3.6.
+     */
+    static getBackstageItemStateFromProps: (props: BackstageItemProps) => BackstageItemState;
+}
+//# sourceMappingURL=BackstageItemUtilities.d.ts.map

package/lib/cjs/appui-react/backstage/BackstageItemUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAqB,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE9E;;GAEG;AACH,qBAAa,sBAAsB;IACjC,+CAA+C;IAC/C,OAAc,mBAAmB,iBAAkB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,4HAAsF,sBAAsB,CAU9N;IAEH,wCAAwC;IACxC,OAAc,gBAAgB,WAAY,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,yHAAmF,mBAAmB,CAUpO;IAEH;;OAEG;IACH,OAAc,8BAA8B,UAAW,kBAAkB,KAAG,kBAAkB,CAa5F;CACH"}

package/lib/cjs/appui-react/backstage/BackstageItemUtilities.js

@@ -0,0 +1,59 @@
+"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 Backstage
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackstageItemUtilities = void 0;
+const PropsHelper_1 = require("../utils/PropsHelper");
+const BackstageItem_1 = require("./BackstageItem");
+/** Utilities for creating and maintaining backstage items
+ * @beta
+ */
+class BackstageItemUtilities {
+}
+exports.BackstageItemUtilities = BackstageItemUtilities;
+/** Creates a stage launcher backstage item. */
+BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, iconSpec, overrides) => ({
+    groupPriority,
+    icon: iconSpec,
+    id: frontstageId,
+    itemPriority,
+    type: BackstageItem_1.BackstageItemType.StageLauncher,
+    label,
+    stageId: frontstageId,
+    subtitle,
+    ...overrides,
+});
+/** Creates an action backstage item. */
+BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, iconSpec, overrides) => ({
+    execute,
+    groupPriority,
+    icon: iconSpec,
+    id: itemId,
+    itemPriority,
+    type: BackstageItem_1.BackstageItemType.ActionItem,
+    label,
+    subtitle,
+    ...overrides,
+});
+/** Helper method to set backstage item state from props.
+ * @deprecated in 3.6.
+ */
+BackstageItemUtilities.getBackstageItemStateFromProps = (props) => {
+    const labelSpec = PropsHelper_1.PropsHelper.getStringSpec(props.label, props.labelKey);
+    const subtitleSpec = PropsHelper_1.PropsHelper.getStringSpec(props.description, props.descriptionKey);
+    const tooltipSpec = PropsHelper_1.PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);
+    return {
+        isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */ false,
+        label: PropsHelper_1.PropsHelper.getStringFromSpec(labelSpec),
+        subtitle: PropsHelper_1.PropsHelper.getStringFromSpec(subtitleSpec),
+        tooltip: PropsHelper_1.PropsHelper.getStringFromSpec(tooltipSpec),
+        iconSpec: props.iconSpec,
+        isActive: undefined !== props.isActive ? props.isActive : false,
+    };
+};
+//# sourceMappingURL=BackstageItemUtilities.js.map

package/lib/cjs/appui-react/backstage/BackstageItemUtilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAmD;AACnD,mDAAiG;AAGjG;;GAEG;AACH,MAAa,sBAAsB;;AAAnC,wDA4CC;AA3CC,+CAA+C;AACjC,0CAAmB,GAAG,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAA2C,EAA0B,EAAE,CAAC,CAAC;IACpO,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,IAAI,EAAE,iCAAiB,CAAC,aAAa;IACrC,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,wCAAwC;AAC1B,uCAAgB,GAAG,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAwC,EAAuB,EAAE,CAAC,CAAC;IAC1O,OAAO;IACP,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,IAAI,EAAE,iCAAiB,CAAC,UAAU;IAClC,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH;;GAEG;AACW,qDAA8B,GAAG,CAAC,KAAyB,EAAsB,EAAE;IAC/F,MAAM,SAAS,GAAG,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACxF,MAAM,WAAW,GAAG,yBAAW,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE/E,OAAO;QACL,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,0BAA0B,CAAA,KAAK;QAC5F,KAAK,EAAE,yBAAW,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAC/C,QAAQ,EAAE,yBAAW,CAAC,iBAAiB,CAAC,YAAY,CAAC;QACrD,OAAO,EAAE,yBAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC;QACnD,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;KAChE,CAAC;AACJ,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 Backstage\r\n */\r\n\r\nimport { PropsHelper } from \"../utils/PropsHelper\";\r\nimport { BackstageActionItem, BackstageItemType, BackstageStageLauncher } from \"./BackstageItem\";\r\nimport { BackstageItemProps, BackstageItemState } from \"./BackstageItemProps\";\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item. */\r\n  public static createStageLauncher = (frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher => ({\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    type: BackstageItemType.StageLauncher, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item. */\r\n  public static createActionItem = (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem => ({\r\n    execute,\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: itemId,\r\n    itemPriority,\r\n    type: BackstageItemType.ActionItem, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Helper method to set backstage item state from props.\r\n   * @deprecated in 3.6.\r\n   */\r\n  public static getBackstageItemStateFromProps = (props: BackstageItemProps): BackstageItemState => { // eslint-disable-line deprecation/deprecation\r\n    const labelSpec = PropsHelper.getStringSpec(props.label, props.labelKey);\r\n    const subtitleSpec = PropsHelper.getStringSpec(props.description, props.descriptionKey);\r\n    const tooltipSpec = PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);\r\n\r\n    return {\r\n      isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */false,\r\n      label: PropsHelper.getStringFromSpec(labelSpec),\r\n      subtitle: PropsHelper.getStringFromSpec(subtitleSpec),\r\n      tooltip: PropsHelper.getStringFromSpec(tooltipSpec),\r\n      iconSpec: props.iconSpec,\r\n      isActive: undefined !== props.isActive ? props.isActive : false,\r\n    };\r\n  };\r\n}\r\n"]}

package/lib/cjs/appui-react/backstage/BackstageManager.d.ts

@@ -1,36 +1,36 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BeEvent } from "@itwin/core-bentley";
-import { IconSpec } from "@itwin/core-react";
-import { CommandItemDef } from "../shared/CommandItemDef";
-/** Arguments of [[BackstageManager.onToggled]].
- * @public
- */
-export interface BackstageToggledArgs {
-    readonly isOpen: boolean;
-}
-/** Controls backstage.
- * @public
- */
-export declare class BackstageManager {
-    private _isOpen;
-    /** Event raised when backstage is opened or closed. */
-    readonly onToggled: BeEvent<(args: BackstageToggledArgs) => void>;
-    get isOpen(): boolean;
-    private setIsOpen;
-    open(): void;
-    close(): void;
-    toggle(): void;
-    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
-    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): CommandItemDef;
-}
-/** Hook that returns isOpen flag of the backstage.
- * @public
- */
-export declare const useIsBackstageOpen: (manager: BackstageManager) => boolean;
-/** Hook that returns backstage manager.
- * @public
- */
-export declare const useBackstageManager: () => BackstageManager;
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IconSpec } from "@itwin/core-react";
+import { CommandItemDef } from "../shared/CommandItemDef";
+/** Arguments of [[BackstageManager.onToggled]].
+ * @public
+ */
+export interface BackstageToggledArgs {
+    readonly isOpen: boolean;
+}
+/** Controls backstage.
+ * @public
+ */
+export declare class BackstageManager {
+    private _isOpen;
+    /** Event raised when backstage is opened or closed. */
+    readonly onToggled: BeEvent<(args: BackstageToggledArgs) => void>;
+    get isOpen(): boolean;
+    private setIsOpen;
+    open(): void;
+    close(): void;
+    toggle(): void;
+    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
+    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): CommandItemDef;
+}
+/** Hook that returns isOpen flag of the backstage.
+ * @public
+ */
+export declare const useIsBackstageOpen: (manager: BackstageManager) => boolean;
+/** Hook that returns backstage manager.
+ * @public
+ */
+export declare const useBackstageManager: () => BackstageManager;
 //# sourceMappingURL=BackstageManager.d.ts.map

package/lib/cjs/appui-react/backstage/BackstageManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG1D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,uDAAuD;IACvD,SAAgB,SAAS,iBAAsB,oBAAoB,KAAK,IAAI,EAAI;IAEhF,IAAW,MAAM,YAEhB;IAED,OAAO,CAAC,SAAS;IASV,IAAI;IAIJ,KAAK;IAIL,MAAM;IAIb,mGAAmG;WACrF,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;CAUpE;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,gBAAgB,YAa3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,wBAG/B,CAAC"}
+{"version":3,"file":"BackstageManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,uDAAuD;IACvD,SAAgB,SAAS,iBAAsB,oBAAoB,KAAK,IAAI,EAAI;IAEhF,IAAW,MAAM,YAEhB;IAED,OAAO,CAAC,SAAS;IAUV,IAAI;IAIJ,KAAK;IAIL,MAAM;IAIb,mGAAmG;WACrF,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;CAUpE;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,gBAAgB,YAa3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,wBAG/B,CAAC"}