@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

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

@@ -1,140 +1,140 @@
-"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.BackstageComposer = exports.useGroupedItems = void 0;
-const React = require("react");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const appui_layout_react_1 = require("@itwin/appui-layout-react");
-const SafeAreaContext_1 = require("../safearea/SafeAreaContext");
-const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
-const BackstageComposerItem_1 = require("./BackstageComposerItem");
-const BackstageManager_1 = require("./BackstageManager");
-const useDefaultBackstageItems_1 = require("./useDefaultBackstageItems");
-const useUiItemsProviderBackstageItems_1 = require("./useUiItemsProviderBackstageItems");
-const SafeAreaHelpers_1 = require("../safearea/SafeAreaHelpers");
-const BackstageItem_1 = require("./BackstageItem");
-const BackstageItemsManager_1 = require("./BackstageItemsManager");
-// cSpell:ignore safearea
-/** Private function to set up sync event monitoring of backstage items */
-function useBackstageItemSyncEffect(itemsManager, syncIdsOfInterest) {
-    const isInitialMount = React.useRef(true);
-    React.useEffect(() => {
-        if (isInitialMount.current) {
-            isInitialMount.current = false;
-            // initialize the display state of any items with syncIds/condition defined
-            itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));
-        }
-        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
-            if (0 === syncIdsOfInterest.length)
-                return;
-            // istanbul ignore else
-            if (syncIdsOfInterest.some((value) => args.eventIds.has(value.toLowerCase()))) {
-                // process each item that has interest
-                itemsManager.refreshAffectedItems(args.eventIds);
-            }
-        });
-    }, [itemsManager, itemsManager.items, syncIdsOfInterest]);
-}
-/** local function to combine items from Stage and from Extensions */
-function combineItems(stageItems, addonItems, hideSoloStageEntry) {
-    let items = [];
-    if (stageItems.length) {
-        // Walk through each and ensure no duplicate ids are added.
-        stageItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                items.push(srcItem);
-            }
-        });
-    }
-    if (addonItems.length) {
-        // Walk through each and ensure no duplicate ids are added.
-        addonItems.forEach((srcItem) => {
-            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
-                items.push(srcItem);
-            }
-        });
-    }
-    if (hideSoloStageEntry) {
-        // per user request don't show stage launcher if only one stage is available
-        const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + ((0, BackstageItem_1.isBackstageStageLauncher)(item) ? 1 : 0), 0);
-        if (1 === numberOfFrontstageItems)
-            items = items.filter((item) => !(0, BackstageItem_1.isBackstageStageLauncher)(item));
-    }
-    return items;
-}
-/** @internal */
-const useGroupedItems = (items) => {
-    return React.useMemo(() => {
-        const grouped = items.reduce((acc, item) => {
-            if (appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden))
-                return acc;
-            const groupIndex = acc.findIndex((group) => group[0].groupPriority === item.groupPriority);
-            if (groupIndex >= 0)
-                return [
-                    ...acc.slice(0, groupIndex),
-                    [
-                        ...acc[groupIndex],
-                        item,
-                    ],
-                    ...acc.slice(groupIndex + 1),
-                ];
-            return [
-                ...acc,
-                [
-                    item,
-                ],
-            ];
-        }, []);
-        const sortedGroups = grouped.reduce((acc, group) => {
-            const sortedGroup = [...group].sort((a, b) => a.itemPriority - b.itemPriority);
-            return [
-                ...acc,
-                sortedGroup,
-            ];
-        }, []);
-        return [...sortedGroups].sort((a, b) => a[0].groupPriority - b[0].groupPriority);
-    }, [items]);
-};
-exports.useGroupedItems = useGroupedItems;
-/** Backstage component composed from [[UiFramework.backstage]] items.
- * @public
- */
-function BackstageComposer(props) {
-    const [defaultItemsManager, setDefaultItemsManager] = React.useState(new BackstageItemsManager_1.BackstageItemsManager(props.items));
-    const initialItems = React.useRef(props.items);
-    React.useEffect(() => {
-        if (initialItems.current !== props.items) {
-            initialItems.current = props.items;
-            setDefaultItemsManager(new BackstageItemsManager_1.BackstageItemsManager(props.items));
-        }
-    }, [props.items]);
-    const manager = (0, BackstageManager_1.useBackstageManager)();
-    const isOpen = (0, BackstageManager_1.useIsBackstageOpen)(manager);
-    const safeAreaInsets = React.useContext(SafeAreaContext_1.SafeAreaContext);
-    const handleClose = React.useCallback(() => {
-        manager.close();
-    }, [manager]);
-    const defaultItems = (0, useDefaultBackstageItems_1.useDefaultBackstageItems)(defaultItemsManager);
-    const syncIdsOfInterest = React.useMemo(() => BackstageItemsManager_1.BackstageItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);
-    useBackstageItemSyncEffect(defaultItemsManager, syncIdsOfInterest);
-    const [addonItemsManager] = React.useState(new BackstageItemsManager_1.BackstageItemsManager());
-    const addonItems = (0, useUiItemsProviderBackstageItems_1.useUiItemsProviderBackstageItems)(addonItemsManager);
-    const addonSyncIdsOfInterest = React.useMemo(() => BackstageItemsManager_1.BackstageItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);
-    useBackstageItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
-    const combinedBackstageItems = React.useMemo(() => combineItems(defaultItems, addonItems, !!props.hideSoloStageEntry), [defaultItems, addonItems, props.hideSoloStageEntry]);
-    const groups = (0, exports.useGroupedItems)(combinedBackstageItems);
-    return (React.createElement(appui_layout_react_1.Backstage, { className: props.className, header: props.header, isOpen: isOpen, onClose: handleClose, safeAreaInsets: (0, SafeAreaHelpers_1.toLayoutSafeAreaInsets)(safeAreaInsets), showOverlay: props.showOverlay, style: props.style }, groups.map((group, groupIndex) => (group.map((item, itemIndex) => {
-        const composerItem = (React.createElement(BackstageComposerItem_1.BackstageComposerItem, { item: item, key: item.id }));
-        return itemIndex === 0 && groupIndex > 0 ? (React.createElement(React.Fragment, { key: groupIndex },
-            React.createElement(appui_layout_react_1.BackstageSeparator, null),
-            composerItem)) : composerItem;
-    })))));
-}
-exports.BackstageComposer = BackstageComposer;
+"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.BackstageComposer = exports.useGroupedItems = void 0;
+const React = require("react");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const appui_layout_react_1 = require("@itwin/appui-layout-react");
+const SafeAreaContext_1 = require("../safearea/SafeAreaContext");
+const SyncUiEventDispatcher_1 = require("../syncui/SyncUiEventDispatcher");
+const BackstageComposerItem_1 = require("./BackstageComposerItem");
+const BackstageManager_1 = require("./BackstageManager");
+const useDefaultBackstageItems_1 = require("./useDefaultBackstageItems");
+const useUiItemsProviderBackstageItems_1 = require("./useUiItemsProviderBackstageItems");
+const SafeAreaHelpers_1 = require("../safearea/SafeAreaHelpers");
+const BackstageItem_1 = require("./BackstageItem");
+const BackstageItemsManager_1 = require("./BackstageItemsManager");
+// cSpell:ignore safearea
+/** Private function to set up sync event monitoring of backstage items */
+function useBackstageItemSyncEffect(itemsManager, syncIdsOfInterest) {
+    const isInitialMount = React.useRef(true);
+    React.useEffect(() => {
+        if (isInitialMount.current) {
+            isInitialMount.current = false;
+            // initialize the display state of any items with syncIds/condition defined
+            itemsManager.refreshAffectedItems(new Set(syncIdsOfInterest));
+        }
+        return SyncUiEventDispatcher_1.SyncUiEventDispatcher.onSyncUiEvent.addListener((args) => {
+            if (0 === syncIdsOfInterest.length)
+                return;
+            // istanbul ignore else
+            if (syncIdsOfInterest.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                // process each item that has interest
+                itemsManager.refreshAffectedItems(args.eventIds);
+            }
+        });
+    }, [itemsManager, itemsManager.items, syncIdsOfInterest]);
+}
+/** local function to combine items from Stage and from Extensions */
+function combineItems(stageItems, addonItems, hideSoloStageEntry) {
+    let items = [];
+    if (stageItems.length) {
+        // Walk through each and ensure no duplicate ids are added.
+        stageItems.forEach((srcItem) => {
+            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
+                items.push(srcItem);
+            }
+        });
+    }
+    if (addonItems.length) {
+        // Walk through each and ensure no duplicate ids are added.
+        addonItems.forEach((srcItem) => {
+            if (-1 === items.findIndex((item) => item.id === srcItem.id)) {
+                items.push(srcItem);
+            }
+        });
+    }
+    if (hideSoloStageEntry) {
+        // per user request don't show stage launcher if only one stage is available
+        const numberOfFrontstageItems = items.reduce((accumulator, item) => accumulator + ((0, BackstageItem_1.isBackstageStageLauncher)(item) ? 1 : 0), 0);
+        if (1 === numberOfFrontstageItems)
+            items = items.filter((item) => !(0, BackstageItem_1.isBackstageStageLauncher)(item));
+    }
+    return items;
+}
+/** @internal */
+const useGroupedItems = (items) => {
+    return React.useMemo(() => {
+        const grouped = items.reduce((acc, item) => {
+            if (appui_abstract_1.ConditionalBooleanValue.getValue(item.isHidden))
+                return acc;
+            const groupIndex = acc.findIndex((group) => group[0].groupPriority === item.groupPriority);
+            if (groupIndex >= 0)
+                return [
+                    ...acc.slice(0, groupIndex),
+                    [
+                        ...acc[groupIndex],
+                        item,
+                    ],
+                    ...acc.slice(groupIndex + 1),
+                ];
+            return [
+                ...acc,
+                [
+                    item,
+                ],
+            ];
+        }, []);
+        const sortedGroups = grouped.reduce((acc, group) => {
+            const sortedGroup = [...group].sort((a, b) => a.itemPriority - b.itemPriority);
+            return [
+                ...acc,
+                sortedGroup,
+            ];
+        }, []);
+        return [...sortedGroups].sort((a, b) => a[0].groupPriority - b[0].groupPriority);
+    }, [items]);
+};
+exports.useGroupedItems = useGroupedItems;
+/** Backstage component composed from [[UiFramework.backstage]] items.
+ * @public
+ */
+function BackstageComposer(props) {
+    const [defaultItemsManager, setDefaultItemsManager] = React.useState(new BackstageItemsManager_1.BackstageItemsManager(props.items));
+    const initialItems = React.useRef(props.items);
+    React.useEffect(() => {
+        if (initialItems.current !== props.items) {
+            initialItems.current = props.items;
+            setDefaultItemsManager(new BackstageItemsManager_1.BackstageItemsManager(props.items));
+        }
+    }, [props.items]);
+    const manager = (0, BackstageManager_1.useBackstageManager)();
+    const isOpen = (0, BackstageManager_1.useIsBackstageOpen)(manager);
+    const safeAreaInsets = React.useContext(SafeAreaContext_1.SafeAreaContext);
+    const handleClose = React.useCallback(() => {
+        manager.close();
+    }, [manager]);
+    const defaultItems = (0, useDefaultBackstageItems_1.useDefaultBackstageItems)(defaultItemsManager);
+    const syncIdsOfInterest = React.useMemo(() => BackstageItemsManager_1.BackstageItemsManager.getSyncIdsOfInterest(defaultItems), [defaultItems]);
+    useBackstageItemSyncEffect(defaultItemsManager, syncIdsOfInterest);
+    const [addonItemsManager] = React.useState(new BackstageItemsManager_1.BackstageItemsManager());
+    const addonItems = (0, useUiItemsProviderBackstageItems_1.useUiItemsProviderBackstageItems)(addonItemsManager);
+    const addonSyncIdsOfInterest = React.useMemo(() => BackstageItemsManager_1.BackstageItemsManager.getSyncIdsOfInterest(addonItems), [addonItems]);
+    useBackstageItemSyncEffect(addonItemsManager, addonSyncIdsOfInterest);
+    const combinedBackstageItems = React.useMemo(() => combineItems(defaultItems, addonItems, !!props.hideSoloStageEntry), [defaultItems, addonItems, props.hideSoloStageEntry]);
+    const groups = (0, exports.useGroupedItems)(combinedBackstageItems);
+    return (React.createElement(appui_layout_react_1.Backstage, { className: props.className, header: props.header, isOpen: isOpen, onClose: handleClose, safeAreaInsets: (0, SafeAreaHelpers_1.toLayoutSafeAreaInsets)(safeAreaInsets), showOverlay: props.showOverlay, style: props.style }, groups.map((group, groupIndex) => (group.map((item, itemIndex) => {
+        const composerItem = (React.createElement(BackstageComposerItem_1.BackstageComposerItem, { item: item, key: item.id }));
+        return itemIndex === 0 && groupIndex > 0 ? (React.createElement(React.Fragment, { key: groupIndex },
+            React.createElement(appui_layout_react_1.BackstageSeparator, null),
+            composerItem)) : composerItem;
+    })))));
+}
+exports.BackstageComposer = BackstageComposer;
 //# sourceMappingURL=BackstageComposer.js.map

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

@@ -1,29 +1,29 @@
-/** @packageDocumentation
- * @module Backstage
- */
-/// <reference types="react" />
-import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "./BackstageItem";
-/** @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;
-}
-/** Item of [[BackstageComposer]].
- * @internal
- */
-export declare function BackstageComposerItem({ item }: BackstageComposerItemProps): JSX.Element;
+/** @packageDocumentation
+ * @module Backstage
+ */
+/// <reference types="react" />
+import { BackstageActionItem, BackstageItem, BackstageStageLauncher } from "./BackstageItem";
+/** @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;
+}
+/** 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,55 @@
-"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 BackstageManager_1 = require("./BackstageManager");
-const UiFramework_1 = require("../UiFramework");
-const FrontstageDef_1 = require("../frontstage/FrontstageDef");
-const BackstageItem_1 = require("./BackstageItem");
-const isProviderItem_1 = require("../ui-items-provider/isProviderItem");
-/** @internal */
-function BackstageComposerActionItem({ item }) {
-    const manager = (0, BackstageManager_1.useBackstageManager)();
-    const handleClick = React.useCallback(() => {
-        manager.close();
-        item.execute();
-    }, [manager, item]);
-    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: (0, isProviderItem_1.isProviderItem)(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: item.icon }), 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.badge) }, 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 (!UiFramework_1.UiFramework.frontstages.hasFrontstage(item.stageId))
-            return core_bentley_1.Logger.logError("BackstageComposerStageLauncher", `Frontstage with id '${item.stageId}' not found`);
-        void UiFramework_1.UiFramework.frontstages.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);
-    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: (0, isProviderItem_1.isProviderItem)(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: item.icon }), 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.badge) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
-}
-exports.BackstageComposerStageLauncher = BackstageComposerStageLauncher;
-/** Item of [[BackstageComposer]].
- * @internal
- */
-function BackstageComposerItem({ item }) {
-    if ((0, BackstageItem_1.isBackstageStageLauncher)(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 BackstageManager_1 = require("./BackstageManager");
+const UiFramework_1 = require("../UiFramework");
+const FrontstageDef_1 = require("../frontstage/FrontstageDef");
+const BackstageItem_1 = require("./BackstageItem");
+const isProviderItem_1 = require("../ui-items-provider/isProviderItem");
+/** @internal */
+function BackstageComposerActionItem({ item }) {
+    const manager = (0, BackstageManager_1.useBackstageManager)();
+    const handleClick = React.useCallback(() => {
+        manager.close();
+        item.execute();
+    }, [manager, item]);
+    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: (0, isProviderItem_1.isProviderItem)(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: item.icon }), 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.badge) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
+}
+exports.BackstageComposerActionItem = BackstageComposerActionItem;
+/** @internal */
+function BackstageComposerStageLauncher({ item }) {
+    const manager = (0, BackstageManager_1.useBackstageManager)();
+    const handleClick = React.useCallback(() => {
+        manager.close();
+        if (!UiFramework_1.UiFramework.frontstages.hasFrontstage(item.stageId))
+            return core_bentley_1.Logger.logError("BackstageComposerStageLauncher", `Frontstage with id '${item.stageId}' not found`);
+        void UiFramework_1.UiFramework.frontstages.setActiveFrontstage(item.stageId);
+    }, [manager, item.stageId]);
+    const activeFrontstageId = (0, FrontstageDef_1.useActiveFrontstageId)();
+    const isActive = appui_abstract_1.ConditionalBooleanValue.getValue(item.isActive ?? item.stageId === activeFrontstageId);
+    return (React.createElement(appui_layout_react_1.BackstageItem, { itemId: item.id, providerId: (0, isProviderItem_1.isProviderItem)(item) ? item.providerId : undefined, itemPriority: item.itemPriority, groupPriority: item.groupPriority, icon: React.createElement(core_react_1.Icon, { iconSpec: item.icon }), 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.badge) }, appui_abstract_1.ConditionalStringValue.getValue(item.label)));
+}
+exports.BackstageComposerStageLauncher = BackstageComposerStageLauncher;
+/** Item of [[BackstageComposer]].
+ * @internal
+ */
+function BackstageComposerItem({ item }) {
+    if ((0, BackstageItem_1.isBackstageStageLauncher)(item)) {
+        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,0DAAwF;AACxF,kDAAyD;AACzD,kEAA8E;AAC9E,yDAAyD;AACzD,gDAA6C;AAC7C,+DAAoE;AACpE,mDAAuH;AACvH,wEAAqE;AAOrE,gBAAgB;AAChB,SAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,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,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,IAAA,+BAAc,EAAC,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,iBAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,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,KAAK,CAAC,IAEzD,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAtBD,kEAsBC;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,yBAAW,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YACtD,OAAO,qBAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,yBAAW,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,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,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAA,+BAAc,EAAC,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,iBAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,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,KAAK,CAAC,IAEzD,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AA1BD,wEA0BC;AAUD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,IAAA,wCAAwB,EAAC,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;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 { 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"]}
+{"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,0DAAwF;AACxF,kDAAyD;AACzD,kEAA8E;AAC9E,yDAAyD;AACzD,gDAA6C;AAC7C,+DAAoE;AACpE,mDAAuH;AACvH,wEAAqE;AAOrE,gBAAgB;AAChB,SAAgB,2BAA2B,CAAC,EAAE,IAAI,EAAoC;IACpF,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,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,IAAA,+BAAc,EAAC,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,iBAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,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,KAAK,CAAC,IAEzD,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AAtBD,kEAsBC;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,yBAAW,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC;YACtD,OAAO,qBAAM,CAAC,QAAQ,CAAC,gCAAgC,EAAE,uBAAuB,IAAI,CAAC,OAAO,aAAa,CAAC,CAAC;QAC7G,KAAK,yBAAW,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,IAAA,qCAAqB,GAAE,CAAC;IACnD,MAAM,QAAQ,GAAG,wCAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,KAAK,kBAAkB,CAAC,CAAC;IACxG,OAAO,CACL,oBAAC,kCAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,UAAU,EAAE,IAAA,+BAAc,EAAC,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,iBAAI,IAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,GAAI,EACnC,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,KAAK,CAAC,IAEzD,uCAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAC3B,CACpB,CAAC;AACJ,CAAC;AA1BD,wEA0BC;AAUD;;GAEG;AACH,SAAgB,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,IAAA,wCAAwB,EAAC,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;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 { 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/cjs/appui-react/backstage/BackstageItem.d.ts

@@ -1,60 +1,60 @@
-/** @packageDocumentation
- * @module Backstage
- */
-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.
- * @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.
- * @public
- */
-export interface BackstageActionItem extends CommonBackstageItem {
-    readonly execute: () => void;
-}
-/** Describes the data needed to insert an action button into the backstage menu.
- * @public
- */
-export interface BackstageStageLauncher extends CommonBackstageItem {
-    readonly stageId: string;
-}
-/** Describes the data needed to insert a button into the backstage menu.
- * @public
- */
-export declare type BackstageItem = BackstageActionItem | BackstageStageLauncher;
-/** BackstageActionItem type guard.
- * @public
- */
-export declare function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem;
-/** BackstageStageLauncher type guard.
- * @public
- */
-export declare function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher;
+/** @packageDocumentation
+ * @module Backstage
+ */
+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.
+ * @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.
+ * @public
+ */
+export interface BackstageActionItem extends CommonBackstageItem {
+    readonly execute: () => void;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @public
+ */
+export interface BackstageStageLauncher extends CommonBackstageItem {
+    readonly stageId: string;
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @public
+ */
+export type BackstageItem = BackstageActionItem | BackstageStageLauncher;
+/** BackstageActionItem type guard.
+ * @public
+ */
+export declare function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @public
+ */
+export declare function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher;
 //# sourceMappingURL=BackstageItem.d.ts.map

package/lib/cjs/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,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"}
+{"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,MAAM,MAAM,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"}