@itwin/appui-react 3.0.0-dev.100

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

@@ -0,0 +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;AAUrD;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK,CAAC,aAAqE;IAM5H,YAAY,KAAyC;QACnD,KAAK,CAAC,KAAK,CAAC,CAAC;QAJP,yBAAoB,GAAG,KAAK,CAAC,CAAE,mGAAmG;QAClI,kBAAa,GAAa,EAAE,CAAC,CAAE,+CAA+C;QA6B9E,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;QA/DA,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,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC3E,iBAAiB,CAAC,0BAA0B,CAAC,WAAW,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IACjG,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;QAC9E,iBAAiB,CAAC,0BAA0B,CAAC,cAAc,CAAC,IAAI,CAAC,+BAA+B,CAAC,CAAC;IACpG,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 */\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 */\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\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      SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);\r\n    FrontstageManager.onFrontstageActivatedEvent.addListener(this._handleFrontstageActivatedEvent);\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    FrontstageManager.onFrontstageActivatedEvent.removeListener(this._handleFrontstageActivatedEvent);\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"]}

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

@@ -0,0 +1,15 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { BackstageItemProps } from "./BackstageItemProps";
+/** Separator Backstage item.
+ * @public
+ */
+export declare class SeparatorBackstageItem extends React.PureComponent<BackstageItemProps> {
+    private static _sSeparatorBackstageItemKey;
+    private _key;
+    constructor(separatorBackstageItemDef: BackstageItemProps);
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=Separator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Separator.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/Separator.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,KAAK,CAAC,aAAa,CAAC,kBAAkB,CAAC;IACjF,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAAS;IACnD,OAAO,CAAC,IAAI,CAAS;gBAET,yBAAyB,EAAE,kBAAkB;IAOzC,MAAM,IAAI,KAAK,CAAC,SAAS;CAK1C"}

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

@@ -0,0 +1,23 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { BackstageSeparator as NZ_BackstageSeparator } from "@itwin/appui-layout-react";
+/** Separator Backstage item.
+ * @public
+ */
+export class SeparatorBackstageItem extends React.PureComponent {
+    constructor(separatorBackstageItemDef) {
+        super(separatorBackstageItemDef);
+        SeparatorBackstageItem._sSeparatorBackstageItemKey++;
+        this._key = SeparatorBackstageItem._sSeparatorBackstageItemKey;
+    }
+    render() {
+        return (React.createElement(NZ_BackstageSeparator, { key: this._key }));
+    }
+}
+//# sourceMappingURL=Separator.js.map

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

@@ -0,0 +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;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK,CAAC,aAAiC;IAIjF,YAAY,yBAA6C;QACvD,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAEjC,sBAAsB,CAAC,2BAA2B,EAAE,CAAC;QACrD,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC,2BAA2B,CAAC;IACjE,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 */\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++;\r\n    this._key = SeparatorBackstageItem._sSeparatorBackstageItemKey;\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

@@ -0,0 +1,35 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+import { BackstageItemProps, BackstageItemState } from "./BackstageItemProps";
+/** Properties for a [[TaskLaunchBackstageItem]] component
+ * @internal
+ * @deprecated
+ */
+export interface TaskLaunchBackstageItemProps extends BackstageItemProps {
+    /** Workflow Id */
+    workflowId: string;
+    /** Task Id */
+    taskId: string;
+}
+/** Backstage item that activates a Task
+ * @internal
+ * @deprecated
+ */
+export declare class TaskLaunchBackstageItem extends React.PureComponent<TaskLaunchBackstageItemProps, BackstageItemState> {
+    /** @internal */
+    readonly state: Readonly<BackstageItemState>;
+    private _componentUnmounting;
+    private _stateSyncIds;
+    constructor(props: TaskLaunchBackstageItemProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleSyncUiEvent;
+    get id(): string;
+    execute: () => void;
+    componentDidUpdate(_prevProps: TaskLaunchBackstageItemProps): void;
+    private _handleTaskActivatedEvent;
+    render(): React.ReactNode;
+}
+//# sourceMappingURL=TaskLaunch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TaskLaunch.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/TaskLaunch.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAQ9E;;;GAGG;AACH,MAAM,WAAW,4BAA6B,SAAQ,kBAAkB;IACtE,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,KAAK,CAAC,aAAa,CAAC,4BAA4B,EAAE,kBAAkB,CAAC;IAEhH,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC7D,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,aAAa,CAAgB;gBAEzB,KAAK,EAAE,4BAA4B;IAa/B,iBAAiB;IAMjB,oBAAoB;IAOpC,OAAO,CAAC,kBAAkB,CAexB;IAEF,IAAW,EAAE,IAAI,MAAM,CAEtB;IAEM,OAAO,QAAO,IAAI,CAYvB;IAEc,kBAAkB,CAAC,UAAU,EAAE,4BAA4B;IAO3E,OAAO,CAAC,yBAAyB,CAK/B;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;CAa1C"}

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

@@ -0,0 +1,97 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/* eslint-disable deprecation/deprecation */
+import * as React from "react";
+import { Logger } from "@itwin/core-bentley";
+import { BackstageItem as NZ_BackstageItem } from "@itwin/appui-layout-react";
+import { withSafeArea } from "../safearea/SafeAreaContext";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+import { PropsHelper } from "../utils/PropsHelper";
+import { WorkflowManager } from "../workflow/Workflow";
+import { Backstage } from "./Backstage";
+import { BackstageItemUtilities } from "./BackstageItemUtilities";
+// cspell:ignore safearea
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackstageItem = withSafeArea(NZ_BackstageItem);
+/** Backstage item that activates a Task
+ * @internal
+ * @deprecated
+ */
+export class TaskLaunchBackstageItem extends React.PureComponent {
+    constructor(props) {
+        super(props);
+        this._componentUnmounting = false; // used to ensure _handleSyncUiEvent callback is not processed after componentWillUnmount is called
+        this._stateSyncIds = []; // local version of syncId that are lower cased
+        this._handleSyncUiEvent = (args) => {
+            /* istanbul ignore next */
+            if (this._componentUnmounting)
+                return;
+            /* istanbul ignore else */
+            if (SyncUiEventDispatcher.hasEventOfInterest(args.eventIds, this._stateSyncIds)) {
+                /* istanbul ignore else */
+                if (this.props.stateFunc) {
+                    const newState = this.props.stateFunc(this.state);
+                    /* istanbul ignore else */
+                    if (!PropsHelper.isShallowEqual(newState, this.state))
+                        this.setState((_prevState) => newState);
+                }
+            }
+        };
+        this.execute = () => {
+            Backstage.hide(); // eslint-disable-line deprecation/deprecation
+            const workflow = WorkflowManager.findWorkflow(this.props.workflowId);
+            if (workflow) {
+                const task = workflow.getTask(this.props.taskId);
+                if (task)
+                    WorkflowManager.setActiveWorkflowAndTask(workflow, task); // eslint-disable-line @typescript-eslint/no-floating-promises
+                else
+                    Logger.logError(UiFramework.loggerCategory(this), `Task with id '${this.props.taskId}' not found`);
+            }
+            else
+                Logger.logError(UiFramework.loggerCategory(this), `Workflow with id '${this.props.workflowId}' not found`);
+        };
+        this._handleTaskActivatedEvent = (args) => {
+            const isActive = args.taskId === this.props.taskId && args.workflowId === this.props.workflowId;
+            /* istanbul ignore else */
+            if (isActive !== this.state.isActive)
+                this.setState({ isActive });
+        };
+        if (props.stateSyncIds)
+            this._stateSyncIds = props.stateSyncIds.map((value) => value.toLowerCase());
+        const state = BackstageItemUtilities.getBackstageItemStateFromProps(props);
+        /* istanbul ignore else */
+        if (this.props.isActive === undefined)
+            state.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;
+        this.state = state;
+    }
+    componentDidMount() {
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.addListener(this._handleSyncUiEvent);
+        WorkflowManager.onTaskActivatedEvent.addListener(this._handleTaskActivatedEvent);
+    }
+    componentWillUnmount() {
+        this._componentUnmounting = true;
+        if (this.props.stateFunc && this._stateSyncIds.length > 0)
+            SyncUiEventDispatcher.onSyncUiEvent.removeListener(this._handleSyncUiEvent);
+        WorkflowManager.onTaskActivatedEvent.removeListener(this._handleTaskActivatedEvent);
+    }
+    get id() {
+        return `${this.props.workflowId}:${this.props.taskId}`;
+    }
+    componentDidUpdate(_prevProps) {
+        const updatedState = BackstageItemUtilities.getBackstageItemStateFromProps(this.props);
+        updatedState.isActive = WorkflowManager.activeTaskId === this.props.taskId && WorkflowManager.activeWorkflowId === this.props.workflowId;
+        if (!PropsHelper.isShallowEqual(updatedState, this.state))
+            this.setState((_prevState) => updatedState);
+    }
+    render() {
+        return (React.createElement(BackstageItem, { icon: PropsHelper.getIcon(this.state.iconSpec), isActive: this.state.isActive, isDisabled: !this.state.isEnabled, key: this.id, onClick: this.execute }, this.state.label));
+    }
+}
+//# sourceMappingURL=TaskLaunch.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,9 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BackstageItem, BackstageItemsManager } from "@itwin/appui-abstract";
+/** Hook that returns items from [[BackstageItemsManager]].
+ * @internal
+ */
+export declare const useDefaultBackstageItems: (manager: BackstageItemsManager) => readonly BackstageItem[];
+//# sourceMappingURL=useDefaultBackstageItems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useDefaultBackstageItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useDefaultBackstageItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,aAAa,EAA6B,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAExG;;GAEG;AACH,eAAO,MAAM,wBAAwB,YAAa,qBAAqB,KAAG,SAAS,aAAa,EAoB/F,CAAC"}

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

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+import * as React from "react";
+/** Hook that returns items from [[BackstageItemsManager]].
+ * @internal
+ */
+export const useDefaultBackstageItems = (manager) => {
+    const [items, setItems] = React.useState(manager.items);
+    const isInitialMount = React.useRef(true);
+    React.useEffect(() => {
+        if (isInitialMount.current)
+            isInitialMount.current = false;
+        else {
+            setItems(manager.items);
+        }
+    }, [manager, manager.items]);
+    React.useEffect(() => {
+        const handleChanged = (args) => {
+            setItems(args.items);
+        };
+        manager.onItemsChanged.addListener(handleChanged);
+        return () => {
+            manager.onItemsChanged.removeListener(handleChanged);
+        };
+    }, [manager]);
+    return items;
+};
+//# sourceMappingURL=useDefaultBackstageItems.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,9 @@
+/** @packageDocumentation
+ * @module StatusBar
+ */
+import { BackstageItem, BackstageItemsManager } from "@itwin/appui-abstract";
+/** Hook that returns items from [[BackstageItemsManager]].
+ * @public
+ */
+export declare const useUiItemsProviderBackstageItems: (manager: BackstageItemsManager) => readonly BackstageItem[];
+//# sourceMappingURL=useUiItemsProviderBackstageItems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useUiItemsProviderBackstageItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useUiItemsProviderBackstageItems.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAGH,OAAO,EAAE,aAAa,EAA6B,qBAAqB,EAAkB,MAAM,uBAAuB,CAAC;AAKxH;;GAEG;AACH,eAAO,MAAM,gCAAgC,YAAa,qBAAqB,KAAG,SAAS,aAAa,EA2BvG,CAAC"}

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

@@ -0,0 +1,44 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module StatusBar
+ */
+import * as React from "react";
+import { UiItemsManager } from "@itwin/appui-abstract";
+import { useAvailableUiItemsProviders } from "../hooks/useAvailableUiItemsProviders";
+// cspell:ignore setxxx
+/** Hook that returns items from [[BackstageItemsManager]].
+ * @public
+ */
+export const useUiItemsProviderBackstageItems = (manager) => {
+    const uiItemProviderIds = useAvailableUiItemsProviders();
+    const [items, setItems] = React.useState(manager ? manager.items : /* istanbul ignore next */ []);
+    const providersRef = React.useRef("");
+    // gathers items from registered extensions - dependent on when a UiItemsProvider is register or unregistered and if the
+    // current stage's composer allows entries from extensions.
+    React.useEffect(() => {
+        const uiProviders = uiItemProviderIds.join("-");
+        // istanbul ignore else
+        if (providersRef.current !== uiProviders) {
+            providersRef.current = uiProviders;
+            const backstageItems = UiItemsManager.getBackstageItems();
+            manager.loadItems(backstageItems);
+            setItems(manager.items);
+        }
+    }, [manager, uiItemProviderIds]);
+    // handle item changes caused by calls to UiFramework.addonStatusBarItemsManager.setxxx
+    React.useEffect(() => {
+        const handleChanged = (args) => {
+            setItems(args.items);
+        };
+        manager.onItemsChanged.addListener(handleChanged);
+        return () => {
+            manager.onItemsChanged.removeListener(handleChanged);
+        };
+    }, [manager]);
+    return items;
+};
+//# sourceMappingURL=useUiItemsProviderBackstageItems.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useUiItemsProviderBackstageItems.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useUiItemsProviderBackstageItems.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAmE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACxH,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAErF,uBAAuB;AAEvB;;GAEG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,OAA8B,EAA4B,EAAE;IAC3G,MAAM,iBAAiB,GAAG,4BAA4B,EAAE,CAAC;IACzD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,0BAA0B,CAAA,EAAE,CAAC,CAAC;IACjG,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACtC,wHAAwH;IACxH,2DAA2D;IAC3D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,uBAAuB;QACvB,IAAI,YAAY,CAAC,OAAO,KAAK,WAAW,EAAE;YACxC,YAAY,CAAC,OAAO,GAAG,WAAW,CAAC;YACnC,MAAM,cAAc,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC;YAC1D,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;YAClC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACzB;IACH,CAAC,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;IACjC,uFAAuF;IACvF,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module StatusBar\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { BackstageItem, BackstageItemsChangedArgs, BackstageItemsManager, UiItemsManager } from \"@itwin/appui-abstract\";\r\nimport { useAvailableUiItemsProviders } from \"../hooks/useAvailableUiItemsProviders\";\r\n\r\n// cspell:ignore setxxx\r\n\r\n/** Hook that returns items from [[BackstageItemsManager]].\r\n * @public\r\n */\r\nexport const useUiItemsProviderBackstageItems = (manager: BackstageItemsManager): readonly BackstageItem[] => {\r\n  const uiItemProviderIds = useAvailableUiItemsProviders();\r\n  const [items, setItems] = React.useState(manager ? manager.items : /* istanbul ignore next */[]);\r\n  const providersRef = React.useRef(\"\");\r\n  // gathers items from registered extensions - dependent on when a UiItemsProvider is register or unregistered and if the\r\n  // current stage's composer allows entries from extensions.\r\n  React.useEffect(() => {\r\n    const uiProviders = uiItemProviderIds.join(\"-\");\r\n    // istanbul ignore else\r\n    if (providersRef.current !== uiProviders) {\r\n      providersRef.current = uiProviders;\r\n      const backstageItems = UiItemsManager.getBackstageItems();\r\n      manager.loadItems(backstageItems);\r\n      setItems(manager.items);\r\n    }\r\n  }, [manager, uiItemProviderIds]);\r\n  // handle item changes caused by calls to UiFramework.addonStatusBarItemsManager.setxxx\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"]}

package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts

@@ -0,0 +1,35 @@
+/** @packageDocumentation
+ * @module ChildWindowManager
+ */
+import "./ChildWindowManager.scss";
+import * as React from "react";
+/** @public */
+export interface OpenChildWindowInfo {
+    childWindowId: string;
+    window: Window;
+    parentWindow: Window;
+}
+/** @public */
+export interface ChildWindowLocationProps {
+    width: number;
+    height: number;
+    left: number;
+    top: number;
+}
+/** Supports opening a child browser window from the main application window. The child window is managed by the main application
+ * and is running in the same security context. The application must deliver the html file iTwinPopup.html along side its index.html.
+ * See also: [Child Window Manager]($docs/learning/ui/framework/ChildWindows.md)
+ * @public */
+export declare class ChildWindowManager {
+    private _openChildWindows;
+    get openChildWindows(): OpenChildWindowInfo[];
+    findChildWindow(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
+    findChildWindowId(contentWindow: Window | undefined | null): string | undefined;
+    private renderChildWindowContents;
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    closeAllChildWindows(): void;
+    closeChildWindow: (childWindowId: string, processWindowClose?: boolean) => boolean;
+    private adjustWidowLocation;
+    openChildWindow(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
+}
+//# sourceMappingURL=ChildWindowManager.d.ts.map

package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChildWindowManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/childwindow/ChildWindowManager.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,2BAA2B,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAsC/B,cAAc;AACd,MAAM,WAAW,mBAAmB;IAClC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;aAGa;AACb,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,iBAAiB,CAA6B;IAEtD,IAAW,gBAAgB,0BAE1B;IAEM,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,GAAG,SAAS;IAOnF,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS;IAStF,OAAO,CAAC,yBAAyB;IA+CjC,gGAAgG;IACzF,oBAAoB;IAMpB,gBAAgB,kBAAmB,MAAM,2CAc9C;IAGF,OAAO,CAAC,mBAAmB;IAuBpB,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,OAAO;CA8BzJ"}

package/lib/esm/appui-react/childwindow/ChildWindowManager.js

@@ -0,0 +1,177 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ChildWindowManager
+ */
+import "./ChildWindowManager.scss";
+import * as React from "react";
+import * as ReactDOM from "react-dom";
+import { copyStyles } from "./CopyStyles";
+import { Provider } from "react-redux";
+import { UiFramework } from "../UiFramework";
+import { StateManager } from "../redux/StateManager";
+import { UiSettingsProvider } from "../uisettings/useUiSettings";
+import { PopupRenderer } from "../popup/PopupManager";
+import { ModelessDialogRenderer } from "../dialog/ModelessDialogManager";
+import { ModalDialogRenderer } from "../dialog/ModalDialogManager";
+import { CursorPopupMenu } from "../cursor/cursormenu/CursorMenu";
+import { FrameworkVersion } from "../hooks/useFrameworkVersion";
+import { FrontstageManager } from "../frontstage/FrontstageManager";
+import { ThemeManager } from "../theme/ThemeManager";
+const childHtml = `<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <style>
+    html,
+    body {
+      height: 100%;
+      width: 100%;
+      margin: 0;
+      overflow: hidden;
+    }
+    #root {
+      height: 100%;
+    }
+  </style>
+</head>
+<body>
+  <noscript>You need to enable JavaScript to run this app.</noscript>
+  <div id="root"></div>
+</body>
+</html>`;
+/** Supports opening a child browser window from the main application window. The child window is managed by the main application
+ * and is running in the same security context. The application must deliver the html file iTwinPopup.html along side its index.html.
+ * See also: [Child Window Manager]($docs/learning/ui/framework/ChildWindows.md)
+ * @public */
+export class ChildWindowManager {
+    constructor() {
+        this._openChildWindows = [];
+        this.closeChildWindow = (childWindowId, processWindowClose = true) => {
+            const windowIndex = this.openChildWindows.findIndex((openWindow) => openWindow.childWindowId === childWindowId);
+            if (-1 === windowIndex)
+                return false;
+            const childWindow = this.openChildWindows[windowIndex];
+            this.openChildWindows.splice(windowIndex, 1);
+            if (processWindowClose) {
+                childWindow.window.close();
+            }
+            else {
+                // call the following to convert popout to docked widget
+                const frontStageDef = FrontstageManager.activeFrontstageDef;
+                frontStageDef && frontStageDef.dockPopoutWidgetContainer(childWindowId);
+            }
+            return true;
+        };
+    }
+    get openChildWindows() {
+        return this._openChildWindows;
+    }
+    findChildWindow(childWindowId) {
+        if (undefined === childWindowId)
+            return undefined;
+        return this.openChildWindows.find((openWindow) => openWindow.childWindowId === childWindowId);
+    }
+    findChildWindowId(contentWindow) {
+        if (!contentWindow)
+            return undefined;
+        const childWindow = this.openChildWindows.find((openWindow) => openWindow.window === contentWindow);
+        return childWindow === null || childWindow === void 0 ? void 0 : childWindow.childWindowId;
+    }
+    // istanbul ignore next
+    renderChildWindowContents(childWindow, childWindowId, content) {
+        const reactConnectionDiv = childWindow.document.getElementById("root");
+        if (reactConnectionDiv) {
+            // set openChildWindows now so components can use it when they mount
+            this._openChildWindows.push({
+                childWindowId,
+                window: childWindow,
+                parentWindow: window,
+            });
+            setTimeout(() => {
+                copyStyles(childWindow.document);
+                setImmediate(() => {
+                    ReactDOM.render(React.createElement(Provider, { store: StateManager.store },
+                        React.createElement(UiSettingsProvider, { settingsStorage: UiFramework.getUiSettingsStorage() },
+                            React.createElement(ThemeManager, null,
+                                React.createElement(FrameworkVersion, null,
+                                    React.createElement("div", { className: "uifw-child-window-container-host" },
+                                        React.createElement(PopupRenderer, null),
+                                        React.createElement(ModalDialogRenderer, null),
+                                        React.createElement(ModelessDialogRenderer, null),
+                                        React.createElement(CursorPopupMenu, null),
+                                        React.createElement("div", { className: "uifw-child-window-container nz-widget-widget" }, content)))))), reactConnectionDiv);
+                });
+            });
+            childWindow.onbeforeunload = () => {
+                const frontStageDef = FrontstageManager.activeFrontstageDef;
+                if (frontStageDef) {
+                    void frontStageDef.saveChildWindowSizeAndPosition(childWindowId, childWindow).then(() => {
+                        this.closeChildWindow(childWindowId, false);
+                    });
+                }
+            };
+        }
+    }
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    closeAllChildWindows() {
+        // istanbul ignore next
+        this.openChildWindows.forEach((openChildWindow) => openChildWindow.window.close());
+        this._openChildWindows = [];
+    }
+    // istanbul ignore next
+    adjustWidowLocation(location, center) {
+        var _a;
+        const outLocation = { ...location };
+        if (0 === location.top && 0 === location.left) {
+            center = center !== null && center !== void 0 ? center : true;
+            const windowTop = (_a = window.top) !== null && _a !== void 0 ? _a : window;
+            // Prepare position of the new window to be centered against the 'parent' window.
+            if (center) {
+                outLocation.left =
+                    windowTop.outerWidth / 2 + windowTop.screenX - location.width / 2;
+                outLocation.top =
+                    windowTop.outerHeight / 2 + windowTop.screenY - location.height / 2;
+            }
+            else {
+                if (undefined !== window.screenLeft && undefined !== window.screenTop) {
+                    outLocation.top = window.screenTop + location.top;
+                    outLocation.left = window.screenLeft + location.left;
+                }
+            }
+        }
+        return outLocation;
+    }
+    // istanbul ignore next
+    openChildWindow(childWindowId, title, content, location, useDefaultPopoutUrl) {
+        // first check to see if content is already open in child window
+        if (this.openChildWindows.findIndex((openWindow) => openWindow.childWindowId === childWindowId) >= 0) {
+            return false;
+        }
+        location = this.adjustWidowLocation(location);
+        const url = useDefaultPopoutUrl ? "/iTwinPopup.html" : "";
+        const childWindow = window.open(url, "", `width=${location.width},height=${location.height},left=${location.left},top=${location.top},menubar=no,resizable=yes,scrollbars=no,status=no,location=no`);
+        if (!childWindow)
+            return false;
+        if (0 === url.length) {
+            childWindow.document.write(childHtml);
+            this.renderChildWindowContents(childWindow, childWindowId, content);
+        }
+        else {
+            childWindow.addEventListener("load", () => {
+                childWindow.document.title = title;
+                this.renderChildWindowContents(childWindow, childWindowId, content);
+            }, false);
+        }
+        window.addEventListener("beforeunload", () => {
+            const frontStageDef = FrontstageManager.activeFrontstageDef;
+            if (frontStageDef) {
+                this.closeChildWindow(childWindowId, true);
+            }
+        }, false);
+        return true;
+    }
+}
+//# sourceMappingURL=ChildWindowManager.js.map

package/lib/esm/appui-react/childwindow/ChildWindowManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChildWindowManager.js","sourceRoot":"","sources":["../../../../src/appui-react/childwindow/ChildWindowManager.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,2BAA2B,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,QAAQ,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD,MAAM,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;QAqBV,CAAC;AAiBT;;;aAGa;AACb,MAAM,OAAO,kBAAkB;IAA/B;QACU,sBAAiB,GAA0B,EAAE,CAAC;QA4E/C,qBAAgB,GAAG,CAAC,aAAqB,EAAE,kBAAkB,GAAG,IAAI,EAAE,EAAE;YAC7E,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,KAAK,aAAa,CAAC,CAAC;YAChH,IAAI,CAAC,CAAC,KAAK,WAAW;gBACpB,OAAO,KAAK,CAAC;YACf,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YACvD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;YAC7C,IAAI,kBAAkB,EAAE;gBACtB,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;aAC5B;iBAAM;gBACL,wDAAwD;gBACxD,MAAM,aAAa,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;gBAC5D,aAAa,IAAI,aAAa,CAAC,yBAAyB,CAAC,aAAa,CAAC,CAAC;aACzE;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;IAwDJ,CAAC;IAhJC,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAEM,eAAe,CAAC,aAAiC;QACtD,IAAI,SAAS,KAAK,aAAa;YAC7B,OAAO,SAAS,CAAC;QAEnB,OAAO,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,KAAK,aAAa,CAAC,CAAC;IAChG,CAAC;IAEM,iBAAiB,CAAC,aAAwC;QAC/D,IAAI,CAAC,aAAa;YAChB,OAAO,SAAS,CAAC;QAEnB,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,aAAa,CAAC,CAAC;QACpG,OAAO,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,aAAa,CAAC;IACpC,CAAC;IAED,uBAAuB;IACf,yBAAyB,CAAC,WAAmB,EAAE,aAAqB,EAAE,OAAwB;QACpG,MAAM,kBAAkB,GAAG,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACvE,IAAI,kBAAkB,EAAE;YACtB,oEAAoE;YACpE,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC;gBAC1B,aAAa;gBACb,MAAM,EAAE,WAAW;gBACnB,YAAY,EAAE,MAAM;aACrB,CAAC,CAAC;YAEH,UAAU,CAAC,GAAG,EAAE;gBACd,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBACjC,YAAY,CAAC,GAAG,EAAE;oBAChB,QAAQ,CAAC,MAAM,CACb,oBAAC,QAAQ,IAAC,KAAK,EAAE,YAAY,CAAC,KAAK;wBACjC,oBAAC,kBAAkB,IAAC,eAAe,EAAE,WAAW,CAAC,oBAAoB,EAAE;4BACrE,oBAAC,YAAY;gCACX,oBAAC,gBAAgB;oCACf,6BAAK,SAAS,EAAC,kCAAkC;wCAC/C,oBAAC,aAAa,OAAG;wCACjB,oBAAC,mBAAmB,OAAG;wCACvB,oBAAC,sBAAsB,OAAG;wCAC1B,oBAAC,eAAe,OAAG;wCACnB,6BAAK,SAAS,EAAC,8CAA8C,IAC1D,OAAO,CACJ,CACF,CACW,CACN,CACI,CACZ,EACX,kBAAkB,CACnB,CAAC;gBACJ,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,WAAW,CAAC,cAAc,GAAG,GAAG,EAAE;gBAChC,MAAM,aAAa,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;gBAC5D,IAAI,aAAa,EAAE;oBACjB,KAAK,aAAa,CAAC,8BAA8B,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;wBACtF,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;oBAC9C,CAAC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC;SACH;IACH,CAAC;IAED,gGAAgG;IACzF,oBAAoB;QACzB,uBAAuB;QACvB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;QACnF,IAAI,CAAC,iBAAiB,GAAG,EAAE,CAAC;IAC9B,CAAC;IAkBD,uBAAuB;IACf,mBAAmB,CAAC,QAAkC,EAAE,MAAgB;;QAC9E,MAAM,WAAW,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QACpC,IAAI,CAAC,KAAK,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI,EAAE;YAC7C,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,CAAC;YACxB,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,GAAG,mCAAI,MAAM,CAAC;YAEvC,iFAAiF;YACjF,IAAI,MAAM,EAAE;gBACV,WAAW,CAAC,IAAI;oBACd,SAAS,CAAC,UAAU,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,GAAG,QAAQ,CAAC,KAAK,GAAG,CAAC,CAAC;gBACpE,WAAW,CAAC,GAAG;oBACb,SAAS,CAAC,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC,OAAO,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;aACvE;iBAAM;gBACL,IAAI,SAAS,KAAK,MAAM,CAAC,UAAU,IAAI,SAAS,KAAK,MAAM,CAAC,SAAS,EAAE;oBACrE,WAAW,CAAC,GAAG,GAAG,MAAM,CAAC,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC;oBAClD,WAAW,CAAC,IAAI,GAAG,MAAM,CAAC,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC;iBACtD;aACF;SACF;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,uBAAuB;IAChB,eAAe,CAAC,aAAqB,EAAE,KAAa,EAAE,OAAwB,EAAE,QAAkC,EAAE,mBAA6B;QACtJ,gEAAgE;QAChE,IAAI,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,aAAa,KAAK,aAAa,CAAC,IAAI,CAAC,EAAE;YACpG,OAAO,KAAK,CAAC;SACd;QAED,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1D,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,SAAS,QAAQ,CAAC,KAAK,WAAW,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,IAAI,QAAQ,QAAQ,CAAC,GAAG,+DAA+D,CAAC,CAAC;QACrM,IAAI,CAAC,WAAW;YACd,OAAO,KAAK,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,EAAE;YACpB,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACtC,IAAI,CAAC,yBAAyB,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;SACrE;aAAM;YACL,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE;gBACxC,WAAW,CAAC,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC;gBACnC,IAAI,CAAC,yBAAyB,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;YACtE,CAAC,EAAE,KAAK,CAAC,CAAC;SACX;QAED,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,GAAG,EAAE;YAC3C,MAAM,aAAa,GAAG,iBAAiB,CAAC,mBAAmB,CAAC;YAC5D,IAAI,aAAa,EAAE;gBACjB,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aAC5C;QACH,CAAC,EAAE,KAAK,CAAC,CAAC;QAEV,OAAO,IAAI,CAAC;IACd,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\r\n/** @packageDocumentation\r\n * @module ChildWindowManager\r\n */\r\n\r\nimport \"./ChildWindowManager.scss\";\r\nimport * as React from \"react\";\r\nimport * as ReactDOM from \"react-dom\";\r\nimport { copyStyles } from \"./CopyStyles\";\r\nimport { Provider } from \"react-redux\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { StateManager } from \"../redux/StateManager\";\r\nimport { UiSettingsProvider } from \"../uisettings/useUiSettings\";\r\nimport { PopupRenderer } from \"../popup/PopupManager\";\r\nimport { ModelessDialogRenderer } from \"../dialog/ModelessDialogManager\";\r\nimport { ModalDialogRenderer } from \"../dialog/ModalDialogManager\";\r\nimport { CursorPopupMenu } from \"../cursor/cursormenu/CursorMenu\";\r\nimport { FrameworkVersion } from \"../hooks/useFrameworkVersion\";\r\nimport { FrontstageManager } from \"../frontstage/FrontstageManager\";\r\nimport { ThemeManager } from \"../theme/ThemeManager\";\r\n\r\nconst childHtml = `<!DOCTYPE html>\r\n<html>\r\n<head>\r\n  <meta charset=\"utf-8\" />\r\n  <style>\r\n    html,\r\n    body {\r\n      height: 100%;\r\n      width: 100%;\r\n      margin: 0;\r\n      overflow: hidden;\r\n    }\r\n    #root {\r\n      height: 100%;\r\n    }\r\n  </style>\r\n</head>\r\n<body>\r\n  <noscript>You need to enable JavaScript to run this app.</noscript>\r\n  <div id=\"root\"></div>\r\n</body>\r\n</html>`;\r\n\r\n/** @public */\r\nexport interface OpenChildWindowInfo {\r\n  childWindowId: string;\r\n  window: Window;\r\n  parentWindow: Window;\r\n}\r\n\r\n/** @public */\r\nexport interface ChildWindowLocationProps {\r\n  width: number;\r\n  height: number;\r\n  left: number;\r\n  top: number;\r\n}\r\n\r\n/** Supports opening a child browser window from the main application window. The child window is managed by the main application\r\n * and is running in the same security context. The application must deliver the html file iTwinPopup.html along side its index.html.\r\n * See also: [Child Window Manager]($docs/learning/ui/framework/ChildWindows.md)\r\n * @public */\r\nexport class ChildWindowManager {\r\n  private _openChildWindows: OpenChildWindowInfo[] = [];\r\n\r\n  public get openChildWindows() {\r\n    return this._openChildWindows;\r\n  }\r\n\r\n  public findChildWindow(childWindowId: string | undefined): OpenChildWindowInfo | undefined {\r\n    if (undefined === childWindowId)\r\n      return undefined;\r\n\r\n    return this.openChildWindows.find((openWindow) => openWindow.childWindowId === childWindowId);\r\n  }\r\n\r\n  public findChildWindowId(contentWindow: Window | undefined | null): string | undefined {\r\n    if (!contentWindow)\r\n      return undefined;\r\n\r\n    const childWindow = this.openChildWindows.find((openWindow) => openWindow.window === contentWindow);\r\n    return childWindow?.childWindowId;\r\n  }\r\n\r\n  // istanbul ignore next\r\n  private renderChildWindowContents(childWindow: Window, childWindowId: string, content: React.ReactNode) {\r\n    const reactConnectionDiv = childWindow.document.getElementById(\"root\");\r\n    if (reactConnectionDiv) {\r\n      // set openChildWindows now so components can use it when they mount\r\n      this._openChildWindows.push({\r\n        childWindowId,\r\n        window: childWindow,\r\n        parentWindow: window,\r\n      });\r\n\r\n      setTimeout(() => {\r\n        copyStyles(childWindow.document);\r\n        setImmediate(() => {\r\n          ReactDOM.render(\r\n            <Provider store={StateManager.store} >\r\n              <UiSettingsProvider settingsStorage={UiFramework.getUiSettingsStorage()}>\r\n                <ThemeManager>\r\n                  <FrameworkVersion>\r\n                    <div className=\"uifw-child-window-container-host\">\r\n                      <PopupRenderer />\r\n                      <ModalDialogRenderer />\r\n                      <ModelessDialogRenderer />\r\n                      <CursorPopupMenu />\r\n                      <div className=\"uifw-child-window-container nz-widget-widget\">\r\n                        {content}\r\n                      </div>\r\n                    </div>\r\n                  </FrameworkVersion>\r\n                </ThemeManager>\r\n              </UiSettingsProvider>\r\n            </Provider>,\r\n            reactConnectionDiv\r\n          );\r\n        });\r\n      });\r\n\r\n      childWindow.onbeforeunload = () => {\r\n        const frontStageDef = FrontstageManager.activeFrontstageDef;\r\n        if (frontStageDef) {\r\n          void frontStageDef.saveChildWindowSizeAndPosition(childWindowId, childWindow).then(() => {\r\n            this.closeChildWindow(childWindowId, false);\r\n          });\r\n        }\r\n      };\r\n    }\r\n  }\r\n\r\n  /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */\r\n  public closeAllChildWindows() {\r\n    // istanbul ignore next\r\n    this.openChildWindows.forEach((openChildWindow) => openChildWindow.window.close());\r\n    this._openChildWindows = [];\r\n  }\r\n\r\n  public closeChildWindow = (childWindowId: string, processWindowClose = true) => {\r\n    const windowIndex = this.openChildWindows.findIndex((openWindow) => openWindow.childWindowId === childWindowId);\r\n    if (-1 === windowIndex)\r\n      return false;\r\n    const childWindow = this.openChildWindows[windowIndex];\r\n    this.openChildWindows.splice(windowIndex, 1);\r\n    if (processWindowClose) {\r\n      childWindow.window.close();\r\n    } else {\r\n      // call the following to convert popout to docked widget\r\n      const frontStageDef = FrontstageManager.activeFrontstageDef;\r\n      frontStageDef && frontStageDef.dockPopoutWidgetContainer(childWindowId);\r\n    }\r\n    return true;\r\n  };\r\n\r\n  // istanbul ignore next\r\n  private adjustWidowLocation(location: ChildWindowLocationProps, center?: boolean): ChildWindowLocationProps {\r\n    const outLocation = { ...location };\r\n    if (0 === location.top && 0 === location.left) {\r\n      center = center ?? true;\r\n      const windowTop = window.top ?? window;\r\n\r\n      // Prepare position of the new window to be centered against the 'parent' window.\r\n      if (center) {\r\n        outLocation.left =\r\n          windowTop.outerWidth / 2 + windowTop.screenX - location.width / 2;\r\n        outLocation.top =\r\n          windowTop.outerHeight / 2 + windowTop.screenY - location.height / 2;\r\n      } else {\r\n        if (undefined !== window.screenLeft && undefined !== window.screenTop) {\r\n          outLocation.top = window.screenTop + location.top;\r\n          outLocation.left = window.screenLeft + location.left;\r\n        }\r\n      }\r\n    }\r\n    return outLocation;\r\n  }\r\n\r\n  // istanbul ignore next\r\n  public openChildWindow(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean) {\r\n    // first check to see if content is already open in child window\r\n    if (this.openChildWindows.findIndex((openWindow) => openWindow.childWindowId === childWindowId) >= 0) {\r\n      return false;\r\n    }\r\n\r\n    location = this.adjustWidowLocation(location);\r\n    const url = useDefaultPopoutUrl ? \"/iTwinPopup.html\" : \"\";\r\n    const childWindow = window.open(url, \"\", `width=${location.width},height=${location.height},left=${location.left},top=${location.top},menubar=no,resizable=yes,scrollbars=no,status=no,location=no`);\r\n    if (!childWindow)\r\n      return false;\r\n    if (0 === url.length) {\r\n      childWindow.document.write(childHtml);\r\n      this.renderChildWindowContents(childWindow, childWindowId, content);\r\n    } else {\r\n      childWindow.addEventListener(\"load\", () => {\r\n        childWindow.document.title = title;\r\n        this.renderChildWindowContents(childWindow, childWindowId, content);\r\n      }, false);\r\n    }\r\n\r\n    window.addEventListener(\"beforeunload\", () => {\r\n      const frontStageDef = FrontstageManager.activeFrontstageDef;\r\n      if (frontStageDef) {\r\n        this.closeChildWindow(childWindowId, true);\r\n      }\r\n    }, false);\r\n\r\n    return true;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/childwindow/ChildWindowManager.scss

@@ -0,0 +1,14 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+.uifw-child-window-container-host {
+  height: 100%;
+  width: 100%;
+  position: relative;
+}
+
+.uifw-child-window-container {
+  height: 100%;
+  width: 100%;
+}