@itwin/appui-react 3.6.0-dev.8 → 3.7.0-dev.1

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

@@ -6,50 +6,36 @@
  * @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";
+import { InternalBackstageManager } from "./InternalBackstageManager";
 /** Controls backstage.
  * @public
  */
 export class BackstageManager {
     constructor() {
-        this._isOpen = false;
-        /** Event raised when backstage is opened or closed. */
-        this.onToggled = new BeEvent();
+        this.internal = new InternalBackstageManager();
     }
+    /** Event raised when backstage is opened or closed. */
+    get onToggled() { return this.internal.onToggled; }
     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
+        return this.internal.isOpen;
     }
     open() {
-        this.setIsOpen(true);
+        return this.internal.open();
     }
     close() {
-        this.setIsOpen(false);
+        return this.internal.close();
     }
     toggle() {
-        this.setIsOpen(!this.isOpen);
+        return this.internal.toggle();
+    }
+    getBackstageToggleCommand(overrideIconSpec) {
+        return this.internal.getBackstageToggleCommand(overrideIconSpec);
     }
-    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden */
+    /** 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();
-            },
-        });
+        return UiFramework.backstage.getBackstageToggleCommand(overrideIconSpec);
     }
 }
 /** Hook that returns isOpen flag of the backstage.
@@ -73,7 +59,7 @@ export const useIsBackstageOpen = (manager) => {
  * @public
  */
 export const useBackstageManager = () => {
-    const [manager] = React.useState(UiFramework.backstageManager);
+    const [manager] = React.useState(UiFramework.backstage);
     return manager;
 };
 //# sourceMappingURL=BackstageManager.js.map

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

@@ -1 +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"]}
+{"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;AAE/B,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QACU,aAAQ,GAAG,IAAI,wBAAwB,EAAE,CAAC;IA8BpD,CAAC;IA5BC,uDAAuD;IACvD,IAAW,SAAS,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAE1D,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAEM,IAAI;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC9B,CAAC;IAEM,KAAK;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEM,MAAM;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAChC,CAAC;IAEM,yBAAyB,CAAC,gBAA2B;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IACnE,CAAC;IAED;MACE;IACK,MAAM,CAAC,yBAAyB,CAAC,gBAA2B;QACjE,OAAO,WAAW,CAAC,SAAS,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,CAAC;IAC3E,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAA2B,EAAE,EAAE;IAChE,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,SAAS,CAAC,CAAC;IACxD,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 { IconSpec } from \"@itwin/core-react\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { BackstageToggledArgs, FrameworkBackstage } from \"../framework/FrameworkBackstage\";\r\nimport { InternalBackstageManager } from \"./InternalBackstageManager\";\r\n\r\n/** Controls backstage.\r\n * @public\r\n */\r\nexport class BackstageManager {\r\n  private internal = new InternalBackstageManager();\r\n\r\n  /** Event raised when backstage is opened or closed. */\r\n  public get onToggled() { return this.internal.onToggled; }\r\n\r\n  public get isOpen() {\r\n    return this.internal.isOpen;\r\n  }\r\n\r\n  public open() {\r\n    return this.internal.open();\r\n  }\r\n\r\n  public close() {\r\n    return this.internal.close();\r\n  }\r\n\r\n  public toggle() {\r\n    return this.internal.toggle();\r\n  }\r\n\r\n  public getBackstageToggleCommand(overrideIconSpec?: IconSpec) {\r\n    return this.internal.getBackstageToggleCommand(overrideIconSpec);\r\n  }\r\n\r\n  /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden\r\n  */\r\n  public static getBackstageToggleCommand(overrideIconSpec?: IconSpec) {\r\n    return UiFramework.backstage.getBackstageToggleCommand(overrideIconSpec);\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: FrameworkBackstage) => {\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.backstage);\r\n  return manager;\r\n};\r\n"]}

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

@@ -6,7 +6,7 @@ import { CommandHandler } from "@itwin/appui-abstract";
 import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
 /** Properties for a [[CommandLaunchBackstageItem]] component
  * @public
- * @deprecated Use [BackstageActionItem]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageActionItem]($appui-abstract) instead.
  */
 export interface CommandLaunchBackstageItemProps extends BackstageItemProps, CommandHandler {
     /** Unique Id for this backstage item. */
@@ -14,7 +14,7 @@ export interface CommandLaunchBackstageItemProps extends BackstageItemProps, Com
 }
 /** Backstage item that launches a Command
  * @public
- * @deprecated Use [BackstageActionItem]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageActionItem]($appui-abstract) instead.
  */
 export declare class CommandLaunchBackstageItem extends React.PureComponent<CommandLaunchBackstageItemProps, BackstageItemState> {
     /** @internal */

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

@@ -19,7 +19,7 @@ import { BackstageItemUtilities } from "./BackstageItemUtilities";
 const BackstageItem = withSafeArea(NZ_BackstageItem); // eslint-disable-line deprecation/deprecation
 /** Backstage item that launches a Command
  * @public
- * @deprecated Use [BackstageActionItem]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageActionItem]($appui-abstract) instead.
  */
 export class CommandLaunchBackstageItem extends React.PureComponent {
     constructor(props) {

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

@@ -1 +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,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,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,CAAC,8CAA8C;AAWpG;;;GAGG;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, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { withSafeArea } from \"../safearea/SafeAreaContext\";\r\nimport { 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); // eslint-disable-line deprecation/deprecation\r\n\r\n/** Properties for a [[CommandLaunchBackstageItem]] component\r\n * @public\r\n * @deprecated Use [BackstageActionItem]($appui-abstract) instead.\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 * @deprecated Use [BackstageActionItem]($appui-abstract) instead.\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) { // eslint-disable-line deprecation/deprecation\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: UiSyncEventArgs): 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) { // eslint-disable-line deprecation/deprecation\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"]}
+{"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,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,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,CAAC,8CAA8C;AAWpG;;;GAGG;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, UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { withSafeArea } from \"../safearea/SafeAreaContext\";\r\nimport { 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); // eslint-disable-line deprecation/deprecation\r\n\r\n/** Properties for a [[CommandLaunchBackstageItem]] component\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageActionItem]($appui-abstract) instead.\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 * @deprecated in 3.0. Use [BackstageActionItem]($appui-abstract) instead.\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) { // eslint-disable-line deprecation/deprecation\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: UiSyncEventArgs): 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) { // eslint-disable-line deprecation/deprecation\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

@@ -5,7 +5,7 @@ import * as React from "react";
 import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
 /** Properties for a [[FrontstageLaunchBackstageItem]] component
  * @public
- * @deprecated Use [BackstageStageLauncher]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageStageLauncher]($appui-abstract) instead.
  */
 export interface FrontstageLaunchBackstageItemProps extends BackstageItemProps {
     /** id of the frontstage */
@@ -13,7 +13,7 @@ export interface FrontstageLaunchBackstageItemProps extends BackstageItemProps {
 }
 /** Backstage item that activates a Frontstage
  * @public
- * @deprecated Use [BackstageStageLauncher]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageStageLauncher]($appui-abstract) instead.
  */
 export declare class FrontstageLaunchBackstageItem extends React.PureComponent<FrontstageLaunchBackstageItemProps, BackstageItemState> {
     /** @internal */

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

@@ -1 +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;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,kBAAkB;IAC5E,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;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;IACrC,OAAO,CAAC,0BAA0B,CAAC,CAAa;IAChD,OAAO,CAAC,uCAAuC,CAAC,CAAa;gBACjD,KAAK,EAAE,kCAAkC;IAarC,iBAAiB;IAMjB,oBAAoB;IAMpC,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"}
+{"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;AAQ/B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAS9E;;;GAGG;AACH,MAAM,WAAW,kCAAmC,SAAQ,kBAAkB;IAC5E,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;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;IACrC,OAAO,CAAC,0BAA0B,CAAC,CAAa;IAChD,OAAO,CAAC,uCAAuC,CAAC,CAAa;gBACjD,KAAK,EAAE,kCAAkC;IAarC,iBAAiB;IAMjB,oBAAoB;IAMpC,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

@@ -9,7 +9,6 @@
 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";
@@ -21,7 +20,7 @@ import { BackstageItemUtilities } from "./BackstageItemUtilities";
 const BackstageItem = withSafeArea(NZ_BackstageItem);
 /** Backstage item that activates a Frontstage
  * @public
- * @deprecated Use [BackstageStageLauncher]($appui-abstract) instead.
+ * @deprecated in 3.0. Use [BackstageStageLauncher]($appui-abstract) instead.
  */
 export class FrontstageLaunchBackstageItem extends React.PureComponent {
     constructor(props) {
@@ -45,9 +44,9 @@ export class FrontstageLaunchBackstageItem extends React.PureComponent {
         };
         this.execute = async () => {
             Backstage.hide(); // eslint-disable-line deprecation/deprecation
-            const frontstageDef = await FrontstageManager.getFrontstageDef(this.props.frontstageId);
+            const frontstageDef = await UiFramework.frontstages.getFrontstageDef(this.props.frontstageId);
             if (frontstageDef)
-                await FrontstageManager.setActiveFrontstageDef(frontstageDef);
+                await UiFramework.frontstages.setActiveFrontstageDef(frontstageDef);
             else
                 Logger.logError(UiFramework.loggerCategory(this), `Frontstage with id '${this.props.frontstageId}' not found`);
         };
@@ -62,13 +61,13 @@ export class FrontstageLaunchBackstageItem extends React.PureComponent {
         const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);
         /* istanbul ignore else */
         if (this.props.isActive === undefined)
-            state.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;
+            state.isActive = UiFramework.frontstages.activeFrontstageId === this.props.frontstageId;
         this.state = state;
     }
     componentDidMount() {
         if (this.props.stateFunc && this._stateSyncIds.length > 0)
             this._removeSyncUiEventListener = SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
-        this._removeFrontstageActivatedEventListener = FrontstageManager.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);
+        this._removeFrontstageActivatedEventListener = UiFramework.frontstages.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);
     }
     componentWillUnmount() {
         this._componentUnmounting = true;
@@ -77,7 +76,7 @@ export class FrontstageLaunchBackstageItem extends React.PureComponent {
     }
     componentDidUpdate(_prevProps) {
         const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);
-        updatedState.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;
+        updatedState.isActive = UiFramework.frontstages.activeFrontstageId === this.props.frontstageId;
         if (!PropsHelper.isShallowEqual(updatedState, this.state))
             this.setState((_prevState) => updatedState);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"FrontstageLaunch.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/FrontstageLaunch.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,aAAa,IAAI,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC9E,OAAO,EAAgC,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AAClG,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;AAWrD;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK,CAAC,aAAqE;IAO5H,YAAY,KAAyC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QALP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QA4B9E,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,KAAK,IAAI,EAAE;YAC1B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,MAAM,aAAa,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YACxF,IAAI,aAAa;gBACf,MAAM,iBAAiB,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;;gBAE9D,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uBAAuB,IAAI,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,CAAC;QACnH,CAAC,CAAC;QASM,oCAA+B,GAAG,CAAC,IAAkC,EAAE,EAAE;YAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC5E,0BAA0B;YAC1B,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ;gBAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;QA7DA,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,MAAM,KAAK,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAA0B;QAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS;YACnC,KAAK,CAAC,QAAQ,GAAG,iBAAiB,CAAC,kBAAkB,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QACpF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEe,iBAAiB;QAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;YACvD,IAAI,CAAC,0BAA0B,GAAG,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC7G,IAAI,CAAC,uCAAuC,GAAG,iBAAiB,CAAC,0BAA0B,CAAC,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAChJ,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,0BAA0B,IAAI,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACrE,IAAI,CAAC,uCAAuC,IAAI,IAAI,CAAC,uCAAuC,EAAE,CAAC;IACjG,CAAC;IA6Be,kBAAkB,CAAC,UAA8C;QAC/E,MAAM,YAAY,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvF,YAAY,CAAC,QAAQ,GAAG,iBAAiB,CAAC,kBAAkB,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QACzF,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;IASD,qDAAqD;IACrC,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,YAAY,EAC5B,OAAO,EAAE,IAAI,CAAC,OAAO,EACrB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,IAE5B,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/* eslint-disable deprecation/deprecation */\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 { BackstageItem as NZ_BackstageItem } from \"@itwin/appui-layout-react\";\r\nimport { FrontstageActivatedEventArgs, FrontstageManager } from \"../frontstage/FrontstageManager\";\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 [[FrontstageLaunchBackstageItem]] component\r\n * @public\r\n * @deprecated Use [BackstageStageLauncher]($appui-abstract) instead.\r\n */\r\nexport interface FrontstageLaunchBackstageItemProps extends BackstageItemProps { // eslint-disable-line deprecation/deprecation\r\n  /** id of the frontstage */\r\n  frontstageId: string;\r\n}\r\n\r\n/** Backstage item that activates a Frontstage\r\n * @public\r\n * @deprecated Use [BackstageStageLauncher]($appui-abstract) instead.\r\n */\r\nexport class FrontstageLaunchBackstageItem extends React.PureComponent<FrontstageLaunchBackstageItemProps, BackstageItemState> { // eslint-disable-line deprecation/deprecation\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  private _removeSyncUiEventListener?: () => void;\r\n  private _removeFrontstageActivatedEventListener?: () => void;\r\n  constructor(props: FrontstageLaunchBackstageItemProps) {\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    const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n    /* istanbul ignore else */\r\n    if (this.props.isActive === undefined)\r\n      state.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;\r\n    this.state = state;\r\n  }\r\n\r\n  public override componentDidMount() {\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      this._removeSyncUiEventListener = SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n    this._removeFrontstageActivatedEventListener = FrontstageManager.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    this._removeSyncUiEventListener && this._removeSyncUiEventListener();\r\n    this._removeFrontstageActivatedEventListener && this._removeFrontstageActivatedEventListener();\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 else */\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 = async () => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    const frontstageDef = await FrontstageManager.getFrontstageDef(this.props.frontstageId);\r\n    if (frontstageDef)\r\n      await FrontstageManager.setActiveFrontstageDef(frontstageDef);\r\n    else\r\n      Logger.logError(UiFramework.loggerCategory(this), `Frontstage with id '${this.props.frontstageId}' not found`);\r\n  };\r\n\r\n  public override componentDidUpdate(_prevProps: FrontstageLaunchBackstageItemProps) {\r\n    const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);\r\n    updatedState.isActive = FrontstageManager.activeFrontstageId === this.props.frontstageId;\r\n    if (!PropsHelper.isShallowEqual(updatedState, this.state))\r\n      this.setState((_prevState) => updatedState);\r\n  }\r\n\r\n  private _handleFrontstageActivatedEvent = (args: FrontstageActivatedEventArgs) => {\r\n    const isActive = args.activatedFrontstageDef.id === this.props.frontstageId;\r\n    /* istanbul ignore else */\r\n    if (isActive !== this.state.isActive)\r\n      this.setState({ isActive });\r\n  };\r\n\r\n  // TODO: add tooltip, 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.frontstageId}\r\n        onClick={this.execute}\r\n        subtitle={this.state.subtitle}\r\n      >\r\n        {this.state.label}\r\n      </BackstageItem>\r\n    );\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"FrontstageLaunch.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/FrontstageLaunch.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,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;AAGlE,yBAAyB;AAEzB,gEAAgE;AAChE,MAAM,aAAa,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;AAWrD;;;GAGG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK,CAAC,aAAqE;IAO5H,YAAY,KAAyC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QALP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QA4B9E,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,KAAK,IAAI,EAAE;YAC1B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC9F,IAAI,aAAa;gBACf,MAAM,WAAW,CAAC,WAAW,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;;gBAEpE,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,uBAAuB,IAAI,CAAC,KAAK,CAAC,YAAY,aAAa,CAAC,CAAC;QACnH,CAAC,CAAC;QASM,oCAA+B,GAAG,CAAC,IAAkC,EAAE,EAAE;YAC/E,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,EAAE,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;YAC5E,0BAA0B;YAC1B,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ;gBAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;QA7DA,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,MAAM,KAAK,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAA0B;QAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS;YACnC,KAAK,CAAC,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,kBAAkB,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QAC1F,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAEe,iBAAiB;QAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;YACvD,IAAI,CAAC,0BAA0B,GAAG,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC7G,IAAI,CAAC,uCAAuC,GAAG,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IACtJ,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,0BAA0B,IAAI,IAAI,CAAC,0BAA0B,EAAE,CAAC;QACrE,IAAI,CAAC,uCAAuC,IAAI,IAAI,CAAC,uCAAuC,EAAE,CAAC;IACjG,CAAC;IA6Be,kBAAkB,CAAC,UAA8C;QAC/E,MAAM,YAAY,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvF,YAAY,CAAC,QAAQ,GAAG,WAAW,CAAC,WAAW,CAAC,kBAAkB,KAAK,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QAC/F,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;IASD,qDAAqD;IACrC,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,YAAY,EAC5B,OAAO,EAAE,IAAI,CAAC,OAAO,EACrB,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,IAE5B,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/* eslint-disable deprecation/deprecation */\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 { 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\nimport { FrontstageActivatedEventArgs } from \"../framework/FrameworkFrontstages\";\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 [[FrontstageLaunchBackstageItem]] component\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageStageLauncher]($appui-abstract) instead.\r\n */\r\nexport interface FrontstageLaunchBackstageItemProps extends BackstageItemProps { // eslint-disable-line deprecation/deprecation\r\n  /** id of the frontstage */\r\n  frontstageId: string;\r\n}\r\n\r\n/** Backstage item that activates a Frontstage\r\n * @public\r\n * @deprecated in 3.0. Use [BackstageStageLauncher]($appui-abstract) instead.\r\n */\r\nexport class FrontstageLaunchBackstageItem extends React.PureComponent<FrontstageLaunchBackstageItemProps, BackstageItemState> { // eslint-disable-line deprecation/deprecation\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  private _removeSyncUiEventListener?: () => void;\r\n  private _removeFrontstageActivatedEventListener?: () => void;\r\n  constructor(props: FrontstageLaunchBackstageItemProps) {\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    const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n    /* istanbul ignore else */\r\n    if (this.props.isActive === undefined)\r\n      state.isActive = UiFramework.frontstages.activeFrontstageId === this.props.frontstageId;\r\n    this.state = state;\r\n  }\r\n\r\n  public override componentDidMount() {\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      this._removeSyncUiEventListener = SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n    this._removeFrontstageActivatedEventListener = UiFramework.frontstages.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    this._removeSyncUiEventListener && this._removeSyncUiEventListener();\r\n    this._removeFrontstageActivatedEventListener && this._removeFrontstageActivatedEventListener();\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 else */\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 = async () => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    const frontstageDef = await UiFramework.frontstages.getFrontstageDef(this.props.frontstageId);\r\n    if (frontstageDef)\r\n      await UiFramework.frontstages.setActiveFrontstageDef(frontstageDef);\r\n    else\r\n      Logger.logError(UiFramework.loggerCategory(this), `Frontstage with id '${this.props.frontstageId}' not found`);\r\n  };\r\n\r\n  public override componentDidUpdate(_prevProps: FrontstageLaunchBackstageItemProps) {\r\n    const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);\r\n    updatedState.isActive = UiFramework.frontstages.activeFrontstageId === this.props.frontstageId;\r\n    if (!PropsHelper.isShallowEqual(updatedState, this.state))\r\n      this.setState((_prevState) => updatedState);\r\n  }\r\n\r\n  private _handleFrontstageActivatedEvent = (args: FrontstageActivatedEventArgs) => {\r\n    const isActive = args.activatedFrontstageDef.id === this.props.frontstageId;\r\n    /* istanbul ignore else */\r\n    if (isActive !== this.state.isActive)\r\n      this.setState({ isActive });\r\n  };\r\n\r\n  // TODO: add tooltip, 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.frontstageId}\r\n        onClick={this.execute}\r\n        subtitle={this.state.subtitle}\r\n      >\r\n        {this.state.label}\r\n      </BackstageItem>\r\n    );\r\n  }\r\n}\r\n"]}

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

@@ -0,0 +1,23 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { IconSpec } from "@itwin/core-react";
+import { CommandItemDef } from "../shared/CommandItemDef";
+import { BackstageToggledArgs } from "../framework/FrameworkBackstage";
+/** Controls backstage.
+ * @internal
+ */
+export declare class InternalBackstageManager {
+    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 */
+    getBackstageToggleCommand(overrideIconSpec?: IconSpec): CommandItemDef;
+}
+//# sourceMappingURL=InternalBackstageManager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalBackstageManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/InternalBackstageManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAC;AAEvE;;GAEG;AACH,qBAAa,wBAAwB;IACnC,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;IAC5F,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;CAU7D"}

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

@@ -0,0 +1,54 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { BeEvent } from "@itwin/core-bentley";
+import { CommandItemDef } from "../shared/CommandItemDef";
+import { UiFramework } from "../UiFramework";
+import { Backstage } from "./Backstage";
+/** Controls backstage.
+ * @internal
+ */
+export class InternalBackstageManager {
+    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 */
+    getBackstageToggleCommand(overrideIconSpec) {
+        return new CommandItemDef({
+            commandId: "UiFramework.openBackstage",
+            iconSpec: overrideIconSpec ? overrideIconSpec : "icon-home",
+            labelKey: "UiFramework:commands.openBackstage",
+            execute: () => {
+                UiFramework.backstage.toggle();
+            },
+        });
+    }
+}
+//# sourceMappingURL=InternalBackstageManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"InternalBackstageManager.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/InternalBackstageManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,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;AAGxC;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAArC;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,yBAAyB,CAAC,gBAA2B;QAC1D,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,SAAS,CAAC,MAAM,EAAE,CAAC;YACjC,CAAC;SACF,CAAC,CAAC;IACL,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 { 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\nimport { BackstageToggledArgs } from \"../framework/FrameworkBackstage\";\r\n\r\n/** Controls backstage.\r\n * @internal\r\n */\r\nexport class InternalBackstageManager {\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 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.backstage.toggle();\r\n      },\r\n    });\r\n  }\r\n}\r\n"]}

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

@@ -5,7 +5,7 @@ import * as React from "react";
 import { BackstageItemProps } from "./BackstageItemProps";
 /** Separator Backstage item.
  * @public
- * @deprecated
+ * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.
  */
 export declare class SeparatorBackstageItem extends React.PureComponent<BackstageItemProps> {
     private static _sSeparatorBackstageItemKey;

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

@@ -9,7 +9,7 @@ import * as React from "react";
 import { BackstageSeparator as NZ_BackstageSeparator } from "@itwin/appui-layout-react";
 /** Separator Backstage item.
  * @public
- * @deprecated
+ * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.
  */
 export class SeparatorBackstageItem extends React.PureComponent {
     constructor(separatorBackstageItemDef) {

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

@@ -1 +1 @@
-{"version":3,"file":"Separator.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/Separator.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGxF;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK,CAAC,aAAiC;IAIjF,YAAY,yBAA6C;QACvD,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAEjC,sBAAsB,CAAC,2BAA2B,EAAE,CAAC,CAAC,8CAA8C;QACpG,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,2BAA2B,CAAC,CAAC,8CAA8C;IAChH,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,qBAAqB,IAAC,GAAG,EAAE,IAAI,CAAC,IAAI,GAAI,CAC1C,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 { BackstageSeparator as NZ_BackstageSeparator } from \"@itwin/appui-layout-react\";\r\nimport { BackstageItemProps } from \"./BackstageItemProps\";\r\n\r\n/** Separator Backstage item.\r\n * @public\r\n * @deprecated\r\n */\r\nexport class SeparatorBackstageItem extends React.PureComponent<BackstageItemProps> { // eslint-disable-line deprecation/deprecation\r\n  private static _sSeparatorBackstageItemKey: number;\r\n  private _key: number;\r\n\r\n  constructor(separatorBackstageItemDef: BackstageItemProps) { // eslint-disable-line deprecation/deprecation\r\n    super(separatorBackstageItemDef);\r\n\r\n    SeparatorBackstageItem._sSeparatorBackstageItemKey++; // eslint-disable-line deprecation/deprecation\r\n    this._key = SeparatorBackstageItem._sSeparatorBackstageItemKey; // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <NZ_BackstageSeparator key={this._key} />\r\n    );\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Separator.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/Separator.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,kBAAkB,IAAI,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGxF;;;GAGG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK,CAAC,aAAiC;IAIjF,YAAY,yBAA6C;QACvD,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAEjC,sBAAsB,CAAC,2BAA2B,EAAE,CAAC,CAAC,8CAA8C;QACpG,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,2BAA2B,CAAC,CAAC,8CAA8C;IAChH,CAAC;IAEe,MAAM;QACpB,OAAO,CACL,oBAAC,qBAAqB,IAAC,GAAG,EAAE,IAAI,CAAC,IAAI,GAAI,CAC1C,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 { BackstageSeparator as NZ_BackstageSeparator } from \"@itwin/appui-layout-react\";\r\nimport { BackstageItemProps } from \"./BackstageItemProps\";\r\n\r\n/** Separator Backstage item.\r\n * @public\r\n * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.\r\n */\r\nexport class SeparatorBackstageItem extends React.PureComponent<BackstageItemProps> { // eslint-disable-line deprecation/deprecation\r\n  private static _sSeparatorBackstageItemKey: number;\r\n  private _key: number;\r\n\r\n  constructor(separatorBackstageItemDef: BackstageItemProps) { // eslint-disable-line deprecation/deprecation\r\n    super(separatorBackstageItemDef);\r\n\r\n    SeparatorBackstageItem._sSeparatorBackstageItemKey++; // eslint-disable-line deprecation/deprecation\r\n    this._key = SeparatorBackstageItem._sSeparatorBackstageItemKey; // eslint-disable-line deprecation/deprecation\r\n  }\r\n\r\n  public override render(): React.ReactNode {\r\n    return (\r\n      <NZ_BackstageSeparator key={this._key} />\r\n    );\r\n  }\r\n}\r\n"]}

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

@@ -5,7 +5,7 @@ import * as React from "react";
 import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
 /** Properties for a [[TaskLaunchBackstageItem]] component
  * @internal
- * @deprecated
+ * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.
  */
 export interface TaskLaunchBackstageItemProps extends BackstageItemProps {
     /** Workflow Id */
@@ -15,7 +15,7 @@ export interface TaskLaunchBackstageItemProps extends BackstageItemProps {
 }
 /** Backstage item that activates a Task
  * @internal
- * @deprecated
+ * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.
  */
 export declare class TaskLaunchBackstageItem extends React.PureComponent<TaskLaunchBackstageItemProps, BackstageItemState> {
     /** @internal */

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

@@ -21,7 +21,7 @@ import { BackstageItemUtilities } from "./BackstageItemUtilities";
 const BackstageItem = withSafeArea(NZ_BackstageItem);
 /** Backstage item that activates a Task
  * @internal
- * @deprecated
+ * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.
  */
 export class TaskLaunchBackstageItem extends React.PureComponent {
     constructor(props) {

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

@@ -1 +1 @@
-{"version":3,"file":"TaskLaunch.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/TaskLaunch.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,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,EAA0B,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC/E,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;AAarD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK,CAAC,aAA+D;IAOhH,YAAY,KAAmC;QAC7C,KAAK,CAAC,KAAK,CAAC,CAAC;QAJP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QA4B9E,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;QAMK,YAAO,GAAG,GAAS,EAAE;YAC1B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,MAAM,QAAQ,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACrE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjD,IAAI,IAAI;oBACN,eAAe,CAAC,wBAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,8DAA8D;;oBAExH,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,iBAAiB,IAAI,CAAC,KAAK,CAAC,MAAM,aAAa,CAAC,CAAC;aACtG;;gBACC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,qBAAqB,IAAI,CAAC,KAAK,CAAC,UAAU,aAAa,CAAC,CAAC;QAC/G,CAAC,CAAC;QASM,8BAAyB,GAAG,CAAC,IAA4B,EAAE,EAAE;YACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAChG,0BAA0B;YAC1B,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ;gBAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;QAtEA,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,MAAM,KAAK,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAA0B;QAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS;YACnC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACpI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,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;QAC3E,eAAe,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACnF,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,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;QAC9E,eAAe,CAAC,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACtF,CAAC;IAmBD,IAAW,EAAE;QACX,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACzD,CAAC;IAgBe,kBAAkB,CAAC,UAAwC;QACzE,MAAM,YAAY,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvF,YAAY,CAAC,QAAQ,GAAG,eAAe,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACzI,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;IASe,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,EAAE,EACZ,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\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport * as React from \"react\";\r\nimport { Logger } from \"@itwin/core-bentley\";\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 { TaskActivatedEventArgs, WorkflowManager } from \"../workflow/Workflow\";\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 [[TaskLaunchBackstageItem]] component\r\n * @internal\r\n * @deprecated\r\n */\r\nexport interface TaskLaunchBackstageItemProps extends BackstageItemProps { // eslint-disable-line deprecation/deprecation\r\n  /** Workflow Id */\r\n  workflowId: string;\r\n  /** Task Id */\r\n  taskId: string;\r\n}\r\n\r\n/** Backstage item that activates a Task\r\n * @internal\r\n * @deprecated\r\n */\r\nexport class TaskLaunchBackstageItem extends React.PureComponent<TaskLaunchBackstageItemProps, 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: TaskLaunchBackstageItemProps) {\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    const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n    /* istanbul ignore else */\r\n    if (this.props.isActive === undefined)\r\n      state.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;\r\n    this.state = state;\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    WorkflowManager.onTaskActivatedEvent.addListener(this._handleTaskActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);\r\n    WorkflowManager.onTaskActivatedEvent.removeListener(this._handleTaskActivatedEvent);\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 else */\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 get id(): string {\r\n    return `${this.props.workflowId}:${this.props.taskId}`;\r\n  }\r\n\r\n  public execute = (): void => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    const workflow = WorkflowManager.findWorkflow(this.props.workflowId);\r\n    if (workflow) {\r\n      const task = workflow.getTask(this.props.taskId);\r\n      if (task)\r\n        WorkflowManager.setActiveWorkflowAndTask(workflow, task); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      else\r\n        Logger.logError(UiFramework.loggerCategory(this), `Task with id '${this.props.taskId}' not found`);\r\n    } else\r\n      Logger.logError(UiFramework.loggerCategory(this), `Workflow with id '${this.props.workflowId}' not found`);\r\n  };\r\n\r\n  public override componentDidUpdate(_prevProps: TaskLaunchBackstageItemProps) {\r\n    const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);\r\n    updatedState.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;\r\n    if (!PropsHelper.isShallowEqual(updatedState, this.state))\r\n      this.setState((_prevState) => updatedState);\r\n  }\r\n\r\n  private _handleTaskActivatedEvent = (args: TaskActivatedEventArgs) => {\r\n    const isActive = args.taskId === this.props.taskId && args.workflowId === this.props.workflowId;\r\n    /* istanbul ignore else */\r\n    if (isActive !== this.state.isActive)\r\n      this.setState({ isActive });\r\n  };\r\n\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.id}\r\n        onClick={this.execute}\r\n      >\r\n        {this.state.label}\r\n      </BackstageItem>\r\n    );\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"TaskLaunch.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/TaskLaunch.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,4CAA4C;AAE5C,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,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,EAA0B,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC/E,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;AAarD;;;GAGG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK,CAAC,aAA+D;IAOhH,YAAY,KAAmC;QAC7C,KAAK,CAAC,KAAK,CAAC,CAAC;QAJP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QA4B9E,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;QAMK,YAAO,GAAG,GAAS,EAAE;YAC1B,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;YAEhE,MAAM,QAAQ,GAAG,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACrE,IAAI,QAAQ,EAAE;gBACZ,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACjD,IAAI,IAAI;oBACN,eAAe,CAAC,wBAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,8DAA8D;;oBAExH,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,iBAAiB,IAAI,CAAC,KAAK,CAAC,MAAM,aAAa,CAAC,CAAC;aACtG;;gBACC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,qBAAqB,IAAI,CAAC,KAAK,CAAC,UAAU,aAAa,CAAC,CAAC;QAC/G,CAAC,CAAC;QASM,8BAAyB,GAAG,CAAC,IAA4B,EAAE,EAAE;YACnE,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAChG,0BAA0B;YAC1B,IAAI,QAAQ,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ;gBAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;QAtEA,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,MAAM,KAAK,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAA0B;QAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,SAAS;YACnC,KAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACpI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,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;QAC3E,eAAe,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACnF,CAAC;IAEe,oBAAoB;QAClC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,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;QAC9E,eAAe,CAAC,oBAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACtF,CAAC;IAmBD,IAAW,EAAE;QACX,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACzD,CAAC;IAgBe,kBAAkB,CAAC,UAAwC;QACzE,MAAM,YAAY,GAAG,sBAAsB,CAAC,8BAA8B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvF,YAAY,CAAC,QAAQ,GAAG,eAAe,CAAC,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,eAAe,CAAC,gBAAgB,KAAK,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;QACzI,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;IASe,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,EAAE,EACZ,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\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport * as React from \"react\";\r\nimport { Logger } from \"@itwin/core-bentley\";\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 { TaskActivatedEventArgs, WorkflowManager } from \"../workflow/Workflow\";\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 [[TaskLaunchBackstageItem]] component\r\n * @internal\r\n * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.\r\n */\r\nexport interface TaskLaunchBackstageItemProps extends BackstageItemProps { // eslint-disable-line deprecation/deprecation\r\n  /** Workflow Id */\r\n  workflowId: string;\r\n  /** Task Id */\r\n  taskId: string;\r\n}\r\n\r\n/** Backstage item that activates a Task\r\n * @internal\r\n * @deprecated in 3.0. UI 1.0 will be removed in AppUi 4.0.\r\n */\r\nexport class TaskLaunchBackstageItem extends React.PureComponent<TaskLaunchBackstageItemProps, 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: TaskLaunchBackstageItemProps) {\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    const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);\r\n    /* istanbul ignore else */\r\n    if (this.props.isActive === undefined)\r\n      state.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;\r\n    this.state = state;\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    WorkflowManager.onTaskActivatedEvent.addListener(this._handleTaskActivatedEvent);\r\n  }\r\n\r\n  public override componentWillUnmount() {\r\n    this._componentUnmounting = true;\r\n    if (this.props.stateFunc && this._stateSyncIds.length > 0)\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);\r\n    WorkflowManager.onTaskActivatedEvent.removeListener(this._handleTaskActivatedEvent);\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 else */\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 get id(): string {\r\n    return `${this.props.workflowId}:${this.props.taskId}`;\r\n  }\r\n\r\n  public execute = (): void => {\r\n    Backstage.hide(); // eslint-disable-line deprecation/deprecation\r\n\r\n    const workflow = WorkflowManager.findWorkflow(this.props.workflowId);\r\n    if (workflow) {\r\n      const task = workflow.getTask(this.props.taskId);\r\n      if (task)\r\n        WorkflowManager.setActiveWorkflowAndTask(workflow, task); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n      else\r\n        Logger.logError(UiFramework.loggerCategory(this), `Task with id '${this.props.taskId}' not found`);\r\n    } else\r\n      Logger.logError(UiFramework.loggerCategory(this), `Workflow with id '${this.props.workflowId}' not found`);\r\n  };\r\n\r\n  public override componentDidUpdate(_prevProps: TaskLaunchBackstageItemProps) {\r\n    const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);\r\n    updatedState.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;\r\n    if (!PropsHelper.isShallowEqual(updatedState, this.state))\r\n      this.setState((_prevState) => updatedState);\r\n  }\r\n\r\n  private _handleTaskActivatedEvent = (args: TaskActivatedEventArgs) => {\r\n    const isActive = args.taskId === this.props.taskId && args.workflowId === this.props.workflowId;\r\n    /* istanbul ignore else */\r\n    if (isActive !== this.state.isActive)\r\n      this.setState({ isActive });\r\n  };\r\n\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.id}\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/useDefaultBackstageItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDefaultBackstageItems.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useDefaultBackstageItems.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAA8B,EAA4B,EAAE;IACnG,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO;YACxB,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;aAC5B;YACH,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7B,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAE,EAAE;YACxD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QACF,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACf,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 { BackstageItem, BackstageItemsChangedArgs, BackstageItemsManager } from \"@itwin/appui-abstract\";\r\n\r\n/** Hook that returns items from [[BackstageItemsManager]].\r\n * @internal\r\n */\r\nexport const useDefaultBackstageItems = (manager: BackstageItemsManager): readonly BackstageItem[] => {\r\n  const [items, setItems] = React.useState(manager.items);\r\n  const isInitialMount = React.useRef(true);\r\n  React.useEffect(() => {\r\n    if (isInitialMount.current)\r\n      isInitialMount.current = false;\r\n    else {\r\n      setItems(manager.items);\r\n    }\r\n  }, [manager, manager.items]);\r\n  React.useEffect(() => {\r\n    const handleChanged = (args: BackstageItemsChangedArgs) => {\r\n      setItems(args.items);\r\n    };\r\n    manager.onItemsChanged.addListener(handleChanged);\r\n    return () => {\r\n      manager.onItemsChanged.removeListener(handleChanged);\r\n    };\r\n  }, [manager]);\r\n  return items;\r\n};\r\n"]}
+{"version":3,"file":"useDefaultBackstageItems.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useDefaultBackstageItems.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAA8B,EAA4B,EAAE;IACnG,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,cAAc,CAAC,OAAO;YACxB,cAAc,CAAC,OAAO,GAAG,KAAK,CAAC;aAC5B;YACH,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7B,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,aAAa,GAAG,CAAC,IAA+B,EAAE,EAAE;YACxD,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC,CAAC;QACF,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QAClD,OAAO,GAAG,EAAE;YACV,OAAO,CAAC,cAAc,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACd,OAAO,KAAK,CAAC;AACf,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 { BackstageItem, BackstageItemsChangedArgs, BackstageItemsManager } from \"@itwin/appui-abstract\";\r\n\r\n/** Hook that returns items from [[BackstageItemsManager]].\r\n * @internal\r\n */\r\nexport const useDefaultBackstageItems = (manager: BackstageItemsManager): readonly BackstageItem[] => { // eslint-disable-line deprecation/deprecation\r\n  const [items, setItems] = React.useState(manager.items);\r\n  const isInitialMount = React.useRef(true);\r\n  React.useEffect(() => {\r\n    if (isInitialMount.current)\r\n      isInitialMount.current = false;\r\n    else {\r\n      setItems(manager.items);\r\n    }\r\n  }, [manager, manager.items]);\r\n  React.useEffect(() => {\r\n    const handleChanged = (args: BackstageItemsChangedArgs) => {\r\n      setItems(args.items);\r\n    };\r\n    manager.onItemsChanged.addListener(handleChanged);\r\n    return () => {\r\n      manager.onItemsChanged.removeListener(handleChanged);\r\n    };\r\n  }, [manager]);\r\n  return items;\r\n};\r\n"]}