@itwin/appui-react 3.0.0-dev.100

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

@@ -0,0 +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,MAAM,mBAAmB,CAAC;AACzD,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,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,IAAI,EAAE,oBAAC,IAAI,IAAC,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAI,EACpE,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,OAAO,CACL,oBAAC,gBAAgB,IACf,MAAM,EAAE,IAAI,CAAC,EAAE,EACf,IAAI,EAAE,oBAAC,IAAI,IAAC,QAAQ,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAI,EACpE,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;AAUD;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAAE,IAAI,EAA8B;IACxE,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;QACzB,OAAO,CACL,oBAAC,8BAA8B,IAC7B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;KACH;IACD,OAAO,CACL,oBAAC,2BAA2B,IAC1B,IAAI,EAAE,IAAI,GACV,CACH,CAAC;AACJ,CAAC","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 } 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;\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      icon={<Icon iconSpec={ConditionalStringValue.getValue(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.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;\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  return (\r\n    <NZ_BackstageItem\r\n      itemId={item.id}\r\n      icon={<Icon iconSpec={ConditionalStringValue.getValue(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.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 * @beta\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 * @beta\r\n */\r\nexport function BackstageComposerItem({ item }: BackstageComposerItemProps) {\r\n  if (isStageLauncher(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/BackstageItemProps.d.ts

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

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

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

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

@@ -0,0 +1,18 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { BackstageItemUtilities } from "./BackstageItemUtilities";
+/** Helper method to set backstage item state from props.
+ * @public
+ * @deprecated - use [BackstageItem]($appui-abstract) in bentley/appui-abstract instead
+ */
+// istanbul ignore next
+export const getBackstageItemStateFromProps = (props) => {
+    // eslint-disable-next-line deprecation/deprecation
+    return BackstageItemUtilities.getBackstageItemStateFromProps(props);
+};
+//# sourceMappingURL=BackstageItemProps.js.map

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

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

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

@@ -0,0 +1,47 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BackstageActionItem as UIA_BackstageActionItem, BackstageStageLauncher as UIA_BackstageStageLauncher } from "@itwin/appui-abstract";
+import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
+/** Used to specify the item type added to the backstage menu.
+ * @beta
+ * @deprecated Use [BackstageItemType]($appui-abstract) in bentley/appui-abstract instead
+ */
+export declare enum BackstageItemType {
+    /** Item that executes an action function */
+    ActionItem = 1,
+    /** Item that activate a stage. */
+    StageLauncher = 2
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @beta
+ * @deprecated Use [BackstageActionItem]($appui-abstract) in bentley/appui-abstract instead
+ */
+export interface BackstageActionItem extends UIA_BackstageActionItem {
+    readonly type: BackstageItemType.ActionItem;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @beta
+ * @deprecated Use [BackstageStageLauncher]($appui-abstract) in bentley/appui-abstract instead
+ */
+export interface BackstageStageLauncher extends UIA_BackstageStageLauncher {
+    readonly type: BackstageItemType.StageLauncher;
+}
+/** Utilities for creating and maintaining backstage items
+ * @beta @deprecated
+ */
+export declare class BackstageItemUtilities {
+    /** Creates a stage launcher backstage item
+     * @beta
+     * @deprecated Use BackstageItemUtilities.createStageLauncher in bentley/appui-abstract instead
+     */
+    static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string | undefined, iconSpec?: string | undefined, overrides?: Partial<BackstageStageLauncher> | undefined) => BackstageStageLauncher;
+    /** Creates an action backstage item
+     * @beta
+     * @deprecated Use BackstageItemUtilities.createActionItem in bentley/appui-abstract instead
+     */
+    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 */
+    static getBackstageItemStateFromProps: (props: BackstageItemProps) => BackstageItemState;
+}
+//# sourceMappingURL=BackstageItemUtilities.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,IAAI,uBAAuB,EAAE,sBAAsB,IAAI,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AAE7I,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE9E;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,uBAAuB;IAClE,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC;CAC7C;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,0BAA0B;IACxE,QAAQ,CAAC,IAAI,EAAE,iBAAiB,CAAC,aAAa,CAAC;CAChD;AAED;;GAEG;AACH,qBAAa,sBAAsB;IACjC;;;OAGG;IACH,OAAc,mBAAmB,iBAAkB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,4HAAsF,sBAAsB,CAU9N;IAEH;;;OAGG;IACH,OAAc,gBAAgB,WAAY,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,yHAAmF,mBAAmB,CAUpO;IAEH,2DAA2D;IAC3D,OAAc,8BAA8B,UAAW,kBAAkB,KAAG,kBAAkB,CAa5F;CACH"}

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

@@ -0,0 +1,69 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { PropsHelper } from "../utils/PropsHelper";
+/** Used to specify the item type added to the backstage menu.
+ * @beta
+ * @deprecated Use [BackstageItemType]($appui-abstract) in bentley/appui-abstract instead
+ */
+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 = {}));
+/** Utilities for creating and maintaining backstage items
+ * @beta @deprecated
+ */
+export class BackstageItemUtilities {
+}
+/** Creates a stage launcher backstage item
+ * @beta
+ * @deprecated Use BackstageItemUtilities.createStageLauncher in bentley/appui-abstract instead
+ */
+BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, iconSpec, overrides) => ({
+    groupPriority,
+    icon: iconSpec,
+    id: frontstageId,
+    itemPriority,
+    type: BackstageItemType.StageLauncher,
+    label,
+    stageId: frontstageId,
+    subtitle,
+    ...overrides,
+});
+/** Creates an action backstage item
+ * @beta
+ * @deprecated Use BackstageItemUtilities.createActionItem in bentley/appui-abstract instead
+ */
+BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, iconSpec, overrides) => ({
+    execute,
+    groupPriority,
+    icon: iconSpec,
+    id: itemId,
+    itemPriority,
+    type: BackstageItemType.ActionItem,
+    label,
+    subtitle,
+    ...overrides,
+});
+/** Helper method to set backstage item state from props */
+BackstageItemUtilities.getBackstageItemStateFromProps = (props) => {
+    const labelSpec = PropsHelper.getStringSpec(props.label, props.labelKey);
+    const subtitleSpec = PropsHelper.getStringSpec(props.description, props.descriptionKey);
+    const tooltipSpec = PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);
+    return {
+        isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */ false,
+        label: PropsHelper.getStringFromSpec(labelSpec),
+        subtitle: PropsHelper.getStringFromSpec(subtitleSpec),
+        tooltip: PropsHelper.getStringFromSpec(tooltipSpec),
+        iconSpec: props.iconSpec,
+        isActive: undefined !== props.isActive ? props.isActive : false,
+    };
+};
+//# sourceMappingURL=BackstageItemUtilities.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGnD;;;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;AAkBD;;GAEG;AACH,MAAM,OAAO,sBAAsB;;AACjC;;;GAGG;AACW,0CAAmB,GAAG,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAA2C,EAA0B,EAAE,CAAC,CAAC;IACpO,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,IAAI,EAAE,iBAAiB,CAAC,aAAa;IACrC,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH;;;GAGG;AACW,uCAAgB,GAAG,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAwC,EAAuB,EAAE,CAAC,CAAC;IAC1O,OAAO;IACP,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,IAAI,EAAE,iBAAiB,CAAC,UAAU;IAClC,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,2DAA2D;AAC7C,qDAA8B,GAAG,CAAC,KAAyB,EAAsB,EAAE;IAC/F,MAAM,SAAS,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACxF,MAAM,WAAW,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE/E,OAAO;QACL,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,0BAA0B,CAAA,KAAK;QAC5F,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAC/C,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,YAAY,CAAC;QACrD,OAAO,EAAE,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC;QACnD,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;KAChE,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { BackstageActionItem as UIA_BackstageActionItem, BackstageStageLauncher as UIA_BackstageStageLauncher } from \"@itwin/appui-abstract\";\r\nimport { PropsHelper } from \"../utils/PropsHelper\";\r\nimport { BackstageItemProps, BackstageItemState } from \"./BackstageItemProps\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @beta\r\n * @deprecated Use [BackstageItemType]($appui-abstract) in bentley/appui-abstract instead\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 an action button into the backstage menu.\r\n * @beta\r\n * @deprecated Use [BackstageActionItem]($appui-abstract) in bentley/appui-abstract instead\r\n */\r\nexport interface BackstageActionItem extends UIA_BackstageActionItem {\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 * @deprecated Use [BackstageStageLauncher]($appui-abstract) in bentley/appui-abstract instead\r\n */\r\nexport interface BackstageStageLauncher extends UIA_BackstageStageLauncher {\r\n  readonly type: BackstageItemType.StageLauncher; // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta @deprecated\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item\r\n   * @beta\r\n   * @deprecated Use BackstageItemUtilities.createStageLauncher in bentley/appui-abstract instead\r\n   */\r\n  public static createStageLauncher = (frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    type: BackstageItemType.StageLauncher, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item\r\n   * @beta\r\n   * @deprecated Use BackstageItemUtilities.createActionItem in bentley/appui-abstract instead\r\n   */\r\n  public static createActionItem = (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    execute,\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: itemId,\r\n    itemPriority,\r\n    type: BackstageItemType.ActionItem, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Helper method to set backstage item state from props */\r\n  public static getBackstageItemStateFromProps = (props: BackstageItemProps): BackstageItemState => { // eslint-disable-line deprecation/deprecation\r\n    const labelSpec = PropsHelper.getStringSpec(props.label, props.labelKey);\r\n    const subtitleSpec = PropsHelper.getStringSpec(props.description, props.descriptionKey);\r\n    const tooltipSpec = PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);\r\n\r\n    return {\r\n      isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */false,\r\n      label: PropsHelper.getStringFromSpec(labelSpec),\r\n      subtitle: PropsHelper.getStringFromSpec(subtitleSpec),\r\n      tooltip: PropsHelper.getStringFromSpec(tooltipSpec),\r\n      iconSpec: props.iconSpec,\r\n      isActive: undefined !== props.isActive ? props.isActive : false,\r\n    };\r\n  };\r\n}\r\n"]}

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

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

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

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

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

@@ -0,0 +1,79 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import * as React from "react";
+import { BeEvent } from "@itwin/core-bentley";
+import { CommandItemDef } from "../shared/CommandItemDef";
+import { UiFramework } from "../UiFramework";
+import { Backstage } from "./Backstage";
+/** Controls backstage.
+ * @public
+ */
+export class BackstageManager {
+    constructor() {
+        this._isOpen = false;
+        /** Event raised when backstage is opened or closed. */
+        this.onToggled = new BeEvent();
+    }
+    get isOpen() {
+        return this._isOpen;
+    }
+    setIsOpen(isOpen) {
+        if (isOpen === this._isOpen)
+            return;
+        this._isOpen = isOpen;
+        this.onToggled.raiseEvent({
+            isOpen,
+        });
+        Backstage.onBackstageEvent.emit({ isVisible: isOpen }); // eslint-disable-line deprecation/deprecation
+    }
+    open() {
+        this.setIsOpen(true);
+    }
+    close() {
+        this.setIsOpen(false);
+    }
+    toggle() {
+        this.setIsOpen(!this.isOpen);
+    }
+    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
+    static getBackstageToggleCommand(overrideIconSpec) {
+        return new CommandItemDef({
+            commandId: "UiFramework.openBackstage",
+            iconSpec: overrideIconSpec ? overrideIconSpec : "icon-home",
+            labelKey: "UiFramework:commands.openBackstage",
+            execute: () => {
+                UiFramework.backstageManager.toggle();
+            },
+        });
+    }
+}
+/** Hook that returns isOpen flag of the backstage.
+ * @public
+ */
+export const useIsBackstageOpen = (manager) => {
+    const [isOpen, setIsOpen] = React.useState(manager.isOpen);
+    React.useEffect(() => {
+        const handleToggled = (args) => {
+            setIsOpen(args.isOpen);
+        };
+        setIsOpen(manager.isOpen);
+        manager.onToggled.addListener(handleToggled);
+        return () => {
+            manager.onToggled.removeListener(handleToggled);
+        };
+    }, [manager]);
+    return isOpen;
+};
+/** Hook that returns backstage manager.
+ * @public
+ */
+export const useBackstageManager = () => {
+    const [manager] = React.useState(UiFramework.backstageManager);
+    return manager;
+};
+//# sourceMappingURL=BackstageManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageManager.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QACU,YAAO,GAAG,KAAK,CAAC;QAExB,uDAAuD;QACvC,cAAS,GAAG,IAAI,OAAO,EAAwC,CAAC;IAuClF,CAAC;IArCC,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEO,SAAS,CAAC,MAAe;QAC/B,IAAI,MAAM,KAAK,IAAI,CAAC,OAAO;YACzB,OAAO;QACT,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;YACxB,MAAM;SACP,CAAC,CAAC;QACH,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,8CAA8C;IACxG,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAEM,MAAM;QACX,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,mGAAmG;IAC5F,MAAM,CAAC,yBAAyB,CAAC,gBAA2B;QACjE,OAAO,IAAI,cAAc,CAAC;YACxB,SAAS,EAAE,2BAA2B;YACtC,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,WAAW;YAC3D,QAAQ,EAAE,oCAAoC;YAC9C,OAAO,EAAE,GAAG,EAAE;gBACZ,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;YACxC,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAyB,EAAE,EAAE;IAC9D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,aAAa,GAAG,CAAC,IAA0B,EAAE,EAAE;YACnD,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC,CAAC;QACF,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7C,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QAClD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACtC,MAAM,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;IAC/D,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { IconSpec } from \"@itwin/core-react\";\r\nimport { CommandItemDef } from \"../shared/CommandItemDef\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { Backstage } from \"./Backstage\";\r\n\r\n/** Arguments of [[BackstageManager.onToggled]].\r\n * @public\r\n */\r\nexport interface BackstageToggledArgs {\r\n  readonly isOpen: boolean;\r\n}\r\n\r\n/** Controls backstage.\r\n * @public\r\n */\r\nexport class BackstageManager {\r\n  private _isOpen = false;\r\n\r\n  /** Event raised when backstage is opened or closed. */\r\n  public readonly onToggled = new BeEvent<(args: BackstageToggledArgs) => void>();\r\n\r\n  public get isOpen() {\r\n    return this._isOpen;\r\n  }\r\n\r\n  private setIsOpen(isOpen: boolean) {\r\n    if (isOpen === this._isOpen)\r\n      return;\r\n    this._isOpen = isOpen;\r\n    this.onToggled.raiseEvent({\r\n      isOpen,\r\n    });\r\n    Backstage.onBackstageEvent.emit({ isVisible: isOpen }); // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  public open() {\r\n    this.setIsOpen(true);\r\n  }\r\n\r\n  public close() {\r\n    this.setIsOpen(false);\r\n  }\r\n\r\n  public toggle() {\r\n    this.setIsOpen(!this.isOpen);\r\n  }\r\n\r\n  /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */\r\n  public static getBackstageToggleCommand(overrideIconSpec?: IconSpec) {\r\n    return new CommandItemDef({\r\n      commandId: \"UiFramework.openBackstage\",\r\n      iconSpec: overrideIconSpec ? overrideIconSpec : \"icon-home\",\r\n      labelKey: \"UiFramework:commands.openBackstage\",\r\n      execute: () => {\r\n        UiFramework.backstageManager.toggle();\r\n      },\r\n    });\r\n  }\r\n}\r\n\r\n/** Hook that returns isOpen flag of the backstage.\r\n * @public\r\n */\r\nexport const useIsBackstageOpen = (manager: BackstageManager) => {\r\n  const [isOpen, setIsOpen] = React.useState(manager.isOpen);\r\n  React.useEffect(() => {\r\n    const handleToggled = (args: BackstageToggledArgs) => {\r\n      setIsOpen(args.isOpen);\r\n    };\r\n    setIsOpen(manager.isOpen);\r\n    manager.onToggled.addListener(handleToggled);\r\n    return () => {\r\n      manager.onToggled.removeListener(handleToggled);\r\n    };\r\n  }, [manager]);\r\n  return isOpen;\r\n};\r\n\r\n/** Hook that returns backstage manager.\r\n * @public\r\n */\r\nexport const useBackstageManager = () => {\r\n  const [manager] = React.useState(UiFramework.backstageManager);\r\n  return manager;\r\n};\r\n"]}

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

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { CommandHandler } from "@itwin/appui-abstract";
+import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
+/** Properties for a [[CommandLaunchBackstageItem]] component
+ * @public
+ */
+export interface CommandLaunchBackstageItemProps extends BackstageItemProps, CommandHandler {
+    /** Unique Id for this backstage item. */
+    commandId: string;
+}
+/** Backstage item that launches a Command
+ * @public
+ */
+export declare class CommandLaunchBackstageItem extends React.PureComponent<CommandLaunchBackstageItemProps, BackstageItemState> {
+    /** @internal */
+    readonly state: Readonly<BackstageItemState>;
+    private _componentUnmounting;
+    private _stateSyncIds;
+    constructor(props: CommandLaunchBackstageItemProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleSyncUiEvent;
+    execute: () => void;
+    componentDidUpdate(_prevProps: CommandLaunchBackstageItemProps): void;
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=CommandLaunch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLaunch.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/CommandLaunch.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAOvD,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAQ9E;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB,EAAE,cAAc;IACzF,yCAAyC;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,KAAK,CAAC,aAAa,CAAC,+BAA+B,EAAE,kBAAkB,CAAC;IAEtH,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC7D,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAgB;gBAEzB,KAAK,EAAE,+BAA+B;IAUlC,iBAAiB;IAKjB,oBAAoB;IAOpC,OAAO,CAAC,kBAAkB,CAexB;IAEK,OAAO,QAAO,IAAI,CAUvB;IAIc,kBAAkB,CAAC,UAAU,EAAE,+BAA+B;IAQ9D,MAAM,IAAI,KAAK,CAAC,SAAS;CAa1C"}

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

@@ -0,0 +1,82 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import * as React from "react";
+import { Logger } from "@itwin/core-bentley";
+import { BackstageItem as NZ_BackstageItem } from "@itwin/appui-layout-react";
+import { withSafeArea } from "../safearea/SafeAreaContext";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+import { PropsHelper } from "../utils/PropsHelper";
+import { Backstage } from "./Backstage";
+import { BackstageItemUtilities } from "./BackstageItemUtilities";
+// cspell:ignore safearea
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackstageItem = withSafeArea(NZ_BackstageItem);
+/** Backstage item that launches a Command
+ * @public
+ */
+export class CommandLaunchBackstageItem extends React.PureComponent {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false; // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called
+        this._stateSyncIds = []; // local version of syncId that are lower cased
+        this._handleSyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, this._stateSyncIds)) {
+                /* istanbul ignore else */
+                if (this.props.stateFunc) {
+                    const newState = this.props.stateFunc(this.state);
+                    /* istanbul ignore next */
+                    if (!PropsHelper.isShallowEqual(newState, this.state))
+                        this.setState((_prevState) => newState);
+                }
+            }
+        };
+        this.execute = () => {
+            Backstage.hide(); // eslint-disable-line deprecation/deprecation
+            if (this.props.execute) {
+                if (this.props.getCommandArgs)
+                    this.props.execute(this.props.getCommandArgs());
+                else
+                    this.props.execute(this.props.parameters);
+            }
+            else
+                Logger.logError(UiFramework.loggerCategory(this), `'${this.props.commandId}' has no execute() function`);
+        };
+        if (props.stateSyncIds)
+            this._stateSyncIds = props.stateSyncIds.map((value) => value.toLowerCase());
+        // eslint-disable-next-line deprecation/deprecation
+        this.state = BackstageItemUtilities.getBackstageItemStateFromProps(props);
+    }
+    componentDidMount() {
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+    }
+    componentWillUnmount() {
+        this._componentUnmounting = true;
+        /* istanbul ignore else */
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);
+    }
+    // deprecated class
+    // istanbul ignore next
+    componentDidUpdate(_prevProps) {
+        // eslint-disable-next-line deprecation/deprecation
+        const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);
+        if (!PropsHelper.isShallowEqual(updatedState, this.state))
+            this.setState((_prevState) => updatedState);
+    }
+    // TODO: add tooltip, subtitle, aria-label? to NZ_BackstageItem
+    render() {
+        return (React.createElement(BackstageItem, { icon: PropsHelper.getIcon(this.state.iconSpec), isActive: this.state.isActive, isDisabled: !this.state.isEnabled, key: this.props.commandId, onClick: this.execute }, this.state.label));
+    }
+}
+//# sourceMappingURL=CommandLaunch.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CommandLaunch.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/CommandLaunch.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;AAE7C,OAAO,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAmB,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,yBAAyB;AAEzB,gEAAgE;AAChE,MAAM,aAAa,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;AAUrD;;GAEG;AACH,MAAM,OAAO,0BAA2B,SAAQ,KAAK,CAAC,aAAkE;IAOtH,YAAY,KAAsC;QAChD,KAAK,CAAC,KAAK,CAAC,CAAC;QAJP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QAwB9E,uBAAkB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YAC3D,0BAA0B;YAC1B,IAAI,IAAI,CAAC,oBAAoB;gBAC3B,OAAO;YAET,0BAA0B;YAC1B,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,EAAE;gBAC/E,0BAA0B;gBAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;oBACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAClD,0BAA0B;oBAC1B,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC;wBACnD,IAAI,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC;iBAC3C;aACF;QACH,CAAC,CAAC;QAEK,YAAO,GAAG,GAAS,EAAE;YAC1B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;gBACtB,IAAI,IAAI,CAAC,KAAK,CAAC,cAAc;oBAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,CAAC;;oBAEhD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;aAC7C;;gBACC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,6BAA6B,CAAC,CAAC;QAC7G,CAAC,CAAC;QA9CA,IAAI,KAAK,CAAC,YAAY;YACpB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;QAE9E,mDAAmD;QACnD,IAAI,CAAC,KAAK,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;IAC5E,CAAC;IAEe,iBAAiB;QAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;YACvD,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAC7E,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,0BAA0B;QAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;YACvD,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IAChF,CAAC;IA+BD,mBAAmB;IACnB,uBAAuB;IACP,kBAAkB,CAAC,UAA2C;QAC5E,mDAAmD;QACnD,MAAM,YAAY,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvF,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC;YACvD,IAAI,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED,+DAA+D;IAC/C,MAAM;QACpB,OAAO,CACL,oBAAC,aAAa,IACZ,IAAI,EAAE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAC9C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAC7B,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EACjC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,EACzB,OAAO,EAAE,IAAI,CAAC,OAAO,IAEpB,IAAI,CAAC,KAAK,CAAC,KAAK,CACH,CACjB,CAAC;IACJ,CAAC;CACF","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 { CommandHandler } from \"@itwin/appui-abstract\";\r\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { withSafeArea } from \"../safearea/SafeAreaContext\";\r\nimport { SyncUiEventArgs, SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { PropsHelper } from \"../utils/PropsHelper\";\r\nimport { Backstage } from \"./Backstage\";\r\nimport { BackstageItemProps, BackstageItemState } from \"./BackstageItemProps\";\r\nimport { BackstageItemUtilities } from \"./BackstageItemUtilities\";\r\n\r\n// cspell:ignore safearea\r\n\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nconst BackstageItem = withSafeArea(NZ_BackstageItem);\r\n\r\n/** Properties for a [[CommandLaunchBackstageItem]] component\r\n * @public\r\n */\r\nexport interface CommandLaunchBackstageItemProps extends BackstageItemProps, CommandHandler { // eslint-disable-line deprecation/deprecation\r\n  /** Unique Id for this backstage item. */\r\n  commandId: string;\r\n}\r\n\r\n/** Backstage item that launches a Command\r\n * @public\r\n */\r\nexport class CommandLaunchBackstageItem extends React.PureComponent<CommandLaunchBackstageItemProps, BackstageItemState> { // eslint-disable-line deprecation/deprecation\r\n\r\n  /** @internal */\r\n  public override readonly state: Readonly<BackstageItemState>; // eslint-disable-line deprecation/deprecation\r\n  private _componentUnmounting = false;  // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called\r\n  private _stateSyncIds: string[] = [];  // local version of syncId that are lower cased\r\n\r\n  constructor(props: CommandLaunchBackstageItemProps) {\r\n    super(props);\r\n\r\n    if (props.stateSyncIds)\r\n      this._stateSyncIds = props.stateSyncIds.map((value) => value.toLowerCase());\r\n\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    this.state = BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n  }\r\n\r\n  public override componentDidMount() {\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    /* istanbul ignore else */\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);\r\n  }\r\n\r\n  private _handleSyncUiEvent = (args: SyncUiEventArgs): void => {\r\n    /* istanbul ignore next */\r\n    if (this._componentUnmounting)\r\n      return;\r\n\r\n    /* istanbul ignore else */\r\n    if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, this._stateSyncIds)) {\r\n      /* istanbul ignore else */\r\n      if (this.props.stateFunc) {\r\n        const newState = this.props.stateFunc(this.state);\r\n        /* istanbul ignore next */\r\n        if (!PropsHelper.isShallowEqual(newState, this.state))\r\n          this.setState((_prevState) => newState);\r\n      }\r\n    }\r\n  };\r\n\r\n  public execute = (): void => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    if (this.props.execute) {\r\n      if (this.props.getCommandArgs)\r\n        this.props.execute(this.props.getCommandArgs());\r\n      else\r\n        this.props.execute(this.props.parameters);\r\n    } else\r\n      Logger.logError(UiFramework.loggerCategory(this), `'${this.props.commandId}' has no execute() function`);\r\n  };\r\n\r\n  // deprecated class\r\n  // istanbul ignore next\r\n  public override componentDidUpdate(_prevProps: CommandLaunchBackstageItemProps) {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);\r\n    if (!PropsHelper.isShallowEqual(updatedState, this.state))\r\n      this.setState((_prevState) => updatedState);\r\n  }\r\n\r\n  // TODO: add tooltip, subtitle, aria-label? to NZ_BackstageItem\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <BackstageItem\r\n        icon={PropsHelper.getIcon(this.state.iconSpec)}\r\n        isActive={this.state.isActive}\r\n        isDisabled={!this.state.isEnabled}\r\n        key={this.props.commandId}\r\n        onClick={this.execute}\r\n      >\r\n        {this.state.label}\r\n      </BackstageItem>\r\n    );\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
+/** Properties for a [[FrontstageLaunchBackstageItem]] component
+ * @public
+ */
+export interface FrontstageLaunchBackstageItemProps extends BackstageItemProps {
+    /** id of the frontstage */
+    frontstageId: string;
+}
+/** Backstage item that activates a Frontstage
+ * @public
+ */
+export declare class FrontstageLaunchBackstageItem extends React.PureComponent<FrontstageLaunchBackstageItemProps, BackstageItemState> {
+    /** @internal */
+    readonly state: Readonly<BackstageItemState>;
+    private _componentUnmounting;
+    private _stateSyncIds;
+    constructor(props: FrontstageLaunchBackstageItemProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleSyncUiEvent;
+    execute: () => Promise<void>;
+    componentDidUpdate(_prevProps: FrontstageLaunchBackstageItemProps): void;
+    private _handleFrontstageActivatedEvent;
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=FrontstageLaunch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FrontstageLaunch.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/FrontstageLaunch.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAQ9E;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,kBAAkB;IAC5E,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,KAAK,CAAC,aAAa,CAAC,kCAAkC,EAAE,kBAAkB,CAAC;IAC5H,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC7D,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAgB;gBAEzB,KAAK,EAAE,kCAAkC;IAarC,iBAAiB;IAMjB,oBAAoB;IAQpC,OAAO,CAAC,kBAAkB,CAexB;IAEK,OAAO,sBAQZ;IAEc,kBAAkB,CAAC,UAAU,EAAE,kCAAkC;IAOjF,OAAO,CAAC,+BAA+B,CAKrC;IAGc,MAAM,IAAI,KAAK,CAAC,SAAS;CAc1C"}

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

@@ -0,0 +1,90 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { Logger } from "@itwin/core-bentley";
+import { BackstageItem as NZ_BackstageItem } from "@itwin/appui-layout-react";
+import { FrontstageManager } from "../frontstage/FrontstageManager";
+import { withSafeArea } from "../safearea/SafeAreaContext";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+import { PropsHelper } from "../utils/PropsHelper";
+import { Backstage } from "./Backstage";
+import { BackstageItemUtilities } from "./BackstageItemUtilities";
+// cspell:ignore safearea
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackstageItem = withSafeArea(NZ_BackstageItem);
+/** Backstage item that activates a Frontstage
+ * @public
+ */
+export class FrontstageLaunchBackstageItem extends React.PureComponent {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false; // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called
+        this._stateSyncIds = []; // local version of syncId that are lower cased
+        this._handleSyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, this._stateSyncIds)) {
+                /* istanbul ignore else */
+                if (this.props.stateFunc) {
+                    const newState = this.props.stateFunc(this.state);
+                    /* istanbul ignore else */
+                    if (!PropsHelper.isShallowEqual(newState, this.state))
+                        this.setState((_prevState) => newState);
+                }
+            }
+        };
+        this.execute = async () => {
+            Backstage.hide(); // eslint-disable-line deprecation/deprecation
+            const frontstageDef = await FrontstageManager.getFrontstageDef(this.props.frontstageId);
+            if (frontstageDef)
+                await FrontstageManager.setActiveFrontstageDef(frontstageDef);
+            else
+                Logger.logError(UiFramework.loggerCategory(this), `Frontstage with id '${this.props.frontstageId}' not found`);
+        };
+        this._handleFrontstageActivatedEvent = (args) => {
+            const isActive = args.activatedFrontstageDef.id === this.props.frontstageId;
+            /* istanbul ignore else */
+            if (isActive !== this.state.isActive)
+                this.setState({ isActive });
+        };
+        if (props.stateSyncIds)
+            this._stateSyncIds = props.stateSyncIds.map((value) => value.toLowerCase());
+        const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);
+        /* istanbul ignore else */
+        if (this.props.isActive === undefined)
+            state.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;
+        this.state = state;
+    }
+    componentDidMount() {
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+        FrontstageManager.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);
+    }
+    componentWillUnmount() {
+        this._componentUnmounting = true;
+        /* istanbul ignore else */
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);
+        FrontstageManager.onFrontstageActivatedEvent.removeListener(this._handleFrontstageActivatedEvent);
+    }
+    componentDidUpdate(_prevProps) {
+        const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);
+        updatedState.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;
+        if (!PropsHelper.isShallowEqual(updatedState, this.state))
+            this.setState((_prevState) => updatedState);
+    }
+    // TODO: add tooltip, aria-label? to NZ_BackstageItem
+    render() {
+        return (React.createElement(BackstageItem, { icon: PropsHelper.getIcon(this.state.iconSpec), isActive: this.state.isActive, isDisabled: !this.state.isEnabled, key: this.props.frontstageId, onClick: this.execute, subtitle: this.state.subtitle }, this.state.label));
+    }
+}
+//# sourceMappingURL=FrontstageLaunch.js.map