@itwin/appui-react 4.0.0-dev.1 → 4.0.0-dev.11

package/lib/esm/appui-react/accudraw/SquareButton.scss

@@ -2,44 +2,29 @@
 * 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";
 
 $button-size: 32px;
 
 .uifw-square-button {
   display: flex;
   justify-content: center;
-  background-color: $buic-background-tab-inactive;
-  color: $buic-foreground-body;
-  border-color: $buic-background-toolbutton-stroke;
-  border-radius: 5px;
+  background-color: var(--iui-color-background);
+  color: var(--iui-color-text);
+  border-color: var(--iui-color-border-foreground);
+  border-radius: var(--iui-border-radius-1);
   border-width: 1px;
   border-style: solid;
-  opacity: 0.95;
+  opacity: var(--iui-opacity-2);
   pointer-events: auto;
   margin: 0;
   width: $button-size;
   height: $button-size;
 
-  &:focus {
-    background-color: $buic-background-tab-active;
-    color: $buic-foreground-body;
-    border-color: $buic-background-toolbutton-stroke;
-    opacity: 1.0;
-  }
-
+  &:focus,
   &:hover {
-    background-color: $buic-background-tab-active;
-    color: $buic-foreground-primary;
-    border-color: $buic-background-toolbutton-stroke;
-    opacity: 1.0;
+    background-color: var(--iui-color-background-hover);
+    color: var(--iui-color-text-hover);
+    border-color: var(--iui-color-border-foreground-hover);
+    opacity: var(--iui-opacity-1);
   }
-
-  &:active {
-    background-color: $buic-background-4;
-    color: $buic-foreground-primary;
-    border-color: $buic-background-toolbutton-stroke;
-    opacity: 1.0;
-  }
-
 }

package/lib/esm/appui-react/backstage/BackstageComposer.d.ts

@@ -2,8 +2,8 @@
  * @module Backstage
  */
 import * as React from "react";
-import { BackstageItem } from "@itwin/appui-abstract";
 import { CommonProps } from "@itwin/core-react";
+import { BackstageItem } from "./BackstageItem";
 /** @internal */
 export declare type GroupedItems = ReadonlyArray<ReadonlyArray<BackstageItem>>;
 /** @internal */
@@ -21,7 +21,7 @@ export interface BackstageComposerProps extends CommonProps {
     /** If true and only one stage launcher item is found, do not show entry in backstage */
     readonly hideSoloStageEntry?: boolean;
 }
-/** Backstage component composed from [[BackstageManager]] items.
+/** Backstage component composed from [[UiFramework.backstage]] items.
  * @public
  */
 export declare function BackstageComposer(props: BackstageComposerProps): JSX.Element;

package/lib/esm/appui-react/backstage/BackstageComposer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAoF,MAAM,uBAAuB,CAAC;AACxI,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAwEhD,gBAAgB;AAChB,oBAAY,YAAY,GAAG,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;AAEvE,gBAAgB;AAChB,eAAO,MAAM,eAAe,UAAW,cAAc,aAAa,CAAC,iBA+BlE,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAClC,gGAAgG;IAChG,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,mHAAmH;IACnH,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,wFAAwF;IACxF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,eA0D9D"}
+{"version":3,"file":"BackstageComposer.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposer.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAShD,OAAO,EAAE,aAAa,EAA4B,MAAM,iBAAiB,CAAC;AA2D1E,gBAAgB;AAChB,oBAAY,YAAY,GAAG,aAAa,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;AAEvE,gBAAgB;AAChB,eAAO,MAAM,eAAe,UAAW,cAAc,aAAa,CAAC,iBA+BlE,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW;IACzD,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAClC,gGAAgG;IAChG,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B,mHAAmH;IACnH,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,wFAAwF;IACxF,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,sBAAsB,eAyD9D"}

package/lib/esm/appui-react/backstage/BackstageComposer.js

@@ -6,7 +6,7 @@
  * @module Backstage
  */
 import * as React from "react";
-import { BackstageItemsManager, ConditionalBooleanValue, isStageLauncher } from "@itwin/appui-abstract";
+import { ConditionalBooleanValue } from "@itwin/appui-abstract";
 import { BackstageSeparator, Backstage as NZ_Backstage } from "@itwin/appui-layout-react";
 import { SafeAreaContext } from "../safearea/SafeAreaContext";
 import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
@@ -14,13 +14,20 @@ import { BackstageComposerItem } from "./BackstageComposerItem";
 import { useBackstageManager, useIsBackstageOpen } from "./BackstageManager";
 import { useDefaultBackstageItems } from "./useDefaultBackstageItems";
 import { useUiItemsProviderBackstageItems } from "./useUiItemsProviderBackstageItems";
+import { toLayoutSafeAreaInsets } from "../safearea/SafeAreaHelpers";
+import { isBackstageStageLauncher } from "./BackstageItem";
+import { BackstageItemsManager } from "./BackstageItemsManager";
 // cSpell:ignore safearea
-/* eslint-disable deprecation/deprecation */
 /** Private function to set up sync event monitoring of backstage items */
 function useBackstageItemSyncEffect(itemsManager, syncIdsOfInterest) {
     const isInitialMount = React.useRef(true);
     React.useEffect(() => {
-        const handleSyncUiEvent = (args) => {
+        if (isInitialMount.current) {
+            isInitialMount.current = false;
+            // initialize the display state of any items with syncIds/condition defined
+            itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));
+        }
+        return SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
             if (0 === syncIdsOfInterest.length)
                 return;
             // istanbul ignore else
@@ -28,16 +35,7 @@ function useBackstageItemSyncEffect(itemsManager, syncIdsOfInterest) {
                 // process each item that has interest
                 itemsManager.refreshAffectedItems(args.eventIds);
             }
-        };
-        if (isInitialMount.current) {
-            isInitialMount.current = false;
-            // initialize the display state of any items with syncIds/condition defined
-            itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));
-        }
-        SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
-        return () => {
-            SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);
-        };
+        });
     }, [itemsManager, itemsManager.items, syncIdsOfInterest]);
 }
 /** local function to combine items from Stage and from Extensions */
@@ -61,9 +59,9 @@ function combineItems(stageItems, addonItems, hideSoloStageEntry) {
     }
     if (hideSoloStageEntry) {
         // per user request don't show stage launcher if only one stage is available
-        const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + (isStageLauncher(item) ? 1 : 0), 0);
+        const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + (isBackstageStageLauncher(item) ? 1 : 0), 0);
         if (1 === numberOfFrontstageItems)
-            items = items.filter((item) => !isStageLauncher(item));
+            items = items.filter((item) => !isBackstageStageLauncher(item));
     }
     return items;
 }
@@ -100,7 +98,7 @@ export const useGroupedItems = (items) => {
         return [...sortedGroups].sort((a, b) => a[0].groupPriority - b[0].groupPriority);
     }, [items]);
 };
-/** Backstage component composed from [[BackstageManager]] items.
+/** Backstage component composed from [[UiFramework.backstage]] items.
  * @public
  */
 export function BackstageComposer(props) {
@@ -127,7 +125,7 @@ export function BackstageComposer(props) {
     useBackstageItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
     const combinedBackstageItems = React.useMemo(() => combineItems(defaultItems, addonItems, !!props.hideSoloStageEntry), [defaultItems, addonItems, props.hideSoloStageEntry]);
     const groups = useGroupedItems(combinedBackstageItems);
-    return (React.createElement(NZ_Backstage, { className: props.className, header: props.header, isOpen: isOpen, onClose: handleClose, safeAreaInsets: safeAreaInsets, showOverlay: props.showOverlay, style: props.style }, groups.map((group, groupIndex) => (group.map((item, itemIndex) => {
+    return (React.createElement(NZ_Backstage, { className: props.className, header: props.header, isOpen: isOpen, onClose: handleClose, safeAreaInsets: toLayoutSafeAreaInsets(safeAreaInsets), showOverlay: props.showOverlay, style: props.style }, groups.map((group, groupIndex) => (group.map((item, itemIndex) => {
         const composerItem = (React.createElement(BackstageComposerItem, { item: item, key: item.id }));
         return itemIndex === 0 && groupIndex > 0 ? (React.createElement(React.Fragment, { key: groupIndex },
             React.createElement(BackstageSeparator, null),

package/lib/esm/appui-react/backstage/BackstageComposer.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposer.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAiB,qBAAqB,EAAE,uBAAuB,EAAE,eAAe,EAAmB,MAAM,uBAAuB,CAAC;AAExI,OAAO,EAAE,kBAAkB,EAAE,SAAS,IAAI,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAEtF,yBAAyB;AAEzB,4CAA4C;AAE5C,0EAA0E;AAC1E,SAAS,0BAA0B,CAAC,YAAmC,EAAE,iBAA2B;IAClG,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAE,EAAE;YAClD,IAAI,CAAC,KAAK,iBAAiB,CAAC,MAAM;gBAChC,OAAO;YAET,uBAAuB;YACvB,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAC9F,sCAAsC;gBACtC,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAClD;QACH,CAAC,CAAC;QAEF,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1B,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;YAC/B,2EAA2E;YAC3E,YAAY,CAAC,oBAAoB,CAAC,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC/D;QAED,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnE,OAAO,GAAG,EAAE;YACV,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,qEAAqE;AACrE,SAAS,YAAY,CAAC,UAAwC,EAAE,UAAwC,EAAE,kBAA2B;IACnI,IAAI,KAAK,GAAoB,EAAE,CAAC;IAChC,IAAI,UAAU,CAAC,MAAM,EAAE;QACrB,2DAA2D;QAC3D,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE;gBAC5D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;KACJ;IACD,IAAI,UAAU,CAAC,MAAM,EAAE;QACrB,2DAA2D;QAC3D,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE;gBAC5D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,kBAAkB,EAAE;QACtB,4EAA4E;QAC5E,MAAM,uBAAuB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,WAAW,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACtH,IAAI,CAAC,KAAK,uBAAuB;YAC/B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;KAC1D;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAKD,gBAAgB;AAChB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAmC,EAAgB,EAAE;IACnF,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAe,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvD,IAAI,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACjD,OAAO,GAAG,CAAC;YACb,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3F,IAAI,UAAU,IAAI,CAAC;gBACjB,OAAO;oBACL,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC;oBAC3B;wBACE,GAAG,GAAG,CAAC,UAAU,CAAC;wBAClB,IAAI;qBACL;oBACD,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;iBAC7B,CAAC;YACJ,OAAO;gBACL,GAAG,GAAG;gBACN;oBACE,IAAI;iBACL;aACF,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAe,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/D,MAAM,WAAW,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC;YAC/E,OAAO;gBACL,GAAG,GAAG;gBACN,WAAW;aACZ,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACd,CAAC,CAAC;AAgBF;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7G,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,YAAY,CAAC,OAAO,KAAK,KAAK,CAAC,KAAK,EAAE;YACxC,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;YACnC,sBAAsB,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;SAChE;IACH,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAElB,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,MAAM,YAAY,GAAG,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;IACnE,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IACxH,0BAA0B,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;IAEnE,MAAM,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,qBAAqB,EAAE,CAAC,CAAC;IACxE,MAAM,UAAU,GAAG,gCAAgC,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAC;IAEtE,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7K,MAAM,MAAM,GAAG,eAAe,CAAC,sBAAsB,CAAC,CAAC;IAEvD,OAAO,CACL,oBAAC,YAAY,IACX,SAAS,EAAE,KAAK,CAAC,SAAS,EAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,KAAK,CAAC,WAAW,EAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,IAEjB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,CACjC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;QAC5B,MAAM,YAAY,GAAG,CACnB,oBAAC,qBAAqB,IACpB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,IAAI,CAAC,EAAE,GACZ,CACH,CAAC;QACF,OAAO,SAAS,KAAK,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CACzC,oBAAC,KAAK,CAAC,QAAQ,IAAC,GAAG,EAAE,UAAU;YAC7B,oBAAC,kBAAkB,OAAG;YACrB,YAAY,CACE,CAClB,CAAC,CAAC,CAAC,YAAY,CAAC;IACnB,CAAC,CAAC,CACH,CAAC,CACW,CAChB,CAAC;AACJ,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 * as React from \"react\";\r\nimport { BackstageItem, BackstageItemsManager, ConditionalBooleanValue, isStageLauncher, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { BackstageSeparator, Backstage as NZ_Backstage } from \"@itwin/appui-layout-react\";\r\nimport { SafeAreaContext } from \"../safearea/SafeAreaContext\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { BackstageComposerItem } from \"./BackstageComposerItem\";\r\nimport { useBackstageManager, useIsBackstageOpen } from \"./BackstageManager\";\r\nimport { useDefaultBackstageItems } from \"./useDefaultBackstageItems\";\r\nimport { useUiItemsProviderBackstageItems } from \"./useUiItemsProviderBackstageItems\";\r\n\r\n// cSpell:ignore safearea\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Private function to set up sync event monitoring of backstage items */\r\nfunction useBackstageItemSyncEffect(itemsManager: BackstageItemsManager, syncIdsOfInterest: string[]) {\r\n  const isInitialMount = React.useRef(true);\r\n\r\n  React.useEffect(() => {\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs) => {\r\n      if (0 === syncIdsOfInterest.length)\r\n        return;\r\n\r\n      // istanbul ignore else\r\n      if (syncIdsOfInterest.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n        // process each item that has interest\r\n        itemsManager.refreshAffectedItems(args.eventIds);\r\n      }\r\n    };\r\n\r\n    if (isInitialMount.current) {\r\n      isInitialMount.current = false;\r\n      // initialize the display state of any items with syncIds/condition defined\r\n      itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));\r\n    }\r\n\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n    return () => {\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);\r\n    };\r\n  }, [itemsManager, itemsManager.items, syncIdsOfInterest]);\r\n}\r\n\r\n/** local function to combine items from Stage and from Extensions */\r\nfunction combineItems(stageItems: ReadonlyArray<BackstageItem>, addonItems: ReadonlyArray<BackstageItem>, hideSoloStageEntry: boolean) {\r\n  let items: BackstageItem[] = [];\r\n  if (stageItems.length) {\r\n    // Walk through each and ensure no duplicate ids are added.\r\n    stageItems.forEach((srcItem) => {\r\n      if (-1 === items.findIndex((item) => item.id === srcItem.id)) {\r\n        items.push(srcItem);\r\n      }\r\n    });\r\n  }\r\n  if (addonItems.length) {\r\n    // Walk through each and ensure no duplicate ids are added.\r\n    addonItems.forEach((srcItem) => {\r\n      if (-1 === items.findIndex((item) => item.id === srcItem.id)) {\r\n        items.push(srcItem);\r\n      }\r\n    });\r\n  }\r\n\r\n  if (hideSoloStageEntry) {\r\n    // per user request don't show stage launcher if only one stage is available\r\n    const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + (isStageLauncher(item) ? 1 : 0), 0);\r\n    if (1 === numberOfFrontstageItems)\r\n      items = items.filter((item) => !isStageLauncher(item));\r\n  }\r\n\r\n  return items;\r\n}\r\n\r\n/** @internal */\r\nexport type GroupedItems = ReadonlyArray<ReadonlyArray<BackstageItem>>;\r\n\r\n/** @internal */\r\nexport const useGroupedItems = (items: ReadonlyArray<BackstageItem>): GroupedItems => {\r\n  return React.useMemo(() => {\r\n    const grouped = items.reduce<GroupedItems>((acc, item) => {\r\n      if (ConditionalBooleanValue.getValue(item.isHidden))\r\n        return acc;\r\n      const groupIndex = acc.findIndex((group) => group[0].groupPriority === item.groupPriority);\r\n      if (groupIndex >= 0)\r\n        return [\r\n          ...acc.slice(0, groupIndex),\r\n          [\r\n            ...acc[groupIndex],\r\n            item,\r\n          ],\r\n          ...acc.slice(groupIndex + 1),\r\n        ];\r\n      return [\r\n        ...acc,\r\n        [\r\n          item,\r\n        ],\r\n      ];\r\n    }, []);\r\n    const sortedGroups = grouped.reduce<GroupedItems>((acc, group) => {\r\n      const sortedGroup = [...group].sort((a, b) => a.itemPriority - b.itemPriority);\r\n      return [\r\n        ...acc,\r\n        sortedGroup,\r\n      ];\r\n    }, []);\r\n    return [...sortedGroups].sort((a, b) => a[0].groupPriority - b[0].groupPriority);\r\n  }, [items]);\r\n};\r\n\r\n/** Props of [[BackstageComposer]] component.\r\n * @public\r\n */\r\nexport interface BackstageComposerProps extends CommonProps {\r\n  /** React node for an optional header item */\r\n  readonly header?: React.ReactNode;\r\n  /** Indicates whether to place an overlay over the frontstage when the backstage is displayed */\r\n  readonly showOverlay?: boolean;\r\n  /** List of static backstage items to show. Can be undefined in UiItemsProviders are used to populate backstage. */\r\n  readonly items?: BackstageItem[];\r\n  /** If true and only one stage launcher item is found, do not show entry in backstage */\r\n  readonly hideSoloStageEntry?: boolean;\r\n}\r\n\r\n/** Backstage component composed from [[BackstageManager]] items.\r\n * @public\r\n */\r\nexport function BackstageComposer(props: BackstageComposerProps) {\r\n  const [defaultItemsManager, setDefaultItemsManager] = React.useState(new BackstageItemsManager(props.items));\r\n  const initialItems = React.useRef(props.items);\r\n\r\n  React.useEffect(() => {\r\n    if (initialItems.current !== props.items) {\r\n      initialItems.current = props.items;\r\n      setDefaultItemsManager(new BackstageItemsManager(props.items));\r\n    }\r\n  }, [props.items]);\r\n\r\n  const manager = useBackstageManager();\r\n  const isOpen = useIsBackstageOpen(manager);\r\n  const safeAreaInsets = React.useContext(SafeAreaContext);\r\n  const handleClose = React.useCallback(() => {\r\n    manager.close();\r\n  }, [manager]);\r\n\r\n  const defaultItems = useDefaultBackstageItems(defaultItemsManager);\r\n  const syncIdsOfInterest = React.useMemo(() => BackstageItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);\r\n  useBackstageItemSyncEffect(defaultItemsManager, syncIdsOfInterest);\r\n\r\n  const [addonItemsManager] = React.useState(new BackstageItemsManager());\r\n  const addonItems = useUiItemsProviderBackstageItems(addonItemsManager);\r\n  const addonSyncIdsOfInterest = React.useMemo(() => BackstageItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);\r\n  useBackstageItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);\r\n\r\n  const combinedBackstageItems = React.useMemo(() => combineItems(defaultItems, addonItems, !!props.hideSoloStageEntry), [defaultItems, addonItems, props.hideSoloStageEntry]);\r\n  const groups = useGroupedItems(combinedBackstageItems);\r\n\r\n  return (\r\n    <NZ_Backstage\r\n      className={props.className}\r\n      header={props.header}\r\n      isOpen={isOpen}\r\n      onClose={handleClose}\r\n      safeAreaInsets={safeAreaInsets}\r\n      showOverlay={props.showOverlay}\r\n      style={props.style}\r\n    >\r\n      {groups.map((group, groupIndex) => (\r\n        group.map((item, itemIndex) => {\r\n          const composerItem = (\r\n            <BackstageComposerItem\r\n              item={item}\r\n              key={item.id}\r\n            />\r\n          );\r\n          return itemIndex === 0 && groupIndex > 0 ? (\r\n            <React.Fragment key={groupIndex}>\r\n              <BackstageSeparator />\r\n              {composerItem}\r\n            </React.Fragment>\r\n          ) : composerItem;\r\n        })\r\n      ))}\r\n    </NZ_Backstage>\r\n  );\r\n}\r\n"]}
+{"version":3,"file":"BackstageComposer.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposer.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,EAAE,kBAAkB,EAAE,SAAS,IAAI,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAiB,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,yBAAyB;AAEzB,0EAA0E;AAC1E,SAAS,0BAA0B,CAAC,YAAmC,EAAE,iBAA2B;IAClG,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO,EAAE;YAC1B,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;YAC/B,2EAA2E;YAC3E,YAAY,CAAC,oBAAoB,CAAC,IAAI,GAAG,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC/D;QAED,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,EAAE;YAC9D,IAAI,CAAC,KAAK,iBAAiB,CAAC,MAAM;gBAChC,OAAO;YAET,uBAAuB;YACvB,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBAC9F,sCAAsC;gBACtC,YAAY,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAClD;QACH,CAAC,CAAC,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,qEAAqE;AACrE,SAAS,YAAY,CAAC,UAAwC,EAAE,UAAwC,EAAE,kBAA2B;IACnI,IAAI,KAAK,GAAyB,EAAE,CAAC;IACrC,IAAI,UAAU,CAAC,MAAM,EAAE;QACrB,2DAA2D;QAC3D,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE;gBAC5D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;KACJ;IACD,IAAI,UAAU,CAAC,MAAM,EAAE;QACrB,2DAA2D;QAC3D,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE;gBAC5D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aACrB;QACH,CAAC,CAAC,CAAC;KACJ;IAED,IAAI,kBAAkB,EAAE;QACtB,4EAA4E;QAC5E,MAAM,uBAAuB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,IAAI,EAAE,EAAE,CAAC,WAAW,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/H,IAAI,CAAC,KAAK,uBAAuB;YAC/B,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,CAAC;KACnE;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAKD,gBAAgB;AAChB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,KAAmC,EAAgB,EAAE;IACnF,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACxB,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAe,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACvD,IAAI,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;gBACjD,OAAO,GAAG,CAAC;YACb,MAAM,UAAU,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,aAAa,KAAK,IAAI,CAAC,aAAa,CAAC,CAAC;YAC3F,IAAI,UAAU,IAAI,CAAC;gBACjB,OAAO;oBACL,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,UAAU,CAAC;oBAC3B;wBACE,GAAG,GAAG,CAAC,UAAU,CAAC;wBAClB,IAAI;qBACL;oBACD,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,CAAC;iBAC7B,CAAC;YACJ,OAAO;gBACL,GAAG,GAAG;gBACN;oBACE,IAAI;iBACL;aACF,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAe,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAC/D,MAAM,WAAW,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC;YAC/E,OAAO;gBACL,GAAG,GAAG;gBACN,WAAW;aACZ,CAAC;QACJ,CAAC,EAAE,EAAE,CAAC,CAAC;QACP,OAAO,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AACd,CAAC,CAAC;AAgBF;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA6B;IAC7D,MAAM,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7G,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAE/C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,YAAY,CAAC,OAAO,KAAK,KAAK,CAAC,KAAK,EAAE;YACxC,YAAY,CAAC,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;YACnC,sBAAsB,CAAC,IAAI,qBAAqB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;SAChE;IACH,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IAElB,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACzD,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;IAClB,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,MAAM,YAAY,GAAG,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;IACnE,MAAM,iBAAiB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IACxH,0BAA0B,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;IAEnE,MAAM,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,IAAI,qBAAqB,EAAE,CAAC,CAAC;IACxE,MAAM,UAAU,GAAG,gCAAgC,CAAC,iBAAiB,CAAC,CAAC;IACvE,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,CAAC;IAEtE,MAAM,sBAAsB,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC7K,MAAM,MAAM,GAAG,eAAe,CAAC,sBAAsB,CAAC,CAAC;IACvD,OAAO,CACL,oBAAC,YAAY,IACX,SAAS,EAAE,KAAK,CAAC,SAAS,EAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,EACpB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,WAAW,EACpB,cAAc,EAAE,sBAAsB,CAAC,cAAc,CAAC,EACtD,WAAW,EAAE,KAAK,CAAC,WAAW,EAC9B,KAAK,EAAE,KAAK,CAAC,KAAK,IAEjB,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,CACjC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;QAC5B,MAAM,YAAY,GAAG,CACnB,oBAAC,qBAAqB,IACpB,IAAI,EAAE,IAAI,EACV,GAAG,EAAE,IAAI,CAAC,EAAE,GACZ,CACH,CAAC;QACF,OAAO,SAAS,KAAK,CAAC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CACzC,oBAAC,KAAK,CAAC,QAAQ,IAAC,GAAG,EAAE,UAAU;YAC7B,oBAAC,kBAAkB,OAAG;YACrB,YAAY,CACE,CAClB,CAAC,CAAC,CAAC,YAAY,CAAC;IACnB,CAAC,CAAC,CACH,CAAC,CACW,CAChB,CAAC;AACJ,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 * as React from \"react\";\r\nimport { ConditionalBooleanValue } from \"@itwin/appui-abstract\";\r\nimport { CommonProps } from \"@itwin/core-react\";\r\nimport { BackstageSeparator, Backstage as NZ_Backstage } from \"@itwin/appui-layout-react\";\r\nimport { SafeAreaContext } from \"../safearea/SafeAreaContext\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { BackstageComposerItem } from \"./BackstageComposerItem\";\r\nimport { useBackstageManager, useIsBackstageOpen } from \"./BackstageManager\";\r\nimport { useDefaultBackstageItems } from \"./useDefaultBackstageItems\";\r\nimport { useUiItemsProviderBackstageItems } from \"./useUiItemsProviderBackstageItems\";\r\nimport { toLayoutSafeAreaInsets } from \"../safearea/SafeAreaHelpers\";\r\nimport { BackstageItem, isBackstageStageLauncher } from \"./BackstageItem\";\r\nimport { BackstageItemsManager } from \"./BackstageItemsManager\";\r\n\r\n// cSpell:ignore safearea\r\n\r\n/** Private function to set up sync event monitoring of backstage items */\r\nfunction useBackstageItemSyncEffect(itemsManager: BackstageItemsManager, syncIdsOfInterest: string[]) {\r\n  const isInitialMount = React.useRef(true);\r\n\r\n  React.useEffect(() => {\r\n    if (isInitialMount.current) {\r\n      isInitialMount.current = false;\r\n      // initialize the display state of any items with syncIds/condition defined\r\n      itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));\r\n    }\r\n\r\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {\r\n      if (0 === syncIdsOfInterest.length)\r\n        return;\r\n\r\n      // istanbul ignore else\r\n      if (syncIdsOfInterest.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n        // process each item that has interest\r\n        itemsManager.refreshAffectedItems(args.eventIds);\r\n      }\r\n    });\r\n  }, [itemsManager, itemsManager.items, syncIdsOfInterest]);\r\n}\r\n\r\n/** local function to combine items from Stage and from Extensions */\r\nfunction combineItems(stageItems: ReadonlyArray<BackstageItem>, addonItems: ReadonlyArray<BackstageItem>, hideSoloStageEntry: boolean): ReadonlyArray<BackstageItem> {\r\n  let items: Array<BackstageItem> = [];\r\n  if (stageItems.length) {\r\n    // Walk through each and ensure no duplicate ids are added.\r\n    stageItems.forEach((srcItem) => {\r\n      if (-1 === items.findIndex((item) => item.id === srcItem.id)) {\r\n        items.push(srcItem);\r\n      }\r\n    });\r\n  }\r\n  if (addonItems.length) {\r\n    // Walk through each and ensure no duplicate ids are added.\r\n    addonItems.forEach((srcItem) => {\r\n      if (-1 === items.findIndex((item) => item.id === srcItem.id)) {\r\n        items.push(srcItem);\r\n      }\r\n    });\r\n  }\r\n\r\n  if (hideSoloStageEntry) {\r\n    // per user request don't show stage launcher if only one stage is available\r\n    const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + (isBackstageStageLauncher(item) ? 1 : 0), 0);\r\n    if (1 === numberOfFrontstageItems)\r\n      items = items.filter((item) => !isBackstageStageLauncher(item));\r\n  }\r\n\r\n  return items;\r\n}\r\n\r\n/** @internal */\r\nexport type GroupedItems = ReadonlyArray<ReadonlyArray<BackstageItem>>;\r\n\r\n/** @internal */\r\nexport const useGroupedItems = (items: ReadonlyArray<BackstageItem>): GroupedItems => {\r\n  return React.useMemo(() => {\r\n    const grouped = items.reduce<GroupedItems>((acc, item) => {\r\n      if (ConditionalBooleanValue.getValue(item.isHidden))\r\n        return acc;\r\n      const groupIndex = acc.findIndex((group) => group[0].groupPriority === item.groupPriority);\r\n      if (groupIndex >= 0)\r\n        return [\r\n          ...acc.slice(0, groupIndex),\r\n          [\r\n            ...acc[groupIndex],\r\n            item,\r\n          ],\r\n          ...acc.slice(groupIndex + 1),\r\n        ];\r\n      return [\r\n        ...acc,\r\n        [\r\n          item,\r\n        ],\r\n      ];\r\n    }, []);\r\n    const sortedGroups = grouped.reduce<GroupedItems>((acc, group) => {\r\n      const sortedGroup = [...group].sort((a, b) => a.itemPriority - b.itemPriority);\r\n      return [\r\n        ...acc,\r\n        sortedGroup,\r\n      ];\r\n    }, []);\r\n    return [...sortedGroups].sort((a, b) => a[0].groupPriority - b[0].groupPriority);\r\n  }, [items]);\r\n};\r\n\r\n/** Props of [[BackstageComposer]] component.\r\n * @public\r\n */\r\nexport interface BackstageComposerProps extends CommonProps {\r\n  /** React node for an optional header item */\r\n  readonly header?: React.ReactNode;\r\n  /** Indicates whether to place an overlay over the frontstage when the backstage is displayed */\r\n  readonly showOverlay?: boolean;\r\n  /** List of static backstage items to show. Can be undefined in UiItemsProviders are used to populate backstage. */\r\n  readonly items?: BackstageItem[];\r\n  /** If true and only one stage launcher item is found, do not show entry in backstage */\r\n  readonly hideSoloStageEntry?: boolean;\r\n}\r\n\r\n/** Backstage component composed from [[UiFramework.backstage]] items.\r\n * @public\r\n */\r\nexport function BackstageComposer(props: BackstageComposerProps) {\r\n  const [defaultItemsManager, setDefaultItemsManager] = React.useState(new BackstageItemsManager(props.items));\r\n  const initialItems = React.useRef(props.items);\r\n\r\n  React.useEffect(() => {\r\n    if (initialItems.current !== props.items) {\r\n      initialItems.current = props.items;\r\n      setDefaultItemsManager(new BackstageItemsManager(props.items));\r\n    }\r\n  }, [props.items]);\r\n\r\n  const manager = useBackstageManager();\r\n  const isOpen = useIsBackstageOpen(manager);\r\n  const safeAreaInsets = React.useContext(SafeAreaContext);\r\n  const handleClose = React.useCallback(() => {\r\n    manager.close();\r\n  }, [manager]);\r\n\r\n  const defaultItems = useDefaultBackstageItems(defaultItemsManager);\r\n  const syncIdsOfInterest = React.useMemo(() => BackstageItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);\r\n  useBackstageItemSyncEffect(defaultItemsManager, syncIdsOfInterest);\r\n\r\n  const [addonItemsManager] = React.useState(new BackstageItemsManager());\r\n  const addonItems = useUiItemsProviderBackstageItems(addonItemsManager);\r\n  const addonSyncIdsOfInterest = React.useMemo(() => BackstageItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);\r\n  useBackstageItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);\r\n\r\n  const combinedBackstageItems = React.useMemo(() => combineItems(defaultItems, addonItems, !!props.hideSoloStageEntry), [defaultItems, addonItems, props.hideSoloStageEntry]);\r\n  const groups = useGroupedItems(combinedBackstageItems);\r\n  return (\r\n    <NZ_Backstage\r\n      className={props.className}\r\n      header={props.header}\r\n      isOpen={isOpen}\r\n      onClose={handleClose}\r\n      safeAreaInsets={toLayoutSafeAreaInsets(safeAreaInsets)}\r\n      showOverlay={props.showOverlay}\r\n      style={props.style}\r\n    >\r\n      {groups.map((group, groupIndex) => (\r\n        group.map((item, itemIndex) => {\r\n          const composerItem = (\r\n            <BackstageComposerItem\r\n              item={item}\r\n              key={item.id}\r\n            />\r\n          );\r\n          return itemIndex === 0 && groupIndex > 0 ? (\r\n            <React.Fragment key={groupIndex}>\r\n              <BackstageSeparator />\r\n              {composerItem}\r\n            </React.Fragment>\r\n          ) : composerItem;\r\n        })\r\n      ))}\r\n    </NZ_Backstage>\r\n  );\r\n}\r\n"]}

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

@@ -2,7 +2,7 @@
  * @module Backstage
  */
 /// <reference types="react" />
-import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "@itwin/appui-abstract";
+import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "./BackstageItem";
 /** @internal */
 export interface BackstageComposerActionItemProps {
     readonly item: BackstageActionItem;
@@ -21,7 +21,6 @@ export declare function BackstageComposerStageLauncher({ item }: BackstageCompos
 export interface BackstageComposerItemProps {
     /** Backstage item to render */
     readonly item: BackstageItem;
-    readonly providerId?: string;
 }
 /** Item of [[BackstageComposer]].
  * @internal

package/lib/esm/appui-react/backstage/BackstageComposerItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageComposerItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposerItem.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAIH,OAAO,EACL,mBAAmB,EAAE,aAAa,EAAE,sBAAsB,EAC3D,MAAM,uBAAuB,CAAC;AAO/B,gBAAgB;AAChB,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;CACpC;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAE,EAAE,gCAAgC,eAuBrF;AAED,gBAAgB;AAChB,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACvC;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAAC,EAAE,IAAI,EAAE,EAAE,mCAAmC,eA2B3F;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,IAAI,EAAE,EAAE,0BAA0B,eAazE"}
+{"version":3,"file":"BackstageComposerItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposerItem.tsx"],"names":[],"mappings":"AAIA;;GAEG;;AAUH,OAAO,EAAE,mBAAmB,EAAE,aAAa,EAAE,sBAAsB,EAA4B,MAAM,iBAAiB,CAAC;AAGvH,gBAAgB;AAChB,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,IAAI,EAAE,mBAAmB,CAAC;CACpC;AAED,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAE,EAAE,gCAAgC,eAsBrF;AAED,gBAAgB;AAChB,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACvC;AAED,gBAAgB;AAChB,wBAAgB,8BAA8B,CAAC,EAAE,IAAI,EAAE,EAAE,mCAAmC,eA0B3F;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC;CAC9B;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,EAAE,IAAI,EAAE,EAAE,0BAA0B,eAazE"}

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

@@ -7,21 +7,22 @@
  */
 import * as React from "react";
 import { Logger } from "@itwin/core-bentley";
-import { ConditionalBooleanValue, ConditionalStringValue, isStageLauncher, } from "@itwin/appui-abstract";
-import { BadgeUtilities, Icon, IconHelper } from "@itwin/core-react";
+import { ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { BadgeUtilities, Icon } from "@itwin/core-react";
 import { BackstageItem as NZ_BackstageItem } from "@itwin/appui-layout-react";
-import { useActiveFrontstageId } from "../frontstage/Frontstage";
-import { FrontstageManager } from "../frontstage/FrontstageManager";
 import { useBackstageManager } from "./BackstageManager";
+import { UiFramework } from "../UiFramework";
+import { useActiveFrontstageId } from "../frontstage/FrontstageDef";
+import { isBackstageStageLauncher } from "./BackstageItem";
+import { isProviderItem } from "../ui-items-provider/isProviderItem";
 /** @internal */
 export function BackstageComposerActionItem({ item }) {
     const manager = useBackstageManager();
-    const iconSpec = IconHelper.getIconReactNode(item.icon, item.internalData);
     const handleClick = React.useCallback(() => {
         manager.close();
         item.execute();
     }, [manager, item]);
-    return (React.createElement(NZ_BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(Icon, { iconSpec: iconSpec }), isActive: ConditionalBooleanValue.getValue(item.isActive), isDisabled: ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: ConditionalStringValue.getValue(item.subtitle), badge: BadgeUtilities.getComponentForBadgeType(item.badgeType) }, ConditionalStringValue.getValue(item.label)));
+    return (React.createElement(NZ_BackstageItem, { itemId: item.id, providerId: isProviderItem(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(Icon, { iconSpec: item.icon }), isActive: ConditionalBooleanValue.getValue(item.isActive), isDisabled: ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: ConditionalStringValue.getValue(item.subtitle), badge: BadgeUtilities.getComponentForBadgeType(item.badge) }, ConditionalStringValue.getValue(item.label)));
 }
 /** @internal */
 export function BackstageComposerStageLauncher({ item }) {
@@ -29,20 +30,19 @@ export function BackstageComposerStageLauncher({ item }) {
     const manager = useBackstageManager();
     const handleClick = React.useCallback(() => {
         manager.close();
-        if (!FrontstageManager.hasFrontstage(item.stageId))
+        if (!UiFramework.frontstages.hasFrontstage(item.stageId))
             return Logger.logError("BackstageComposerStageLauncher", `Frontstage with id '${item.stageId}' not found`);
-        void FrontstageManager.setActiveFrontstage(item.stageId);
+        void UiFramework.frontstages.setActiveFrontstage(item.stageId);
     }, [manager, item.stageId]);
     const activeFrontstageId = useActiveFrontstageId();
     const isActive = ConditionalBooleanValue.getValue((_a = item.isActive) !== null && _a !== void 0 ? _a : item.stageId === activeFrontstageId);
-    const iconSpec = IconHelper.getIconReactNode(item.icon, item.internalData);
-    return (React.createElement(NZ_BackstageItem, { itemId: item.id, providerId: item.providerId, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(Icon, { iconSpec: iconSpec }), isActive: isActive, isDisabled: ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: ConditionalStringValue.getValue(item.subtitle), badge: BadgeUtilities.getComponentForBadgeType(item.badgeType) }, ConditionalStringValue.getValue(item.label)));
+    return (React.createElement(NZ_BackstageItem, { itemId: item.id, providerId: isProviderItem(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(Icon, { iconSpec: item.icon }), isActive: isActive, isDisabled: ConditionalBooleanValue.getValue(item.isDisabled), onClick: handleClick, subtitle: ConditionalStringValue.getValue(item.subtitle), badge: BadgeUtilities.getComponentForBadgeType(item.badge) }, ConditionalStringValue.getValue(item.label)));
 }
 /** Item of [[BackstageComposer]].
  * @internal
  */
 export function BackstageComposerItem({ item }) {
-    if (isStageLauncher(item)) { // eslint-disable-line deprecation/deprecation
+    if (isBackstageStageLauncher(item)) {
         return (React.createElement(BackstageComposerStageLauncher, { item: item }));
     }
     return (React.createElement(BackstageComposerActionItem, { item: item }));

package/lib/esm/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,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACuD,uBAAuB,EAAE,sBAAsB,EAAE,eAAe,GAC7H,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAOzD,gBAAgB;AAChB,MAAM,UAAU,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,MAAM,QAAQ,GAAG,UAAU,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,gBAAgB,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,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzD,UAAU,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAOD,gBAAgB;AAChB,MAAM,UAAU,8BAA8B,CAAC,EAAE,IAAI,EAAuC;;IAC1F,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YAChD,OAAO,MAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3D,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IACnD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,CAAC;IACxG,MAAM,QAAQ,GAAG,UAAU,CAAC,gBAAgB,CAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5E,OAAO,CACL,oBAAC,gBAAgB,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,IAAI,IAAC,QAAQ,EAAE,QAAQ,GAAI,EAClC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,IAE7D,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAWD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,eAAe,CAAC,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","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"]}
+{"version":3,"file":"BackstageComposerItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageComposerItem.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAA8D,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AACvH,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAOrE,gBAAgB;AAChB,MAAM,UAAU,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,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,gBAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAC9D,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,IAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,QAAQ,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzD,UAAU,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,IAEzD,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAOD,gBAAgB;AAChB,MAAM,UAAU,8BAA8B,CAAC,EAAE,IAAI,EAAuC;;IAC1F,MAAM,OAAO,GAAG,mBAAmB,EAAE,CAAC;IACtC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE;QACzC,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YACtD,OAAO,MAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjE,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5B,MAAM,kBAAkB,GAAG,qBAAqB,EAAE,CAAC;IACnD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,MAAA,IAAI,CAAC,QAAQ,mCAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,CAAC;IACxG,OAAO,CACL,oBAAC,gBAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,EAC9D,YAAY,EAAE,IAAI,CAAC,YAAY,EAC/B,aAAa,EAAE,IAAI,CAAC,aAAa,EACjC,IAAI,EAAE,oBAAC,IAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAC7D,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EACxD,KAAK,EAAE,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,CAAC,IAEzD,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAUD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,wBAAwB,CAAC,IAAI,CAAC,EAAE;QAClC,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","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 { ConditionalBooleanValue, ConditionalStringValue } from \"@itwin/appui-abstract\";\r\nimport { BadgeUtilities, Icon } from \"@itwin/core-react\";\r\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { useBackstageManager } from \"./BackstageManager\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { useActiveFrontstageId } from \"../frontstage/FrontstageDef\";\r\nimport { BackstageActionItem, BackstageItem, BackstageStageLauncher, isBackstageStageLauncher } from \"./BackstageItem\";\r\nimport { isProviderItem } from \"../ui-items-provider/isProviderItem\";\r\n\r\n/** @internal */\r\nexport interface BackstageComposerActionItemProps {\r\n  readonly item: BackstageActionItem;\r\n}\r\n\r\n/** @internal */\r\nexport function BackstageComposerActionItem({ item }: BackstageComposerActionItemProps) {\r\n  const manager = useBackstageManager();\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={isProviderItem(item) ? item.providerId : undefined}\r\n      itemPriority={item.itemPriority}\r\n      groupPriority={item.groupPriority}\r\n      icon={<Icon iconSpec={item.icon} />}\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.badge)}\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;\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 (!UiFramework.frontstages.hasFrontstage(item.stageId))\r\n      return Logger.logError(\"BackstageComposerStageLauncher\", `Frontstage with id '${item.stageId}' not found`);\r\n    void UiFramework.frontstages.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  return (\r\n    <NZ_BackstageItem\r\n      itemId={item.id}\r\n      providerId={isProviderItem(item) ? item.providerId : undefined}\r\n      itemPriority={item.itemPriority}\r\n      groupPriority={item.groupPriority}\r\n      icon={<Icon iconSpec={item.icon} />}\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.badge)}\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;\r\n}\r\n\r\n/** Item of [[BackstageComposer]].\r\n * @internal\r\n */\r\nexport function BackstageComposerItem({ item }: BackstageComposerItemProps) {\r\n  if (isBackstageStageLauncher(item)) {\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/esm/appui-react/backstage/BackstageItem.d.ts

@@ -1,43 +1,60 @@
 /** @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
-}
+import { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { IconSpec } from "@itwin/core-react";
 /** Describes the data needed to insert a button into the backstage menu.
- * @beta
- */
-export declare type CommonBackstageItem = UIA_CommonBackstageItem;
+ * @public
+ */
+export interface CommonBackstageItem {
+    /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
+    readonly id: string;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badge?: BadgeType;
+    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
+     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
+     * allows extensions enough gaps to insert their own groups.
+     */
+    readonly groupPriority: number;
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon?: IconSpec;
+    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
+    readonly isHidden?: boolean | ConditionalBooleanValue;
+    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
+    readonly isDisabled?: boolean | ConditionalBooleanValue;
+    /** Priority within a group (recommend using values 1 through 100). */
+    readonly itemPriority: number;
+    /** Label. */
+    readonly label: string | ConditionalStringValue;
+    /** Subtitle. */
+    readonly subtitle?: string | ConditionalStringValue;
+    /** Tooltip. */
+    readonly tooltip?: string | ConditionalStringValue;
+    /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
+    readonly isActive?: boolean | ConditionalBooleanValue;
+}
 /** Describes the data needed to insert an action button into the backstage menu.
- * @beta
+ * @public
  */
-export interface BackstageActionItem extends UIA_BackstageActionItem {
-    readonly type: BackstageItemType.ActionItem;
+export interface BackstageActionItem extends CommonBackstageItem {
+    readonly execute: () => void;
 }
 /** Describes the data needed to insert an action button into the backstage menu.
- * @beta
+ * @public
  */
-export interface BackstageStageLauncher extends UIA_BackstageStageLauncher {
-    readonly type: BackstageItemType.StageLauncher;
+export interface BackstageStageLauncher extends CommonBackstageItem {
+    readonly stageId: string;
 }
 /** Describes the data needed to insert a button into the backstage menu.
- * @beta
+ * @public
  */
-export declare type BackstageItem = UIA_BackstageItem;
+export declare type BackstageItem = BackstageActionItem | BackstageStageLauncher;
 /** BackstageActionItem type guard.
- * @beta
+ * @public
  */
-export declare function isBackstageActionItem(item: BackstageItem): item is UIA_BackstageActionItem;
+export declare function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem;
 /** BackstageStageLauncher type guard.
- * @beta
+ * @public
  */
-export declare function isBackstageStageLauncher(item: BackstageItem): item is UIA_BackstageStageLauncher;
+export declare function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher;
 //# sourceMappingURL=BackstageItem.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,mBAAmB,CAEtF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,sBAAsB,CAE5F"}

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

@@ -5,28 +5,16 @@
 /** @packageDocumentation
  * @module Backstage
  */
-import { isActionItem, isStageLauncher, } 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 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 || (BackstageItemType = {}));
 /** BackstageActionItem type guard.
- * @beta
+ * @public
  */
 export function isBackstageActionItem(item) {
-    return isActionItem(item); // eslint-disable-line deprecation/deprecation
+    return "execute" in item;
 }
 /** BackstageStageLauncher type guard.
- * @beta
+ * @public
  */
 export function isBackstageStageLauncher(item) {
-    return isStageLauncher(item); // eslint-disable-line deprecation/deprecation
+    return "stageId" in item;
 }
 //# sourceMappingURL=BackstageItem.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EACZ,eAAe,GAKhB,MAAM,uBAAuB,CAAC;AAE/B;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA0BD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAmB;IACvD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAmB;IAC1D,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC9E,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 {\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"]}
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuDH;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAmB;IACvD,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAmB;IAC1D,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,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 { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from \"@itwin/appui-abstract\";\r\nimport { IconSpec } from \"@itwin/core-react\";\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem {\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badge?: BadgeType;\r\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n   * allows extensions enough gaps to insert their own groups.\r\n   */\r\n  readonly groupPriority: number;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: IconSpec;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem {\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem {\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher;\r\n\r\n/** BackstageActionItem type guard.\r\n * @public\r\n */\r\nexport function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem {\r\n  return \"execute\" in item;\r\n}\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @public\r\n */\r\nexport function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher {\r\n  return \"stageId\" in item;\r\n}\r\n"]}

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

@@ -2,18 +2,13 @@
  * @module Backstage
  */
 import { BackstageActionItem, BackstageStageLauncher } from "./BackstageItem";
-import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
 /** Utilities for creating and maintaining backstage items
  * @beta
  */
-export declare class BackstageItemUtilities {
+export declare namespace 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;
+    function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): 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;
+    function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem;
 }
 //# sourceMappingURL=BackstageItemUtilities.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IACtC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAW/N;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAWrO;CACF"}