@itwin/appui-react 4.0.0-dev.11 → 4.0.0-dev.13

package/lib/esm/appui-react/frontstage/StandardFrontstageProvider.js

@@ -1,75 +1,74 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Frontstage
- */
-import * as React from "react";
-import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
-import { FrontstageProvider } from "./FrontstageProvider";
-import { ContentToolWidgetComposer } from "../widgets/ContentToolWidgetComposer";
-import { ViewToolWidgetComposer } from "../widgets/ViewToolWidgetComposer";
-import { StagePanelState } from "../stagepanels/StagePanelDef";
-import { StatusBarComposer } from "../statusbar/StatusBarComposer";
-/**
- * FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
- * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).
- * @public
- */
-export class StandardFrontstageProvider extends FrontstageProvider {
-    constructor(props) {
-        super();
-        this.props = props;
-    }
-    get id() {
-        return this.props.id;
-    }
-    frontstageConfig() {
-        var _a;
-        const contentGroup = (this.props.contentGroupProps instanceof ContentGroupProvider) ? this.props.contentGroupProps : new ContentGroup(this.props.contentGroupProps);
-        return {
-            id: this.props.id,
-            version: (_a = this.props.version) !== null && _a !== void 0 ? _a : 1.0,
-            contentGroup,
-            usage: this.props.usage,
-            contentManipulation: {
-                id: `${this.props.id}-contentManipulationTools`,
-                content: React.createElement(ContentToolWidgetComposer, { cornerButton: this.props.cornerButton }),
-            },
-            viewNavigation: {
-                id: `${this.props.id}-viewNavigationTools`,
-                content: React.createElement(ViewToolWidgetComposer, { hideNavigationAid: this.props.hideNavigationAid }),
-            },
-            toolSettings: this.props.hideToolSettings ? undefined : {
-                id: `${this.props.id}-toolSettings`,
-            },
-            statusBar: this.props.hideStatusBar ? undefined : {
-                id: `${this.props.id}-statusBar`,
-                content: React.createElement(StatusBarComposer, { items: [] }),
-            },
-            leftPanel: {
-                size: 300,
-                pinned: false,
-                defaultState: StagePanelState.Minimized,
-                ...this.props.leftPanelProps,
-            },
-            topPanel: {
-                size: 90,
-                pinned: false,
-                defaultState: StagePanelState.Minimized,
-                ...this.props.topPanelProps,
-            },
-            rightPanel: {
-                defaultState: StagePanelState.Open,
-                ...this.props.rightPanelProps,
-            },
-            bottomPanel: {
-                size: 180,
-                defaultState: StagePanelState.Open,
-                ...this.props.bottomPanelProps,
-            },
-        };
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Frontstage
+ */
+import * as React from "react";
+import { ContentGroup, ContentGroupProvider } from "../content/ContentGroup";
+import { FrontstageProvider } from "./FrontstageProvider";
+import { ContentToolWidgetComposer } from "../widgets/ContentToolWidgetComposer";
+import { ViewToolWidgetComposer } from "../widgets/ViewToolWidgetComposer";
+import { StagePanelState } from "../stagepanels/StagePanelDef";
+import { StatusBarComposer } from "../statusbar/StatusBarComposer";
+/**
+ * FrontstageProvider that provides an "empty" stage. All tool buttons, statusbar items, and widgets must
+ * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).
+ * @public
+ */
+export class StandardFrontstageProvider extends FrontstageProvider {
+    constructor(props) {
+        super();
+        this.props = props;
+    }
+    get id() {
+        return this.props.id;
+    }
+    frontstageConfig() {
+        const contentGroup = (this.props.contentGroupProps instanceof ContentGroupProvider) ? this.props.contentGroupProps : new ContentGroup(this.props.contentGroupProps);
+        return {
+            id: this.props.id,
+            version: this.props.version ?? 1.0,
+            contentGroup,
+            usage: this.props.usage,
+            contentManipulation: {
+                id: `${this.props.id}-contentManipulationTools`,
+                content: React.createElement(ContentToolWidgetComposer, { cornerButton: this.props.cornerButton }),
+            },
+            viewNavigation: {
+                id: `${this.props.id}-viewNavigationTools`,
+                content: React.createElement(ViewToolWidgetComposer, { hideNavigationAid: this.props.hideNavigationAid }),
+            },
+            toolSettings: this.props.hideToolSettings ? undefined : {
+                id: `${this.props.id}-toolSettings`,
+            },
+            statusBar: this.props.hideStatusBar ? undefined : {
+                id: `${this.props.id}-statusBar`,
+                content: React.createElement(StatusBarComposer, { items: [] }),
+            },
+            leftPanel: {
+                size: 300,
+                pinned: false,
+                defaultState: StagePanelState.Minimized,
+                ...this.props.leftPanelProps,
+            },
+            topPanel: {
+                size: 90,
+                pinned: false,
+                defaultState: StagePanelState.Minimized,
+                ...this.props.topPanelProps,
+            },
+            rightPanel: {
+                defaultState: StagePanelState.Open,
+                ...this.props.rightPanelProps,
+            },
+            bottomPanel: {
+                size: 180,
+                defaultState: StagePanelState.Open,
+                ...this.props.bottomPanelProps,
+            },
+        };
+    }
+}
 //# sourceMappingURL=StandardFrontstageProvider.js.map

package/lib/esm/appui-react/frontstage/StandardFrontstageProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"StandardFrontstageProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StandardFrontstageProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAqB,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAI/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAoDnE;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;IAChE,YAAoB,KAA8B;QAChD,KAAK,EAAE,CAAC;QADU,UAAK,GAAL,KAAK,CAAyB;IAElD,CAAC;IAED,IAAoB,EAAE;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACvB,CAAC;IAEe,gBAAgB;;QAC9B,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,YAAY,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpK,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;YACjB,OAAO,EAAE,MAAA,IAAI,CAAC,KAAK,CAAC,OAAO,mCAAI,GAAG;YAClC,YAAY;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,mBAAmB,EAAE;gBACnB,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,2BAA2B;gBAC/C,OAAO,EAAE,oBAAC,yBAAyB,IAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAI;aAC9E;YACD,cAAc,EAAE;gBACd,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,sBAAsB;gBAC1C,OAAO,EAAE,oBAAC,sBAAsB,IAAC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAI;aACrF;YACD,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;gBACtD,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe;aACpC;YACD,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;gBAChD,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY;gBAChC,OAAO,EAAE,oBAAC,iBAAiB,IAAC,KAAK,EAAE,EAAE,GAAI;aAC1C;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc;aAC7B;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE;gBACR,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa;aAC5B;YACD,UAAU,EAAE;gBACV,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe;aAC9B;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB;aAC/B;SACF,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 Frontstage\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { ContentGroup, ContentGroupProps, ContentGroupProvider } from \"../content/ContentGroup\";\r\nimport { FrontstageProvider } from \"./FrontstageProvider\";\r\nimport { ContentToolWidgetComposer } from \"../widgets/ContentToolWidgetComposer\";\r\nimport { ViewToolWidgetComposer } from \"../widgets/ViewToolWidgetComposer\";\r\nimport { StagePanelState } from \"../stagepanels/StagePanelDef\";\r\nimport { FrontstageConfig } from \"./FrontstageConfig\";\r\nimport { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\r\nimport { StageUsage } from \"./StageUsage\";\r\nimport { StatusBarComposer } from \"../statusbar/StatusBarComposer\";\r\n\r\n/** Properties of a [[WidgetPanelProps]] component\r\n * @public\r\n */\r\nexport type WidgetPanelProps = Omit<StagePanelConfig, \"widgets\" | \"runtimeProps\" | \"header\" | \"allowedZones\" | \"panelZones\">;\r\n\r\n/**\r\n * Props for [[StandardFrontstageProvider]]\r\n * @public\r\n */\r\nexport interface StandardFrontstageProps {\r\n  /* unique stage id. To ensure uniqueness it is common practice to format id like `appName:stageId` */\r\n  id: string;\r\n  /* version id that is used to store state of stage */\r\n  version?: number;\r\n  // Usage of stage. To allow generic UiItemProvides to populate this stage set to `StageUsage.General`.\r\n  usage: StageUsage | string;\r\n  /** Definition of available content groups or a function that provides them */\r\n  contentGroupProps: ContentGroupProps | ContentGroupProvider;\r\n  /** Specify button to use to open backstage. Leave undefined for no backstage button.\r\n   * ```\r\n   * <BackstageAppButton icon={<SvgBentleySystems />} />\r\n   * ```\r\n   * Custom corner button definition\r\n   * ```\r\n   * const cornerButton = <BackstageAppButton icon={<SvgBentleySystems />}\r\n   *   label=\"Toggle Backstage display\",\r\n   *   execute={() => UiFramework.backstage.getBackstageToggleCommand().execute()} />;\r\n   * ```\r\n   */\r\n  cornerButton?: React.ReactNode;\r\n  /** Set to true if default Navigation aid is not desired */\r\n  hideNavigationAid?: boolean;\r\n  /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */\r\n  hideToolSettings?: boolean;\r\n  /** Set to true if no status bar is needed in stage */\r\n  hideStatusBar?: boolean;\r\n  /** Props used to set initial size and state of panel. Defaults to:\r\n   *  {size: 300, pinned=false, defaultState:StagePanelState.Minimized} */\r\n  leftPanelProps?: WidgetPanelProps;\r\n  /** Props used to set initial size and state of panel. Defaults to:\r\n   *  {size: 90, pinned=false, defaultState:StagePanelState.Minimized} */\r\n  topPanelProps?: WidgetPanelProps;\r\n  /** Props used to set initial size and state of panel. Defaults to:\r\n   *  {size: 200, pinned=true, defaultState:StagePanelState.Open} */\r\n  rightPanelProps?: WidgetPanelProps;\r\n  /** Props used to set initial size and state of panel. Defaults to:\r\n   *  {size: 180, pinned=true, defaultState:StagePanelState.Open} */\r\n  bottomPanelProps?: WidgetPanelProps;\r\n}\r\n\r\n/**\r\n * FrontstageProvider that provides an \"empty\" stage. All tool buttons, statusbar items, and widgets must\r\n * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).\r\n * @public\r\n */\r\nexport class StandardFrontstageProvider extends FrontstageProvider {\r\n  constructor(private props: StandardFrontstageProps) {\r\n    super();\r\n  }\r\n\r\n  public override get id(): string {\r\n    return this.props.id;\r\n  }\r\n\r\n  public override frontstageConfig(): FrontstageConfig {\r\n    const contentGroup = (this.props.contentGroupProps instanceof ContentGroupProvider) ? this.props.contentGroupProps : new ContentGroup(this.props.contentGroupProps);\r\n    return {\r\n      id: this.props.id,\r\n      version: this.props.version ?? 1.0,\r\n      contentGroup,\r\n      usage: this.props.usage,\r\n      contentManipulation: {\r\n        id: `${this.props.id}-contentManipulationTools`,\r\n        content: <ContentToolWidgetComposer cornerButton={this.props.cornerButton} />,\r\n      },\r\n      viewNavigation: {\r\n        id: `${this.props.id}-viewNavigationTools`,\r\n        content: <ViewToolWidgetComposer hideNavigationAid={this.props.hideNavigationAid} />,\r\n      },\r\n      toolSettings: this.props.hideToolSettings ? undefined : {\r\n        id: `${this.props.id}-toolSettings`,\r\n      },\r\n      statusBar: this.props.hideStatusBar ? undefined : {\r\n        id: `${this.props.id}-statusBar`,\r\n        content: <StatusBarComposer items={[]} />,\r\n      },\r\n      leftPanel: {\r\n        size: 300,\r\n        pinned: false,\r\n        defaultState: StagePanelState.Minimized,\r\n        ...this.props.leftPanelProps,\r\n      },\r\n      topPanel: {\r\n        size: 90,\r\n        pinned: false,\r\n        defaultState: StagePanelState.Minimized,\r\n        ...this.props.topPanelProps,\r\n      },\r\n      rightPanel: {\r\n        defaultState: StagePanelState.Open,\r\n        ...this.props.rightPanelProps,\r\n      },\r\n      bottomPanel: {\r\n        size: 180,\r\n        defaultState: StagePanelState.Open,\r\n        ...this.props.bottomPanelProps,\r\n      },\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StandardFrontstageProvider.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/StandardFrontstageProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAqB,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAChG,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAI/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAoDnE;;;;GAIG;AACH,MAAM,OAAO,0BAA2B,SAAQ,kBAAkB;IAChE,YAAoB,KAA8B;QAChD,KAAK,EAAE,CAAC;QADU,UAAK,GAAL,KAAK,CAAyB;IAElD,CAAC;IAED,IAAoB,EAAE;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;IACvB,CAAC;IAEe,gBAAgB;QAC9B,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,YAAY,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpK,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;YACjB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,GAAG;YAClC,YAAY;YACZ,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,mBAAmB,EAAE;gBACnB,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,2BAA2B;gBAC/C,OAAO,EAAE,oBAAC,yBAAyB,IAAC,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAI;aAC9E;YACD,cAAc,EAAE;gBACd,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,sBAAsB;gBAC1C,OAAO,EAAE,oBAAC,sBAAsB,IAAC,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,GAAI;aACrF;YACD,YAAY,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;gBACtD,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,eAAe;aACpC;YACD,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;gBAChD,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY;gBAChC,OAAO,EAAE,oBAAC,iBAAiB,IAAC,KAAK,EAAE,EAAE,GAAI;aAC1C;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc;aAC7B;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE;gBACR,MAAM,EAAE,KAAK;gBACb,YAAY,EAAE,eAAe,CAAC,SAAS;gBACvC,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa;aAC5B;YACD,UAAU,EAAE;gBACV,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe;aAC9B;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,GAAG;gBACT,YAAY,EAAE,eAAe,CAAC,IAAI;gBAClC,GAAG,IAAI,CAAC,KAAK,CAAC,gBAAgB;aAC/B;SACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Frontstage\n */\n\nimport * as React from \"react\";\nimport { ContentGroup, ContentGroupProps, ContentGroupProvider } from \"../content/ContentGroup\";\nimport { FrontstageProvider } from \"./FrontstageProvider\";\nimport { ContentToolWidgetComposer } from \"../widgets/ContentToolWidgetComposer\";\nimport { ViewToolWidgetComposer } from \"../widgets/ViewToolWidgetComposer\";\nimport { StagePanelState } from \"../stagepanels/StagePanelDef\";\nimport { FrontstageConfig } from \"./FrontstageConfig\";\nimport { StagePanelConfig } from \"../stagepanels/StagePanelConfig\";\nimport { StageUsage } from \"./StageUsage\";\nimport { StatusBarComposer } from \"../statusbar/StatusBarComposer\";\n\n/** Properties of a [[WidgetPanelProps]] component\n * @public\n */\nexport type WidgetPanelProps = Omit<StagePanelConfig, \"widgets\" | \"runtimeProps\" | \"header\" | \"allowedZones\" | \"panelZones\">;\n\n/**\n * Props for [[StandardFrontstageProvider]]\n * @public\n */\nexport interface StandardFrontstageProps {\n  /* unique stage id. To ensure uniqueness it is common practice to format id like `appName:stageId` */\n  id: string;\n  /* version id that is used to store state of stage */\n  version?: number;\n  // Usage of stage. To allow generic UiItemProvides to populate this stage set to `StageUsage.General`.\n  usage: StageUsage | string;\n  /** Definition of available content groups or a function that provides them */\n  contentGroupProps: ContentGroupProps | ContentGroupProvider;\n  /** Specify button to use to open backstage. Leave undefined for no backstage button.\n   * ```\n   * <BackstageAppButton icon={<SvgBentleySystems />} />\n   * ```\n   * Custom corner button definition\n   * ```\n   * const cornerButton = <BackstageAppButton icon={<SvgBentleySystems />}\n   *   label=\"Toggle Backstage display\",\n   *   execute={() => UiFramework.backstage.getBackstageToggleCommand().execute()} />;\n   * ```\n   */\n  cornerButton?: React.ReactNode;\n  /** Set to true if default Navigation aid is not desired */\n  hideNavigationAid?: boolean;\n  /** Set to true if no tool setting dock is needed. Typically only used in modal stages. */\n  hideToolSettings?: boolean;\n  /** Set to true if no status bar is needed in stage */\n  hideStatusBar?: boolean;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {size: 300, pinned=false, defaultState:StagePanelState.Minimized} */\n  leftPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {size: 90, pinned=false, defaultState:StagePanelState.Minimized} */\n  topPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {size: 200, pinned=true, defaultState:StagePanelState.Open} */\n  rightPanelProps?: WidgetPanelProps;\n  /** Props used to set initial size and state of panel. Defaults to:\n   *  {size: 180, pinned=true, defaultState:StagePanelState.Open} */\n  bottomPanelProps?: WidgetPanelProps;\n}\n\n/**\n * FrontstageProvider that provides an \"empty\" stage. All tool buttons, statusbar items, and widgets must\n * be provided by one or more item providers, see [UiItemsProvider]($appui-abstract).\n * @public\n */\nexport class StandardFrontstageProvider extends FrontstageProvider {\n  constructor(private props: StandardFrontstageProps) {\n    super();\n  }\n\n  public override get id(): string {\n    return this.props.id;\n  }\n\n  public override frontstageConfig(): FrontstageConfig {\n    const contentGroup = (this.props.contentGroupProps instanceof ContentGroupProvider) ? this.props.contentGroupProps : new ContentGroup(this.props.contentGroupProps);\n    return {\n      id: this.props.id,\n      version: this.props.version ?? 1.0,\n      contentGroup,\n      usage: this.props.usage,\n      contentManipulation: {\n        id: `${this.props.id}-contentManipulationTools`,\n        content: <ContentToolWidgetComposer cornerButton={this.props.cornerButton} />,\n      },\n      viewNavigation: {\n        id: `${this.props.id}-viewNavigationTools`,\n        content: <ViewToolWidgetComposer hideNavigationAid={this.props.hideNavigationAid} />,\n      },\n      toolSettings: this.props.hideToolSettings ? undefined : {\n        id: `${this.props.id}-toolSettings`,\n      },\n      statusBar: this.props.hideStatusBar ? undefined : {\n        id: `${this.props.id}-statusBar`,\n        content: <StatusBarComposer items={[]} />,\n      },\n      leftPanel: {\n        size: 300,\n        pinned: false,\n        defaultState: StagePanelState.Minimized,\n        ...this.props.leftPanelProps,\n      },\n      topPanel: {\n        size: 90,\n        pinned: false,\n        defaultState: StagePanelState.Minimized,\n        ...this.props.topPanelProps,\n      },\n      rightPanel: {\n        defaultState: StagePanelState.Open,\n        ...this.props.rightPanelProps,\n      },\n      bottomPanel: {\n        size: 180,\n        defaultState: StagePanelState.Open,\n        ...this.props.bottomPanelProps,\n      },\n    };\n  }\n}\n"]}

package/lib/esm/appui-react/hooks/useActiveIModelConnection.d.ts

@@ -1,11 +1,11 @@
-/** @packageDocumentation
- * @module Hooks
- */
-import { IModelConnection } from "@itwin/core-frontend";
-/** React hook that maintains the active IModelConnection. For this hook to work properly the
- * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires
- * that the host app includes the UiFramework reducer into its Redux store.
- * @public
- */
-export declare function useActiveIModelConnection(): IModelConnection | undefined;
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { IModelConnection } from "@itwin/core-frontend";
+/** React hook that maintains the active IModelConnection. For this hook to work properly the
+ * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires
+ * that the host app includes the UiFramework reducer into its Redux store.
+ * @public
+ */
+export declare function useActiveIModelConnection(): IModelConnection | undefined;
 //# sourceMappingURL=useActiveIModelConnection.d.ts.map

package/lib/esm/appui-react/hooks/useActiveIModelConnection.js

@@ -1,34 +1,34 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hooks
- */
-import { useEffect, useState } from "react";
-import { SessionStateActionId } from "../redux/SessionState";
-import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
-import { UiFramework } from "../UiFramework";
-/** React hook that maintains the active IModelConnection. For this hook to work properly the
- * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires
- * that the host app includes the UiFramework reducer into its Redux store.
- * @public
- */
-export function useActiveIModelConnection() {
-    const [activeConnection, setActiveConnection] = useState(UiFramework.getIModelConnection());
-    useEffect(() => {
-        const handleSyncUiEvent = (args) => {
-            const eventIds = [SessionStateActionId.SetIModelConnection];
-            // istanbul ignore else
-            if (eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
-                setActiveConnection(UiFramework.getIModelConnection());
-            }
-        };
-        SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
-        return () => {
-            SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);
-        };
-    }, [activeConnection]);
-    return activeConnection;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useEffect, useState } from "react";
+import { SessionStateActionId } from "../redux/SessionState";
+import { SyncUiEventDispatcher } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+/** React hook that maintains the active IModelConnection. For this hook to work properly the
+ * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires
+ * that the host app includes the UiFramework reducer into its Redux store.
+ * @public
+ */
+export function useActiveIModelConnection() {
+    const [activeConnection, setActiveConnection] = useState(UiFramework.getIModelConnection());
+    useEffect(() => {
+        const handleSyncUiEvent = (args) => {
+            const eventIds = [SessionStateActionId.SetIModelConnection];
+            // istanbul ignore else
+            if (eventIds.some((value) => args.eventIds.has(value.toLowerCase()))) {
+                setActiveConnection(UiFramework.getIModelConnection());
+            }
+        };
+        SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
+        return () => {
+            SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);
+        };
+    }, [activeConnection]);
+    return activeConnection;
+}
 //# sourceMappingURL=useActiveIModelConnection.js.map

package/lib/esm/appui-react/hooks/useActiveIModelConnection.js.map

@@ -1 +1 @@
-{"version":3,"file":"useActiveIModelConnection.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC5F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,MAAM,QAAQ,GAAG,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC5D,uBAAuB;YACvB,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBACrF,mBAAmB,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;aACxD;QACH,CAAC,CAAC;QAEF,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnE,OAAO,GAAG,EAAE;YACV,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,OAAO,gBAAgB,CAAC;AAC1B,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 Hooks\r\n */\r\n\r\nimport { useEffect, useState } from \"react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { SessionStateActionId } from \"../redux/SessionState\";\r\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** React hook that maintains the active IModelConnection. For this hook to work properly the\r\n * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires\r\n * that the host app includes the UiFramework reducer into its Redux store.\r\n * @public\r\n */\r\nexport function useActiveIModelConnection(): IModelConnection | undefined {\r\n  const [activeConnection, setActiveConnection] = useState(UiFramework.getIModelConnection());\r\n  useEffect(() => {\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\r\n      const eventIds = [SessionStateActionId.SetIModelConnection];\r\n      // istanbul ignore else\r\n      if (eventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\r\n        setActiveConnection(UiFramework.getIModelConnection());\r\n      }\r\n    };\r\n\r\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n    return () => {\r\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);\r\n    };\r\n  }, [activeConnection]);\r\n\r\n  return activeConnection;\r\n}\r\n"]}
+{"version":3,"file":"useActiveIModelConnection.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveIModelConnection.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAG5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;GAIG;AACH,MAAM,UAAU,yBAAyB;IACvC,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;IAC5F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,MAAM,QAAQ,GAAG,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC5D,uBAAuB;YACvB,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE;gBACrF,mBAAmB,CAAC,WAAW,CAAC,mBAAmB,EAAE,CAAC,CAAC;aACxD;QACH,CAAC,CAAC;QAEF,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;QACnE,OAAO,GAAG,EAAE;YACV,qBAAqB,CAAC,aAAa,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QACxE,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAEvB,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { SessionStateActionId } from \"../redux/SessionState\";\nimport { SyncUiEventDispatcher } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** React hook that maintains the active IModelConnection. For this hook to work properly the\n * IModelConnection must be set using UiFramework.setIModelConnection method. This also requires\n * that the host app includes the UiFramework reducer into its Redux store.\n * @public\n */\nexport function useActiveIModelConnection(): IModelConnection | undefined {\n  const [activeConnection, setActiveConnection] = useState(UiFramework.getIModelConnection());\n  useEffect(() => {\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      const eventIds = [SessionStateActionId.SetIModelConnection];\n      // istanbul ignore else\n      if (eventIds.some((value: string): boolean => args.eventIds.has(value.toLowerCase()))) {\n        setActiveConnection(UiFramework.getIModelConnection());\n      }\n    };\n\n    SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n    return () => {\n      SyncUiEventDispatcher.onSyncUiEvent.removeListener(handleSyncUiEvent);\n    };\n  }, [activeConnection]);\n\n  return activeConnection;\n}\n"]}

package/lib/esm/appui-react/hooks/useActiveStageId.d.ts

@@ -1,8 +1,8 @@
-/** @packageDocumentation
- * @module Hooks
- */
-/** React hook that maintains the active stage Id.
- * @public
- */
-export declare function useActiveStageId(): string;
+/** @packageDocumentation
+ * @module Hooks
+ */
+/** React hook that maintains the active stage Id.
+ * @public
+ */
+export declare function useActiveStageId(): string;
 //# sourceMappingURL=useActiveStageId.d.ts.map

package/lib/esm/appui-react/hooks/useActiveStageId.js

@@ -1,26 +1,26 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hooks
- */
-import { useEffect, useState } from "react";
-import { UiFramework } from "../UiFramework";
-/** React hook that maintains the active stage Id.
- * @public
- */
-export function useActiveStageId() {
-    const [activeStageId, setActiveStageId] = useState(UiFramework.frontstages.activeFrontstageId);
-    useEffect(() => {
-        const handleFrontstageActivatedEvent = (args) => {
-            setActiveStageId(args.activatedFrontstageDef.id);
-        };
-        UiFramework.frontstages.onFrontstageActivatedEvent.addListener(handleFrontstageActivatedEvent);
-        return () => {
-            UiFramework.frontstages.onFrontstageActivatedEvent.removeListener(handleFrontstageActivatedEvent);
-        };
-    }, []);
-    return activeStageId;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useEffect, useState } from "react";
+import { UiFramework } from "../UiFramework";
+/** React hook that maintains the active stage Id.
+ * @public
+ */
+export function useActiveStageId() {
+    const [activeStageId, setActiveStageId] = useState(UiFramework.frontstages.activeFrontstageId);
+    useEffect(() => {
+        const handleFrontstageActivatedEvent = (args) => {
+            setActiveStageId(args.activatedFrontstageDef.id);
+        };
+        UiFramework.frontstages.onFrontstageActivatedEvent.addListener(handleFrontstageActivatedEvent);
+        return () => {
+            UiFramework.frontstages.onFrontstageActivatedEvent.removeListener(handleFrontstageActivatedEvent);
+        };
+    }, []);
+    return activeStageId;
+}
 //# sourceMappingURL=useActiveStageId.js.map

package/lib/esm/appui-react/hooks/useActiveStageId.js.map

@@ -1 +1 @@
-{"version":3,"file":"useActiveStageId.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveStageId.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAC/F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,8BAA8B,GAAG,CAAC,IAAkC,EAAE,EAAE;YAC5E,gBAAgB,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;QAC/F,OAAO,GAAG,EAAE;YACV,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;QACpG,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,aAAa,CAAC;AACvB,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 Hooks\r\n */\r\n\r\nimport { useEffect, useState } from \"react\";\r\nimport { FrontstageActivatedEventArgs } from \"../framework/FrameworkFrontstages\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** React hook that maintains the active stage Id.\r\n * @public\r\n */\r\nexport function useActiveStageId(): string {\r\n  const [activeStageId, setActiveStageId] = useState(UiFramework.frontstages.activeFrontstageId);\r\n  useEffect(() => {\r\n    const handleFrontstageActivatedEvent = (args: FrontstageActivatedEventArgs) => {\r\n      setActiveStageId(args.activatedFrontstageDef.id);\r\n    };\r\n\r\n    UiFramework.frontstages.onFrontstageActivatedEvent.addListener(handleFrontstageActivatedEvent);\r\n    return () => {\r\n      UiFramework.frontstages.onFrontstageActivatedEvent.removeListener(handleFrontstageActivatedEvent);\r\n    };\r\n  }, []);\r\n  return activeStageId;\r\n}\r\n"]}
+{"version":3,"file":"useActiveStageId.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveStageId.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;IAC/F,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,8BAA8B,GAAG,CAAC,IAAkC,EAAE,EAAE;YAC5E,gBAAgB,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC;QAEF,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;QAC/F,OAAO,GAAG,EAAE;YACV,WAAW,CAAC,WAAW,CAAC,0BAA0B,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;QACpG,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,aAAa,CAAC;AACvB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport { FrontstageActivatedEventArgs } from \"../framework/FrameworkFrontstages\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** React hook that maintains the active stage Id.\n * @public\n */\nexport function useActiveStageId(): string {\n  const [activeStageId, setActiveStageId] = useState(UiFramework.frontstages.activeFrontstageId);\n  useEffect(() => {\n    const handleFrontstageActivatedEvent = (args: FrontstageActivatedEventArgs) => {\n      setActiveStageId(args.activatedFrontstageDef.id);\n    };\n\n    UiFramework.frontstages.onFrontstageActivatedEvent.addListener(handleFrontstageActivatedEvent);\n    return () => {\n      UiFramework.frontstages.onFrontstageActivatedEvent.removeListener(handleFrontstageActivatedEvent);\n    };\n  }, []);\n  return activeStageId;\n}\n"]}

package/lib/esm/appui-react/hooks/useActiveViewport.d.ts

@@ -1,9 +1,9 @@
-/** @packageDocumentation
- * @module Hooks
- */
-import { ScreenViewport } from "@itwin/core-frontend";
-/** React hook that maintains the active viewport.
- * @public
- */
-export declare function useActiveViewport(): ScreenViewport | undefined;
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { ScreenViewport } from "@itwin/core-frontend";
+/** React hook that maintains the active viewport.
+ * @public
+ */
+export declare function useActiveViewport(): ScreenViewport | undefined;
 //# sourceMappingURL=useActiveViewport.d.ts.map

package/lib/esm/appui-react/hooks/useActiveViewport.js

@@ -1,43 +1,43 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Hooks
- */
-import { useEffect, useState } from "react";
-import { IModelApp } from "@itwin/core-frontend";
-import { SyncUiEventDispatcher, SyncUiEventId } from "../syncui/SyncUiEventDispatcher";
-import { UiFramework } from "../UiFramework";
-/** React hook that maintains the active viewport.
- * @public
- */
-// istanbul ignore next
-export function useActiveViewport() {
-    const [activeViewport, setActiveViewport] = useState(IModelApp.viewManager.selectedView);
-    useEffect(() => {
-        const onActiveContentChanged = (_args) => {
-            setActiveViewport(IModelApp.viewManager.selectedView);
-        };
-        // IModelApp.viewManager.onSelectedViewportChanged will often fire before UI components have mounted
-        // so use UiFramework.content.onActiveContentChangedEvent which will always trigger once all stage components
-        // are loaded and when the IModelApp.viewManager.selectedView changes.
-        UiFramework.content.onActiveContentChangedEvent.addListener(onActiveContentChanged);
-        return () => {
-            UiFramework.content.onActiveContentChangedEvent.removeListener(onActiveContentChanged);
-        };
-    }, []);
-    useEffect(() => {
-        const syncIdsOfInterest = [SyncUiEventId.ActiveContentChanged, SyncUiEventId.ContentControlActivated, SyncUiEventId.FrontstageReady];
-        const handleSyncUiEvent = (args) => {
-            // istanbul ignore else
-            if (syncIdsOfInterest.some((value) => args.eventIds.has(value))) {
-                const activeContentControl = UiFramework.content.getActiveContentControl();
-                setActiveViewport(activeContentControl && activeContentControl.viewport);
-            }
-        };
-        return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
-    }, []);
-    return activeViewport;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { useEffect, useState } from "react";
+import { IModelApp } from "@itwin/core-frontend";
+import { SyncUiEventDispatcher, SyncUiEventId } from "../syncui/SyncUiEventDispatcher";
+import { UiFramework } from "../UiFramework";
+/** React hook that maintains the active viewport.
+ * @public
+ */
+// istanbul ignore next
+export function useActiveViewport() {
+    const [activeViewport, setActiveViewport] = useState(IModelApp.viewManager.selectedView);
+    useEffect(() => {
+        const onActiveContentChanged = (_args) => {
+            setActiveViewport(IModelApp.viewManager.selectedView);
+        };
+        // IModelApp.viewManager.onSelectedViewportChanged will often fire before UI components have mounted
+        // so use UiFramework.content.onActiveContentChangedEvent which will always trigger once all stage components
+        // are loaded and when the IModelApp.viewManager.selectedView changes.
+        UiFramework.content.onActiveContentChangedEvent.addListener(onActiveContentChanged);
+        return () => {
+            UiFramework.content.onActiveContentChangedEvent.removeListener(onActiveContentChanged);
+        };
+    }, []);
+    useEffect(() => {
+        const syncIdsOfInterest = [SyncUiEventId.ActiveContentChanged, SyncUiEventId.ContentControlActivated, SyncUiEventId.FrontstageReady];
+        const handleSyncUiEvent = (args) => {
+            // istanbul ignore else
+            if (syncIdsOfInterest.some((value) => args.eventIds.has(value))) {
+                const activeContentControl = UiFramework.content.getActiveContentControl();
+                setActiveViewport(activeContentControl && activeContentControl.viewport);
+            }
+        };
+        return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);
+    }, []);
+    return activeViewport;
+}
 //# sourceMappingURL=useActiveViewport.js.map

package/lib/esm/appui-react/hooks/useActiveViewport.js.map

@@ -1 +1 @@
-{"version":3,"file":"useActiveViewport.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveViewport.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAkB,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,uBAAuB;AACvB,MAAM,UAAU,iBAAiB;IAC/B,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACzF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,sBAAsB,GAAG,CAAC,KAAoC,EAAE,EAAE;YACtE,iBAAiB,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF,oGAAoG;QACpG,6GAA6G;QAC7G,sEAAsE;QACtE,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;QACpF,OAAO,GAAG,EAAE;YACV,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;QACzF,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,iBAAiB,GAAG,CAAC,aAAa,CAAC,oBAAoB,EAAE,aAAa,CAAC,uBAAuB,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QACrI,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,uBAAuB;YACvB,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAChF,MAAM,oBAAoB,GAAG,WAAW,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;gBAC3E,iBAAiB,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAC;aAC1E;QACH,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC;AACxB,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 Hooks\r\n */\r\n\r\nimport { useEffect, useState } from \"react\";\r\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\r\nimport { IModelApp, ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { ActiveContentChangedEventArgs } from \"../framework/FrameworkContent\";\r\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** React hook that maintains the active viewport.\r\n * @public\r\n */\r\n// istanbul ignore next\r\nexport function useActiveViewport(): ScreenViewport | undefined {\r\n  const [activeViewport, setActiveViewport] = useState(IModelApp.viewManager.selectedView);\r\n  useEffect(() => {\r\n    const onActiveContentChanged = (_args: ActiveContentChangedEventArgs) => {\r\n      setActiveViewport(IModelApp.viewManager.selectedView);\r\n    };\r\n\r\n    // IModelApp.viewManager.onSelectedViewportChanged will often fire before UI components have mounted\r\n    // so use UiFramework.content.onActiveContentChangedEvent which will always trigger once all stage components\r\n    // are loaded and when the IModelApp.viewManager.selectedView changes.\r\n    UiFramework.content.onActiveContentChangedEvent.addListener(onActiveContentChanged);\r\n    return () => {\r\n      UiFramework.content.onActiveContentChangedEvent.removeListener(onActiveContentChanged);\r\n    };\r\n  }, []);\r\n\r\n  useEffect(() => {\r\n    const syncIdsOfInterest = [SyncUiEventId.ActiveContentChanged, SyncUiEventId.ContentControlActivated, SyncUiEventId.FrontstageReady];\r\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\r\n      // istanbul ignore else\r\n      if (syncIdsOfInterest.some((value: string): boolean => args.eventIds.has(value))) {\r\n        const activeContentControl = UiFramework.content.getActiveContentControl();\r\n        setActiveViewport(activeContentControl && activeContentControl.viewport);\r\n      }\r\n    };\r\n\r\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\r\n  }, []);\r\n\r\n  return activeViewport;\r\n}\r\n"]}
+{"version":3,"file":"useActiveViewport.js","sourceRoot":"","sources":["../../../../src/appui-react/hooks/useActiveViewport.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAkB,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,uBAAuB;AACvB,MAAM,UAAU,iBAAiB;IAC/B,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACzF,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,sBAAsB,GAAG,CAAC,KAAoC,EAAE,EAAE;YACtE,iBAAiB,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC,CAAC;QAEF,oGAAoG;QACpG,6GAA6G;QAC7G,sEAAsE;QACtE,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;QACpF,OAAO,GAAG,EAAE;YACV,WAAW,CAAC,OAAO,CAAC,2BAA2B,CAAC,cAAc,CAAC,sBAAsB,CAAC,CAAC;QACzF,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,iBAAiB,GAAG,CAAC,aAAa,CAAC,oBAAoB,EAAE,aAAa,CAAC,uBAAuB,EAAE,aAAa,CAAC,eAAe,CAAC,CAAC;QACrI,MAAM,iBAAiB,GAAG,CAAC,IAAqB,EAAQ,EAAE;YACxD,uBAAuB;YACvB,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAa,EAAW,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE;gBAChF,MAAM,oBAAoB,GAAG,WAAW,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;gBAC3E,iBAAiB,CAAC,oBAAoB,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAC;aAC1E;QACH,CAAC,CAAC;QAEF,OAAO,qBAAqB,CAAC,aAAa,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAC5E,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC;AACxB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Hooks\n */\n\nimport { useEffect, useState } from \"react\";\nimport { UiSyncEventArgs } from \"@itwin/appui-abstract\";\nimport { IModelApp, ScreenViewport } from \"@itwin/core-frontend\";\nimport { ActiveContentChangedEventArgs } from \"../framework/FrameworkContent\";\nimport { SyncUiEventDispatcher, SyncUiEventId } from \"../syncui/SyncUiEventDispatcher\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** React hook that maintains the active viewport.\n * @public\n */\n// istanbul ignore next\nexport function useActiveViewport(): ScreenViewport | undefined {\n  const [activeViewport, setActiveViewport] = useState(IModelApp.viewManager.selectedView);\n  useEffect(() => {\n    const onActiveContentChanged = (_args: ActiveContentChangedEventArgs) => {\n      setActiveViewport(IModelApp.viewManager.selectedView);\n    };\n\n    // IModelApp.viewManager.onSelectedViewportChanged will often fire before UI components have mounted\n    // so use UiFramework.content.onActiveContentChangedEvent which will always trigger once all stage components\n    // are loaded and when the IModelApp.viewManager.selectedView changes.\n    UiFramework.content.onActiveContentChangedEvent.addListener(onActiveContentChanged);\n    return () => {\n      UiFramework.content.onActiveContentChangedEvent.removeListener(onActiveContentChanged);\n    };\n  }, []);\n\n  useEffect(() => {\n    const syncIdsOfInterest = [SyncUiEventId.ActiveContentChanged, SyncUiEventId.ContentControlActivated, SyncUiEventId.FrontstageReady];\n    const handleSyncUiEvent = (args: UiSyncEventArgs): void => {\n      // istanbul ignore else\n      if (syncIdsOfInterest.some((value: string): boolean => args.eventIds.has(value))) {\n        const activeContentControl = UiFramework.content.getActiveContentControl();\n        setActiveViewport(activeContentControl && activeContentControl.viewport);\n      }\n    };\n\n    return SyncUiEventDispatcher.onSyncUiEvent.addListener(handleSyncUiEvent);\n  }, []);\n\n  return activeViewport;\n}\n"]}

package/lib/esm/appui-react/hooks/useAnalysisAnimationDataProvider.d.ts

@@ -1,10 +1,10 @@
-/** @packageDocumentation
- * @module Hooks
- */
-import { AnalysisAnimationTimelineDataProvider } from "../timeline/AnalysisAnimationProvider";
-import { ScreenViewport } from "@itwin/core-frontend";
-/** Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data.
- * @public
- **/
-export declare function useAnalysisAnimationDataProvider(viewport: ScreenViewport | undefined): AnalysisAnimationTimelineDataProvider | undefined;
+/** @packageDocumentation
+ * @module Hooks
+ */
+import { AnalysisAnimationTimelineDataProvider } from "../timeline/AnalysisAnimationProvider";
+import { ScreenViewport } from "@itwin/core-frontend";
+/** Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data.
+ * @public
+ **/
+export declare function useAnalysisAnimationDataProvider(viewport: ScreenViewport | undefined): AnalysisAnimationTimelineDataProvider | undefined;
 //# sourceMappingURL=useAnalysisAnimationDataProvider.d.ts.map