@itwin/appui-react 4.0.0-dev.8 → 4.0.0-dev.9

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

@@ -1 +1 @@
-{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,mBAAmB,EAAqB,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE9E;;GAEG;AACH,qBAAa,sBAAsB;IACjC,+CAA+C;IAC/C,OAAc,mBAAmB,iBAAkB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,4HAAsF,sBAAsB,CAU9N;IAEH,wCAAwC;IACxC,OAAc,gBAAgB,WAAY,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,yHAAmF,mBAAmB,CAUpO;IAEH;;OAEG;IACH,OAAc,8BAA8B,UAAW,kBAAkB,KAAG,kBAAkB,CAa5F;CACH"}
+{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IACtC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAW/N;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAWrO;CACF"}

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

@@ -5,51 +5,38 @@
 /** @packageDocumentation
  * @module Backstage
  */
-import { PropsHelper } from "../utils/PropsHelper";
-import { BackstageItemType } from "./BackstageItem";
 /** Utilities for creating and maintaining backstage items
  * @beta
  */
-export class BackstageItemUtilities {
-}
-/** Creates a stage launcher backstage item. */
-BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, iconSpec, overrides) => ({
-    groupPriority,
-    icon: iconSpec,
-    id: frontstageId,
-    itemPriority,
-    type: BackstageItemType.StageLauncher,
-    label,
-    stageId: frontstageId,
-    subtitle,
-    ...overrides,
-});
-/** Creates an action backstage item. */
-BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, iconSpec, overrides) => ({
-    execute,
-    groupPriority,
-    icon: iconSpec,
-    id: itemId,
-    itemPriority,
-    type: BackstageItemType.ActionItem,
-    label,
-    subtitle,
-    ...overrides,
-});
-/** Helper method to set backstage item state from props.
- * @deprecated in 3.6.
- */
-BackstageItemUtilities.getBackstageItemStateFromProps = (props) => {
-    const labelSpec = PropsHelper.getStringSpec(props.label, props.labelKey);
-    const subtitleSpec = PropsHelper.getStringSpec(props.description, props.descriptionKey);
-    const tooltipSpec = PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);
-    return {
-        isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */ false,
-        label: PropsHelper.getStringFromSpec(labelSpec),
-        subtitle: PropsHelper.getStringFromSpec(subtitleSpec),
-        tooltip: PropsHelper.getStringFromSpec(tooltipSpec),
-        iconSpec: props.iconSpec,
-        isActive: undefined !== props.isActive ? props.isActive : false,
-    };
-};
+export var BackstageItemUtilities;
+(function (BackstageItemUtilities) {
+    /** Creates a stage launcher backstage item. */
+    function createStageLauncher(frontstageId, groupPriority, itemPriority, label, subtitle, iconSpec, overrides) {
+        return {
+            groupPriority,
+            icon: iconSpec,
+            id: frontstageId,
+            itemPriority,
+            label,
+            stageId: frontstageId,
+            subtitle,
+            ...overrides,
+        };
+    }
+    BackstageItemUtilities.createStageLauncher = createStageLauncher;
+    /** Creates an action backstage item. */
+    function createActionItem(itemId, groupPriority, itemPriority, execute, label, subtitle, iconSpec, overrides) {
+        return {
+            execute,
+            groupPriority,
+            icon: iconSpec,
+            id: itemId,
+            itemPriority,
+            label,
+            subtitle,
+            ...overrides,
+        };
+    }
+    BackstageItemUtilities.createActionItem = createActionItem;
+})(BackstageItemUtilities || (BackstageItemUtilities = {}));
 //# sourceMappingURL=BackstageItemUtilities.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAuB,iBAAiB,EAA0B,MAAM,iBAAiB,CAAC;AAGjG;;GAEG;AACH,MAAM,OAAO,sBAAsB;;AACjC,+CAA+C;AACjC,0CAAmB,GAAG,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAA2C,EAA0B,EAAE,CAAC,CAAC;IACpO,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,IAAI,EAAE,iBAAiB,CAAC,aAAa;IACrC,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,wCAAwC;AAC1B,uCAAgB,GAAG,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAwC,EAAuB,EAAE,CAAC,CAAC;IAC1O,OAAO;IACP,aAAa;IACb,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,IAAI,EAAE,iBAAiB,CAAC,UAAU;IAClC,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH;;GAEG;AACW,qDAA8B,GAAG,CAAC,KAAyB,EAAsB,EAAE;IAC/F,MAAM,SAAS,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzE,MAAM,YAAY,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IACxF,MAAM,WAAW,GAAG,WAAW,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAE/E,OAAO;QACL,SAAS,EAAE,SAAS,KAAK,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,0BAA0B,CAAA,KAAK;QAC5F,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAC/C,QAAQ,EAAE,WAAW,CAAC,iBAAiB,CAAC,YAAY,CAAC;QACrD,OAAO,EAAE,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC;QACnD,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,QAAQ,EAAE,SAAS,KAAK,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK;KAChE,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { PropsHelper } from \"../utils/PropsHelper\";\r\nimport { BackstageActionItem, BackstageItemType, BackstageStageLauncher } from \"./BackstageItem\";\r\nimport { BackstageItemProps, BackstageItemState } from \"./BackstageItemProps\";\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item. */\r\n  public static createStageLauncher = (frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher => ({\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: frontstageId,\r\n    itemPriority,\r\n    type: BackstageItemType.StageLauncher, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    stageId: frontstageId,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Creates an action backstage item. */\r\n  public static createActionItem = (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem => ({\r\n    execute,\r\n    groupPriority,\r\n    icon: iconSpec,\r\n    id: itemId,\r\n    itemPriority,\r\n    type: BackstageItemType.ActionItem, // eslint-disable-line deprecation/deprecation\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n\r\n  /** Helper method to set backstage item state from props.\r\n   * @deprecated in 3.6.\r\n   */\r\n  public static getBackstageItemStateFromProps = (props: BackstageItemProps): BackstageItemState => { // eslint-disable-line deprecation/deprecation\r\n    const labelSpec = PropsHelper.getStringSpec(props.label, props.labelKey);\r\n    const subtitleSpec = PropsHelper.getStringSpec(props.description, props.descriptionKey);\r\n    const tooltipSpec = PropsHelper.getStringSpec(props.tooltip, props.tooltipKey);\r\n\r\n    return {\r\n      isEnabled: undefined !== props.isEnabled ? props.isEnabled : /* istanbul ignore next */false,\r\n      label: PropsHelper.getStringFromSpec(labelSpec),\r\n      subtitle: PropsHelper.getStringFromSpec(subtitleSpec),\r\n      tooltip: PropsHelper.getStringFromSpec(tooltipSpec),\r\n      iconSpec: props.iconSpec,\r\n      isActive: undefined !== props.isActive ? props.isActive : false,\r\n    };\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;GAEG;AACH,MAAM,KAAW,sBAAsB,CA4BtC;AA5BD,WAAiB,sBAAsB;IACrC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAA2C;QACrM,OAAO;YACL,aAAa;YACb,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,YAAY;YAChB,YAAY;YACZ,KAAK;YACL,OAAO,EAAE,YAAY;YACrB,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,0CAAmB,sBAWlC,CAAA;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAwC;QAC9M,OAAO;YACL,OAAO;YACP,aAAa;YACb,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,MAAM;YACV,YAAY;YACZ,KAAK;YACL,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,uCAAgB,mBAW/B,CAAA;AACH,CAAC,EA5BgB,sBAAsB,KAAtB,sBAAsB,QA4BtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { BackstageActionItem, BackstageStageLauncher } from \"./BackstageItem\";\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta\r\n */\r\nexport namespace BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item. */\r\n  export function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher {\r\n    return {\r\n      groupPriority,\r\n      icon: iconSpec,\r\n      id: frontstageId,\r\n      itemPriority,\r\n      label,\r\n      stageId: frontstageId,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n\r\n  /** Creates an action backstage item. */\r\n  export function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem {\r\n    return {\r\n      execute,\r\n      groupPriority,\r\n      icon: iconSpec,\r\n      id: itemId,\r\n      itemPriority,\r\n      label,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n}\r\n"]}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"BackstageManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,OAAO,CAAS;IAExB,uDAAuD;IACvD,SAAgB,SAAS,iBAAsB,oBAAoB,KAAK,IAAI,EAAI;IAEhF,IAAW,MAAM,YAEhB;IAED,OAAO,CAAC,SAAS;IAUV,IAAI;IAIJ,KAAK;IAIL,MAAM;IAIb,mGAAmG;WACrF,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;CAUpE;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,gBAAgB,YAa3D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,wBAG/B,CAAC"}
+{"version":3,"file":"BackstageManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageManager.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAkC;IAElD;;;OAGG;IACI,YAAY,CAAC,QAAQ,EAAE,wBAAwB;IAItD,uDAAuD;IACvD,IAAW,SAAS,gFAAsC;IAE1D,IAAW,MAAM,YAEhB;IAEM,IAAI;IAIJ,KAAK;IAIL,MAAM;IAIN,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;IAI5D;MACE;WACY,yBAAyB,CAAC,gBAAgB,CAAC,EAAE,QAAQ;CAGpE;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,kBAAkB,YAa7D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,0BAG/B,CAAC"}

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

@@ -6,50 +6,43 @@
  * @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();
     }
-    get isOpen() {
-        return this._isOpen;
+    /**
+     * Override internal implementation for a mock
+     * @internal For tests only.
+     */
+    mockInternal(internal) {
+        this.internal = internal;
     }
-    setIsOpen(isOpen) {
-        if (isOpen === this._isOpen)
-            return;
-        this._isOpen = isOpen;
-        this.onToggled.raiseEvent({
-            isOpen,
-        });
-        Backstage.onBackstageEvent.emit({ isVisible: isOpen }); // eslint-disable-line deprecation/deprecation
+    /** Event raised when backstage is opened or closed. */
+    get onToggled() { return this.internal.onToggled; }
+    get isOpen() {
+        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 +66,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;IAsCpD,CAAC;IApCC;;;OAGG;IACI,YAAY,CAAC,QAAkC;QACpD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED,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  /**\r\n   * Override internal implementation for a mock\r\n   * @internal For tests only.\r\n   */\r\n  public mockInternal(internal: InternalBackstageManager) {\r\n    this.internal = internal;\r\n  }\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/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;AAE1D,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;IASV,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,52 @@
+/*---------------------------------------------------------------------------------------------
+* 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";
+/** 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,
+        });
+    }
+    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;AAG7C;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAArC;QACU,YAAO,GAAG,KAAK,CAAC;QAExB,uDAAuD;QACvC,cAAS,GAAG,IAAI,OAAO,EAAwC,CAAC;IAsClF,CAAC;IApCC,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;IACL,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 { 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  }\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/useUiItemsProviderBackstageItems.d.ts

@@ -1,7 +1,8 @@
 /** @packageDocumentation
  * @module StatusBar
  */
-import { BackstageItem, BackstageItemsManager } from "@itwin/appui-abstract";
+import { BackstageItemsManager } from "@itwin/appui-abstract";
+import { BackstageItem } from "./BackstageItem";
 /** Hook that returns items from [[BackstageItemsManager]].
  * @public
  */

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

@@ -1 +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"}
+{"version":3,"file":"useUiItemsProviderBackstageItems.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useUiItemsProviderBackstageItems.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAA6B,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAEzF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD;;GAEG;AACH,eAAO,MAAM,gCAAgC,YAAa,qBAAqB,KAAG,SAAS,aAAa,EA2BvG,CAAC"}

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

@@ -2,14 +2,12 @@
 * 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
+import { UiItemsManager } from "../ui-items-provider/UiItemsManager";
 /** Hook that returns items from [[BackstageItemsManager]].
  * @public
  */
@@ -29,7 +27,7 @@ export const useUiItemsProviderBackstageItems = (manager) => {
             setItems(manager.items);
         }
     }, [manager, uiItemProviderIds]);
-    // handle item changes caused by calls to UiFramework.addonStatusBarItemsManager.setxxx
+    // handle item changes caused by calls to UiFramework.backstageManager
     React.useEffect(() => {
         const handleChanged = (args) => {
             setItems(args.items);

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

@@ -1 +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"]}
+{"version":3,"file":"useUiItemsProviderBackstageItems.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/useUiItemsProviderBackstageItems.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAErF,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAErE;;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,sEAAsE;IACtE,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 StatusBar\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { BackstageItemsChangedArgs, BackstageItemsManager } from \"@itwin/appui-abstract\";\r\nimport { useAvailableUiItemsProviders } from \"../hooks/useAvailableUiItemsProviders\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\nimport { UiItemsManager } from \"../ui-items-provider/UiItemsManager\";\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.backstageManager\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

@@ -1,35 +1,74 @@
 /** @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;
-}
+import { ChildWindowLocationProps, OpenChildWindowInfo } from "../framework/FrameworkChildWindows";
+import { CreateRoot, InternalChildWindowManager } from "./InternalChildWindowManager";
 /** 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/appui-react/ChildWindows.md)
- * @public */
+ * @public
+ * @deprecated in 3.7. Use `UiFramework.childWindows` property to access.
+ * */
 export declare class ChildWindowManager {
-    private _openChildWindows;
+    private internal;
+    /**
+     * Override internal implementation for a mock
+     * @internal For tests only.
+     */
+    mockInternal(internal: InternalChildWindowManager): void;
     get openChildWindows(): OpenChildWindowInfo[];
+    /**
+     * @deprecated in 3.7. Use `find` method.
+     */
     findChildWindow(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
+    /**
+     * @deprecated in 3.7. Use `findId` method.
+     */
     findChildWindowId(contentWindow: Window | undefined | null): string | undefined;
-    private renderChildWindowContents;
-    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed.
+     * @deprecated in 3.7. Use `closeAll` method.
+     */
     closeAllChildWindows(): void;
+    /**
+     * @deprecated in 3.7. Use `close` method.
+     */
     closeChildWindow: (childWindowId: string, processWindowClose?: boolean) => boolean;
-    private adjustWidowLocation;
+    /**
+     * @deprecated in 3.7. Use `open` method.
+     */
     openChildWindow(childWindowId: string, title: string, content: React.ReactNode, location: ChildWindowLocationProps, useDefaultPopoutUrl?: boolean): boolean;
+    useCreateRoot(createRootFn: CreateRoot): void;
+    /**
+     * Returns the OpenChildWindowInfo for the related id.
+     * @param childWindowId Id of the window to retrieve.
+     * @returns undefined if not found.
+     */
+    find(childWindowId: string | undefined): OpenChildWindowInfo | undefined;
+    /**
+       * Return the childWindowId of the provided window.
+       * @param contentWindow Window element to identify
+       * @returns undefined if not found
+       */
+    findId(contentWindow: Window | undefined | null): string | undefined;
+    /** Close all child/pop-out windows. This typically is called when the frontstage is changed. */
+    closeAll(): void;
+    /**
+       * Close a specific child window.
+       * @param childWindowId Id of the window to close
+       * @param processWindowClose should the `close` method be called on the closing window. (defaults to true)
+       * @returns false if the window could not be found.
+       */
+    close: (childWindowId: string, processWindowClose?: boolean) => boolean;
+    /**
+       * Open a new child window.
+       * @param childWindowId Id to assign to the newly created window.
+       * @param title Title to display on the window.
+       * @param content ReactNode to be rendered in the window.
+       * @param location Position and size information
+       * @param useDefaultPopoutUrl use "/iTwinPopup.html" as the window Url, "" otherwise.
+       * @returns true if the window is opened successfully.
+       */
+    open(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

@@ -1 +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;AAqC/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;IA8CjC,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"}
+{"version":3,"file":"ChildWindowManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/childwindow/ChildWindowManager.tsx"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,oCAAoC,CAAC;AACnG,OAAO,EAAE,UAAU,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAEtF;;;;;KAKK;AACL,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAoC;IAEpD;;;OAGG;IACI,YAAY,CAAC,QAAQ,EAAE,0BAA0B;IAIxD,IAAW,gBAAgB,0BAE1B;IAED;;OAEG;IACI,eAAe,CACpB,aAAa,EAAE,MAAM,GAAG,SAAS,GAChC,mBAAmB,GAAG,SAAS;IAIlC;;OAEG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GACvC,MAAM,GAAG,SAAS;IAIrB;;OAEG;IACI,oBAAoB;IAI3B;;OAEG;IACI,gBAAgB,kBACN,MAAM,2CAIrB;IAEF;;OAEG;IAEI,eAAe,CACpB,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,KAAK,CAAC,SAAS,EACxB,QAAQ,EAAE,wBAAwB,EAClC,mBAAmB,CAAC,EAAE,OAAO;IAWxB,aAAa,CAAC,YAAY,EAAE,UAAU;IAI7C;;;;OAIG;IACI,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,mBAAmB,GAAG,SAAS;IAI/E;;;;SAIK;IACE,MAAM,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS;IAI3E,gGAAgG;IACzF,QAAQ;IAIf;;;;;SAKK;IACE,KAAK,kBAAmB,MAAM,2CAEnC;IAEF;;;;;;;;SAQK;IAEE,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,EAAE,QAAQ,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,OAAO;CAG9I"}