@itwin/appui-react 3.0.0-dev.100

package/lib/esm/appui-react/configurableui/state.js

@@ -0,0 +1,79 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module State
+ */
+import { SnapMode } from "@itwin/core-frontend";
+import { createAction } from "../redux/redux-ts";
+import { SYSTEM_PREFERRED_COLOR_THEME, WIDGET_OPACITY_DEFAULT } from "../theme/ThemeManager";
+// cSpell:ignore configurableui snapmode toolprompt
+/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.
+ *  Since these are also used as sync ids they should be in lowercase.
+ * @public
+ */
+export var ConfigurableUiActionId;
+(function (ConfigurableUiActionId) {
+    ConfigurableUiActionId["SetSnapMode"] = "configurableui:set_snapmode";
+    ConfigurableUiActionId["SetTheme"] = "configurableui:set_theme";
+    ConfigurableUiActionId["SetToolPrompt"] = "configurableui:set_toolprompt";
+    ConfigurableUiActionId["SetWidgetOpacity"] = "configurableui:set_widget_opacity";
+    ConfigurableUiActionId["SetDragInteraction"] = "configurableui:set-drag-interaction";
+    ConfigurableUiActionId["SetFrameworkVersion"] = "configurableui:set-framework-version";
+})(ConfigurableUiActionId || (ConfigurableUiActionId = {}));
+/** used on first call of ConfigurableUiReducer */
+const initialState = {
+    snapMode: SnapMode.NearestKeypoint,
+    toolPrompt: "",
+    theme: SYSTEM_PREFERRED_COLOR_THEME,
+    widgetOpacity: WIDGET_OPACITY_DEFAULT,
+    useDragInteraction: false,
+    frameworkVersion: "2",
+};
+/** An object with a function that creates each ConfigurableUiReducer that can be handled by our reducer.
+ * @public
+ */
+export const ConfigurableUiActions = {
+    setSnapMode: (snapMode) => createAction(ConfigurableUiActionId.SetSnapMode, snapMode),
+    setTheme: 
+    // istanbul ignore next
+    (theme) => createAction(ConfigurableUiActionId.SetTheme, theme),
+    setToolPrompt: 
+    // istanbul ignore next
+    (toolPrompt) => createAction(ConfigurableUiActionId.SetToolPrompt, toolPrompt),
+    setWidgetOpacity: 
+    // istanbul ignore next
+    (opacity) => createAction(ConfigurableUiActionId.SetWidgetOpacity, opacity),
+    setDragInteraction: (dragInteraction) => createAction(ConfigurableUiActionId.SetDragInteraction, dragInteraction),
+    setFrameworkVersion: (frameworkVersion) => createAction(ConfigurableUiActionId.SetFrameworkVersion, frameworkVersion),
+};
+/** Handles actions to update ConfigurableUiState.
+ * @public
+ */
+export function ConfigurableUiReducer(state = initialState, action) {
+    const outState = state;
+    switch (action.type) {
+        case ConfigurableUiActionId.SetSnapMode: {
+            return { ...state, snapMode: action.payload };
+        }
+        case ConfigurableUiActionId.SetToolPrompt: {
+            return { ...state, toolPrompt: action.payload };
+        }
+        case ConfigurableUiActionId.SetTheme: {
+            return { ...state, theme: action.payload };
+        }
+        case ConfigurableUiActionId.SetWidgetOpacity: {
+            return { ...state, widgetOpacity: action.payload };
+        }
+        case ConfigurableUiActionId.SetDragInteraction: {
+            return { ...state, useDragInteraction: action.payload };
+        }
+        case ConfigurableUiActionId.SetFrameworkVersion: {
+            const frameworkVersion = (action.payload);
+            return { ...state, frameworkVersion };
+        }
+    }
+    return outState;
+}
+//# sourceMappingURL=state.js.map

package/lib/esm/appui-react/configurableui/state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../../../src/appui-react/configurableui/state.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAgB,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,4BAA4B,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAG7F,mDAAmD;AAEnD;;;GAGG;AACH,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,yEAA+C,CAAA;IAC/C,gFAAsD,CAAA;IACtD,oFAA0D,CAAA;IAC1D,sFAA4D,CAAA;AAC9D,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAcD,kDAAkD;AAClD,MAAM,YAAY,GAAwB;IACxC,QAAQ,EAAE,QAAQ,CAAC,eAAyB;IAC5C,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,4BAA4B;IACnC,aAAa,EAAE,sBAAsB;IACrC,kBAAkB,EAAE,KAAK;IACzB,gBAAgB,EAAE,GAAG;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,WAAW,EAAE,CAAC,QAAgB,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,WAAW,EAAE,QAAQ,CAAC;IAC7F,QAAQ;IACN,uBAAuB;IACvB,CAAC,KAAa,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,QAAQ,EAAE,KAAK,CAAC;IACzE,aAAa;IACX,uBAAuB;IACvB,CAAC,UAAkB,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,aAAa,EAAE,UAAU,CAAC;IACxF,gBAAgB;IACd,uBAAuB;IACvB,CAAC,OAAe,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,gBAAgB,EAAE,OAAO,CAAC;IACrF,kBAAkB,EAAE,CAAC,eAAwB,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,kBAAkB,EAAE,eAAe,CAAC;IAC1H,mBAAmB,EAAE,CAAC,gBAAoC,EAAE,EAAE,CAAC,YAAY,CAAC,sBAAsB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;CAC1I,CAAC;AAOF;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAA6B,YAAY,EAAE,MAAkC;IACjH,MAAM,QAAQ,GAAG,KAAK,CAAC;IAEvB,QAAQ,MAAM,CAAC,IAAI,EAAE;QACnB,KAAK,sBAAsB,CAAC,WAAW,CAAC,CAAC;YACvC,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SAC/C;QACD,KAAK,sBAAsB,CAAC,aAAa,CAAC,CAAC;YACzC,OAAO,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACjD;QACD,KAAK,sBAAsB,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SAC5C;QACD,KAAK,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;YAC5C,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACpD;QACD,KAAK,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;YAC9C,OAAO,EAAE,GAAG,KAAK,EAAE,kBAAkB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACzD;QACD,KAAK,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;YAC/C,MAAM,gBAAgB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC1C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC;SACvC;KACF;IACD,OAAO,QAAQ,CAAC;AAClB,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 State\r\n */\r\n\r\nimport { SnapMode } from \"@itwin/core-frontend\";\r\nimport { ActionsUnion, createAction } from \"../redux/redux-ts\";\r\nimport { SYSTEM_PREFERRED_COLOR_THEME, WIDGET_OPACITY_DEFAULT } from \"../theme/ThemeManager\";\r\nimport { FrameworkVersionId } from \"../UiFramework\";\r\n\r\n// cSpell:ignore configurableui snapmode toolprompt\r\n\r\n/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.\r\n *  Since these are also used as sync ids they should be in lowercase.\r\n * @public\r\n */\r\nexport enum ConfigurableUiActionId {\r\n  SetSnapMode = \"configurableui:set_snapmode\",\r\n  SetTheme = \"configurableui:set_theme\",\r\n  SetToolPrompt = \"configurableui:set_toolprompt\",\r\n  SetWidgetOpacity = \"configurableui:set_widget_opacity\",\r\n  SetDragInteraction = \"configurableui:set-drag-interaction\",\r\n  SetFrameworkVersion = \"configurableui:set-framework-version\",\r\n}\r\n\r\n/** The portion of state managed by the ConfigurableUiReducer.\r\n * @public\r\n */\r\nexport interface ConfigurableUiState {\r\n  snapMode: number;\r\n  toolPrompt: string;\r\n  theme: string;\r\n  widgetOpacity: number;\r\n  useDragInteraction: boolean;\r\n  frameworkVersion: FrameworkVersionId;\r\n}\r\n\r\n/** used on first call of ConfigurableUiReducer */\r\nconst initialState: ConfigurableUiState = {\r\n  snapMode: SnapMode.NearestKeypoint as number,\r\n  toolPrompt: \"\",\r\n  theme: SYSTEM_PREFERRED_COLOR_THEME,\r\n  widgetOpacity: WIDGET_OPACITY_DEFAULT,\r\n  useDragInteraction: false,\r\n  frameworkVersion: \"2\",\r\n};\r\n\r\n/** An object with a function that creates each ConfigurableUiReducer that can be handled by our reducer.\r\n * @public\r\n */\r\nexport const ConfigurableUiActions = {   // eslint-disable-line @typescript-eslint/naming-convention\r\n  setSnapMode: (snapMode: number) => createAction(ConfigurableUiActionId.SetSnapMode, snapMode),\r\n  setTheme:\r\n    // istanbul ignore next\r\n    (theme: string) => createAction(ConfigurableUiActionId.SetTheme, theme),\r\n  setToolPrompt:\r\n    // istanbul ignore next\r\n    (toolPrompt: string) => createAction(ConfigurableUiActionId.SetToolPrompt, toolPrompt),\r\n  setWidgetOpacity:\r\n    // istanbul ignore next\r\n    (opacity: number) => createAction(ConfigurableUiActionId.SetWidgetOpacity, opacity),\r\n  setDragInteraction: (dragInteraction: boolean) => createAction(ConfigurableUiActionId.SetDragInteraction, dragInteraction),\r\n  setFrameworkVersion: (frameworkVersion: FrameworkVersionId) => createAction(ConfigurableUiActionId.SetFrameworkVersion, frameworkVersion),\r\n};\r\n\r\n/** Union of ConfigurableUi Redux actions\r\n * @public\r\n */\r\nexport type ConfigurableUiActionsUnion = ActionsUnion<typeof ConfigurableUiActions>;\r\n\r\n/** Handles actions to update ConfigurableUiState.\r\n * @public\r\n */\r\nexport function ConfigurableUiReducer(state: ConfigurableUiState = initialState, action: ConfigurableUiActionsUnion): ConfigurableUiState {\r\n  const outState = state;\r\n\r\n  switch (action.type) {\r\n    case ConfigurableUiActionId.SetSnapMode: {\r\n      return { ...state, snapMode: action.payload };\r\n    }\r\n    case ConfigurableUiActionId.SetToolPrompt: {\r\n      return { ...state, toolPrompt: action.payload };\r\n    }\r\n    case ConfigurableUiActionId.SetTheme: {\r\n      return { ...state, theme: action.payload };\r\n    }\r\n    case ConfigurableUiActionId.SetWidgetOpacity: {\r\n      return { ...state, widgetOpacity: action.payload };\r\n    }\r\n    case ConfigurableUiActionId.SetDragInteraction: {\r\n      return { ...state, useDragInteraction: action.payload };\r\n    }\r\n    case ConfigurableUiActionId.SetFrameworkVersion: {\r\n      const frameworkVersion = (action.payload);\r\n      return { ...state, frameworkVersion };\r\n    }\r\n  }\r\n  return outState;\r\n}\r\n"]}

package/lib/esm/appui-react/content/ContentControl.d.ts

@@ -0,0 +1,59 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import { Id64String } from "@itwin/core-bentley";
+import { IModelConnection, ScreenViewport, ViewState } from "@itwin/core-frontend";
+import { UiEvent } from "@itwin/core-react";
+import { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+/** ControlControl Activated Event Args interface.
+ * @public
+ */
+export interface ContentControlActivatedEventArgs {
+    activeContentControl: ContentControl;
+    oldContentControl?: ContentControl;
+}
+/** ContentControl Activated Event class.
+ * @public
+ */
+export declare class ContentControlActivatedEvent extends UiEvent<ContentControlActivatedEventArgs> {
+}
+/** Interface to be implemented when the ContentControl supports ViewSelector changes
+ * @public
+ */
+export interface SupportsViewSelectorChange {
+    /** Returns true if this control supports reacting to ViewSelector changes. */
+    supportsViewSelectorChange: boolean;
+    /** Process a ViewSelector change. */
+    processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;
+}
+/** The base class for Frontstage content controls.
+ * @public
+ */
+export declare class ContentControl extends ConfigurableUiControl {
+    protected _reactNode: React.ReactNode;
+    private _keyAdded;
+    /** Creates an instance of ContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info: ConfigurableCreateInfo, options: any);
+    /** Called when this ContentControl is activated */
+    onActivated(): void;
+    /** Called when this ContentControl is deactivated */
+    onDeactivated(): void;
+    /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */
+    getType(): ConfigurableUiControlType;
+    /** Returns true if this control is a Viewport control. */
+    get isViewport(): boolean;
+    /** Returns the ScreenViewport if isViewport is true */
+    get viewport(): ScreenViewport | undefined;
+    protected getKeyedReactNode(): React.ReactNode;
+    protected getReactNode(): React.ReactNode;
+    /** The React node associated with this control. */
+    get reactNode(): React.ReactNode;
+    set reactNode(r: React.ReactNode);
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl(): string;
+}
+//# sourceMappingURL=ContentControl.d.ts.map

package/lib/esm/appui-react/content/ContentControl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentControl.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentControl.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACnF,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAEnI;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,oBAAoB,EAAE,cAAc,CAAC;IACrC,iBAAiB,CAAC,EAAE,cAAc,CAAC;CACpC;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAI;AAE/F;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,8EAA8E;IAC9E,0BAA0B,EAAE,OAAO,CAAC;IACpC,qCAAqC;IACrC,yBAAyB,CAAC,MAAM,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtI;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,qBAAqB;IACvD,SAAS,CAAC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC;IACtC,OAAO,CAAC,SAAS,CAAS;IAE1B;;;OAGG;gBACS,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,GAAG;IAItD,mDAAmD;IAC5C,WAAW,IAAI,IAAI;IAG1B,qDAAqD;IAC9C,aAAa,IAAI,IAAI;IAG5B,8EAA8E;IACvE,OAAO,IAAI,yBAAyB;IAE3C,0DAA0D;IAC1D,IAAW,UAAU,IAAI,OAAO,CAAkB;IAClD,uDAAuD;IACvD,IAAW,QAAQ,IAAI,cAAc,GAAG,SAAS,CAAsB;IAEvE,SAAS,CAAC,iBAAiB,IAAI,KAAK,CAAC,SAAS;IAa9C,SAAS,CAAC,YAAY,IAAI,KAAK,CAAC,SAAS;IAIzC,mDAAmD;IACnD,IAAW,SAAS,IAAI,KAAK,CAAC,SAAS,CAEtC;IAED,IAAW,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,EAA0B;IAEjE,uEAAuE;IACvE,IAAW,oBAAoB,IAAI,MAAM,CAExC;CAEF"}

package/lib/esm/appui-react/content/ContentControl.js

@@ -0,0 +1,64 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import { UiEvent } from "@itwin/core-react";
+import { ConfigurableUiControl, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+/** ContentControl Activated Event class.
+ * @public
+ */
+export class ContentControlActivatedEvent extends UiEvent {
+}
+/** The base class for Frontstage content controls.
+ * @public
+ */
+export class ContentControl extends ConfigurableUiControl {
+    /** Creates an instance of ContentControl.
+     * @param info         An object that the subclass must pass to this base class.
+     * @param options      Options provided via the applicationData in a [[ContentProps]].
+     */
+    constructor(info, options) {
+        super(info, options);
+        this._keyAdded = false;
+    }
+    /** Called when this ContentControl is activated */
+    onActivated() {
+    }
+    /** Called when this ContentControl is deactivated */
+    onDeactivated() {
+    }
+    /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */
+    getType() { return ConfigurableUiControlType.Content; }
+    /** Returns true if this control is a Viewport control. */
+    get isViewport() { return false; }
+    /** Returns the ScreenViewport if isViewport is true */
+    get viewport() { return undefined; }
+    getKeyedReactNode() {
+        if (!this._keyAdded && React.isValidElement(this._reactNode)) {
+            // istanbul ignore else
+            if (!this._reactNode.key) {
+                const additionalProps = { key: this.uniqueId };
+                this._reactNode = React.cloneElement(this._reactNode, additionalProps);
+            }
+            this._keyAdded = true;
+        }
+        return this._reactNode;
+    }
+    getReactNode() {
+        return this.getKeyedReactNode();
+    }
+    /** The React node associated with this control. */
+    get reactNode() {
+        return this.getReactNode();
+    }
+    set reactNode(r) { this._reactNode = r; }
+    /** Get the NavigationAidControl associated with this ContentControl */
+    get navigationAidControl() {
+        return "";
+    }
+}
+//# sourceMappingURL=ContentControl.js.map

package/lib/esm/appui-react/content/ContentControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentControl.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentControl.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAG/B,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAA0B,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAUnI;;GAEG;AACH,MAAM,OAAO,4BAA6B,SAAQ,OAAyC;CAAI;AAY/F;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,qBAAqB;IAIvD;;;OAGG;IACH,YAAY,IAA4B,EAAE,OAAY;QACpD,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAPf,cAAS,GAAG,KAAK,CAAC;IAQ1B,CAAC;IAED,mDAAmD;IAC5C,WAAW;IAClB,CAAC;IAED,qDAAqD;IAC9C,aAAa;IACpB,CAAC;IAED,8EAA8E;IACvE,OAAO,KAAgC,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAC,CAAC;IAEzF,0DAA0D;IAC1D,IAAW,UAAU,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAClD,uDAAuD;IACvD,IAAW,QAAQ,KAAiC,OAAO,SAAS,CAAC,CAAC,CAAC;IAE7D,iBAAiB;QACzB,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAC5D,uBAAuB;YACvB,IAAI,CAAE,IAAI,CAAC,UAAsC,CAAC,GAAG,EAAE;gBACrD,MAAM,eAAe,GAAQ,EAAE,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACpD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;aACxE;YACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;SACvB;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAES,YAAY;QACpB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAClC,CAAC;IAED,mDAAmD;IACnD,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,YAAY,EAAE,CAAC;IAC7B,CAAC;IAED,IAAW,SAAS,CAAC,CAAkB,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC;IAEjE,uEAAuE;IACvE,IAAW,oBAAoB;QAC7B,OAAO,EAAE,CAAC;IACZ,CAAC;CAEF","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 ContentView\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { IModelConnection, ScreenViewport, ViewState } from \"@itwin/core-frontend\";\r\nimport { UiEvent } from \"@itwin/core-react\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControl, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\n\r\n/** ControlControl Activated Event Args interface.\r\n * @public\r\n */\r\nexport interface ContentControlActivatedEventArgs {\r\n  activeContentControl: ContentControl;\r\n  oldContentControl?: ContentControl;\r\n}\r\n\r\n/** ContentControl Activated Event class.\r\n * @public\r\n */\r\nexport class ContentControlActivatedEvent extends UiEvent<ContentControlActivatedEventArgs> { }\r\n\r\n/** Interface to be implemented when the ContentControl supports ViewSelector changes\r\n * @public\r\n */\r\nexport interface SupportsViewSelectorChange {\r\n  /** Returns true if this control supports reacting to ViewSelector changes. */\r\n  supportsViewSelectorChange: boolean;\r\n  /** Process a ViewSelector change. */\r\n  processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void>;\r\n}\r\n\r\n/** The base class for Frontstage content controls.\r\n * @public\r\n */\r\nexport class ContentControl extends ConfigurableUiControl {\r\n  protected _reactNode: React.ReactNode;\r\n  private _keyAdded = false;\r\n\r\n  /** Creates an instance of ContentControl.\r\n   * @param info         An object that the subclass must pass to this base class.\r\n   * @param options      Options provided via the applicationData in a [[ContentProps]].\r\n   */\r\n  constructor(info: ConfigurableCreateInfo, options: any) {\r\n    super(info, options);\r\n  }\r\n\r\n  /** Called when this ContentControl is activated */\r\n  public onActivated(): void {\r\n  }\r\n\r\n  /** Called when this ContentControl is deactivated */\r\n  public onDeactivated(): void {\r\n  }\r\n\r\n  /** Gets the type of ConfigurableUiControl, which is 'Content' in this case */\r\n  public getType(): ConfigurableUiControlType { return ConfigurableUiControlType.Content; }\r\n\r\n  /** Returns true if this control is a Viewport control. */\r\n  public get isViewport(): boolean { return false; }\r\n  /** Returns the ScreenViewport if isViewport is true */\r\n  public get viewport(): ScreenViewport | undefined { return undefined; }\r\n\r\n  protected getKeyedReactNode(): React.ReactNode {\r\n    if (!this._keyAdded && React.isValidElement(this._reactNode)) {\r\n      // istanbul ignore else\r\n      if (!(this._reactNode as React.ReactElement<any>).key) {\r\n        const additionalProps: any = { key: this.uniqueId };\r\n        this._reactNode = React.cloneElement(this._reactNode, additionalProps);\r\n      }\r\n      this._keyAdded = true;\r\n    }\r\n\r\n    return this._reactNode;\r\n  }\r\n\r\n  protected getReactNode(): React.ReactNode {\r\n    return this.getKeyedReactNode();\r\n  }\r\n\r\n  /** The React node associated with this control. */\r\n  public get reactNode(): React.ReactNode {\r\n    return this.getReactNode();\r\n  }\r\n\r\n  public set reactNode(r: React.ReactNode) { this._reactNode = r; }\r\n\r\n  /** Get the NavigationAidControl associated with this ContentControl */\r\n  public get navigationAidControl(): string {\r\n    return \"\";\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-react/content/ContentGroup.d.ts

@@ -0,0 +1,93 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+import * as React from "react";
+import { ScreenViewport } from "@itwin/core-frontend";
+import { ContentLayoutProps } from "@itwin/appui-abstract";
+import { ConfigurableUiControlConstructor } from "../configurableui/ConfigurableUiControl";
+import { ContentControl } from "./ContentControl";
+import { FrontstageProps } from "../frontstage/Frontstage";
+/** Properties for content displayed in a content view
+ * @public
+ */
+export interface ContentProps {
+    /** A unique id for the Content View within the group */
+    id: string;
+    /** The class name or [[ConfigurableUiControlConstructor]] of the content control */
+    classId: string | ConfigurableUiControlConstructor;
+    /** Optional application data passed down to the Content View */
+    applicationData?: any;
+}
+/** Properties for a [[ContentGroup]]
+ * @public
+ */
+export interface ContentGroupProps {
+    /** An optional id for the [[ContentGroup]] */
+    id: string;
+    /** Content Layout Id or complete set of [[ContentLayoutProps]]  */
+    layout: ContentLayoutProps;
+    /** A collection of [[ContentProps]], one for each content view */
+    contents: ContentProps[];
+}
+/** Abstract class that can be implemented and specified by frontstage to dynamically construct
+ * content group just prior to activating the frontstage.
+ * @public
+ */
+export declare abstract class ContentGroupProvider {
+    abstract provideContentGroup(props: FrontstageProps): Promise<ContentGroup>;
+    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
+     * be to remove applicationData entries.
+     */
+    prepareToSaveProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
+     * Typically this may be to add applicationData to content entries.
+     */
+    applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps): ContentGroupProps;
+    /** Allow provider to save any content group data before the stage deactivated. */
+    onFrontstageDeactivated(): Promise<void>;
+}
+/** Callback to process content properties during toJSON method
+ * @public
+ */
+export declare type ContentCallback = (content: ContentProps) => void;
+/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
+ * @public
+ */
+export declare class ContentGroup {
+    private static _sId;
+    groupId: string;
+    propsId: string;
+    layout: ContentLayoutProps;
+    contentPropsList: ContentProps[];
+    private _contentControls;
+    private _contentSetMap;
+    get id(): string;
+    constructor(contentGroupProps: ContentGroupProps);
+    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
+    getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined;
+    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
+    getContentControlById(id: string): ContentControl | undefined;
+    /** Gets the React nodes representing the Content Views in this Content Group. */
+    getContentNodes(): React.ReactNode[];
+    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
+    getControlFromElement(node: React.ReactNode): ContentControl | undefined;
+    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
+    refreshContentNodes(): void;
+    /** Gets an array of the content controls representing the Content Views. */
+    getContentControls(): ContentControl[];
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated(): void;
+    /** Called when Frontstage is ready. */
+    onFrontstageReady(): void;
+    /** Clears the map of content controls. */
+    clearContentControls(): void;
+    /** Creates [[ContentGroupProps]] for JSON purposes
+     * @public
+     */
+    toJSON(contentCallback?: ContentCallback): ContentGroupProps;
+    /** Gets Viewports from Viewport Content Controls
+     * @internal
+     */
+    getViewports(): Array<ScreenViewport | undefined>;
+}
+//# sourceMappingURL=ContentGroup.d.ts.map

package/lib/esm/appui-react/content/ContentGroup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentGroup.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAW,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAA0B,gCAAgC,EAA6B,MAAM,yCAAyC,CAAC;AAG9I,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wDAAwD;IACxD,EAAE,EAAE,MAAM,CAAC;IACX,oFAAoF;IACpF,OAAO,EAAE,MAAM,GAAG,gCAAgC,CAAC;IACnD,gEAAgE;IAChE,eAAe,CAAC,EAAE,GAAG,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,8CAA8C;IAC9C,EAAE,EAAE,MAAM,CAAC;IACX,mEAAmE;IACnE,MAAM,EAAE,kBAAkB,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B;AAED;;;GAGG;AACH,8BAAsB,oBAAoB;IACxC,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC;IAE3E;;OAEG;IACI,kBAAkB,CAAC,iBAAiB,EAAE,iBAAiB;IAI9D;;OAEG;IACI,wBAAwB,CAAC,iBAAiB,EAAE,iBAAiB;IAIpE,kFAAkF;IACrE,uBAAuB;CACrC;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,CAAC,OAAO,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9D;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAK;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,gBAAgB,EAAE,YAAY,EAAE,CAAC;IACxC,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,cAAc,CAAqC;IAE3D,IAAW,EAAE,WAEZ;gBAEW,iBAAiB,EAAE,iBAAiB;IAQhD,sFAAsF;IAC/E,iBAAiB,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IA+BhG,wEAAwE;IACjE,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAIpE,iFAAiF;IAC1E,eAAe,IAAI,KAAK,CAAC,SAAS,EAAE;IAgB3C,kGAAkG;IAC3F,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,SAAS,GAAG,cAAc,GAAG,SAAS;IAe/E,uFAAuF;IAChF,mBAAmB;IAI1B,4EAA4E;IACrE,kBAAkB,IAAI,cAAc,EAAE;IAa7C,6CAA6C;IACtC,uBAAuB,IAAI,IAAI;IAItC,uCAAuC;IAChC,iBAAiB,IAAI,IAAI;IAEhC,0CAA0C;IACnC,oBAAoB,IAAI,IAAI;IAInC;;OAEG;IACI,MAAM,CAAC,eAAe,CAAC,EAAE,eAAe,GAAG,iBAAiB;IAuBnE;;OAEG;IACI,YAAY,IAAI,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC;CAczD"}

package/lib/esm/appui-react/content/ContentGroup.js

@@ -0,0 +1,172 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module ContentView
+ */
+import { Logger } from "@itwin/core-bentley";
+import { UiError } from "@itwin/appui-abstract";
+import { ConfigurableCreateInfo, ConfigurableUiControlType } from "../configurableui/ConfigurableUiControl";
+import { ConfigurableUiManager } from "../configurableui/ConfigurableUiManager";
+import { UiFramework } from "../UiFramework";
+/** Abstract class that can be implemented and specified by frontstage to dynamically construct
+ * content group just prior to activating the frontstage.
+ * @public
+ */
+export class ContentGroupProvider {
+    /** Allow provider to update any data stored in ContentGroupProps. Typically this may
+     * be to remove applicationData entries.
+     */
+    prepareToSaveProps(contentGroupProps) {
+        return contentGroupProps;
+    }
+    /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.
+     * Typically this may be to add applicationData to content entries.
+     */
+    applyUpdatesToSavedProps(contentGroupProps) {
+        return contentGroupProps;
+    }
+    /** Allow provider to save any content group data before the stage deactivated. */
+    async onFrontstageDeactivated() { }
+}
+/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].
+ * @public
+ */
+export class ContentGroup {
+    constructor(contentGroupProps) {
+        this._contentControls = new Map();
+        this._contentSetMap = new Map();
+        this.layout = { ...contentGroupProps.layout };
+        this.propsId = contentGroupProps.id;
+        // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls
+        this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;
+        this.contentPropsList = contentGroupProps.contents;
+    }
+    get id() {
+        return this.groupId;
+    }
+    /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */
+    getContentControl(contentProps, _index) {
+        // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`
+        const id = `${contentProps.id}::${this.groupId}`;
+        let contentControl;
+        if (!this._contentControls.get(contentProps.id)) {
+            let usedClassId = "";
+            if (typeof contentProps.classId === "string") {
+                if (!this._contentControls.get(contentProps.id) && ConfigurableUiManager.isControlRegistered(contentProps.classId)) {
+                    contentControl = ConfigurableUiManager.createControl(contentProps.classId, id, contentProps.applicationData, contentProps.id);
+                    usedClassId = contentProps.classId;
+                }
+            }
+            else {
+                const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);
+                contentControl = new contentProps.classId(info, contentProps.applicationData);
+                usedClassId = contentProps.classId.name;
+            }
+            if (contentControl) {
+                if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {
+                    throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);
+                }
+                contentControl.initialize();
+                this._contentControls.set(contentProps.id, contentControl);
+            }
+        }
+        return this._contentControls.get(contentProps.id);
+    }
+    /** Gets a [[ContentControl]] from the Content Group with a given ID. */
+    getContentControlById(id) {
+        return this._contentControls.get(id);
+    }
+    /** Gets the React nodes representing the Content Views in this Content Group. */
+    getContentNodes() {
+        const contentNodes = new Array();
+        this._contentSetMap.clear();
+        this.contentPropsList.forEach((contentProps, index) => {
+            const control = this.getContentControl(contentProps, index);
+            if (control) {
+                contentNodes.push(control.reactNode);
+                this._contentSetMap.set(control.controlId, control);
+            }
+        });
+        return contentNodes;
+    }
+    /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */
+    getControlFromElement(node) {
+        if (this._contentSetMap.size === 0)
+            this.getContentNodes();
+        if (node && node.key) {
+            const key = node.key;
+            // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id
+            const controlId = key.split("::", 1)[0];
+            return this._contentSetMap.get(controlId);
+        }
+        Logger.logError(UiFramework.loggerCategory(this), `getControlFromElement: no control found for element`);
+        return undefined;
+    }
+    /** Refreshes the React nodes representing the Content Views in this Content Group.. */
+    refreshContentNodes() {
+        this._contentSetMap.clear();
+    }
+    /** Gets an array of the content controls representing the Content Views. */
+    getContentControls() {
+        const contentControls = new Array();
+        this.contentPropsList.forEach((contentProps, index) => {
+            const control = this.getContentControl(contentProps, index);
+            if (control) {
+                contentControls.push(control);
+            }
+        });
+        return contentControls;
+    }
+    /** Called when Frontstage is deactivated. */
+    onFrontstageDeactivated() {
+        this.clearContentControls();
+    }
+    /** Called when Frontstage is ready. */
+    onFrontstageReady() { }
+    /** Clears the map of content controls. */
+    clearContentControls() {
+        this._contentControls.clear();
+    }
+    /** Creates [[ContentGroupProps]] for JSON purposes
+     * @public
+     */
+    toJSON(contentCallback) {
+        const contentGroupProps = {
+            id: this.propsId,
+            layout: this.layout,
+            contents: this.contentPropsList,
+        };
+        contentGroupProps.contents.forEach((content, index) => {
+            if (typeof content.classId !== "string") {
+                const classId = ConfigurableUiManager.getConstructorClassId(content.classId);
+                if (classId !== undefined)
+                    content.classId = classId;
+                else
+                    throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);
+                if (contentCallback)
+                    contentCallback(content);
+            }
+        });
+        return contentGroupProps;
+    }
+    /** Gets Viewports from Viewport Content Controls
+     * @internal
+     */
+    getViewports() {
+        const contentControls = this.getContentControls();
+        const viewports = new Array();
+        contentControls.forEach((control) => {
+            if (control.isViewport && control.viewport) {
+                viewports.push(control.viewport);
+            }
+            else {
+                viewports.push(undefined);
+            }
+        });
+        return viewports;
+    }
+}
+ContentGroup._sId = 0;
+//# sourceMappingURL=ContentGroup.js.map

package/lib/esm/appui-react/content/ContentGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentGroup.js","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentGroup.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,OAAO,EAAsB,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,sBAAsB,EAAoC,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AAC9I,OAAO,EAAE,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AA4B7C;;;GAGG;AACH,MAAM,OAAgB,oBAAoB;IAGxC;;OAEG;IACI,kBAAkB,CAAC,iBAAoC;QAC5D,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,wBAAwB,CAAC,iBAAoC;QAClE,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,kFAAkF;IAC3E,KAAK,CAAC,uBAAuB,KAAK,CAAC;CAC3C;AAOD;;GAEG;AACH,MAAM,OAAO,YAAY;IAavB,YAAY,iBAAoC;QAPxC,qBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAC;QACrD,mBAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;QAOzD,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,iBAAiB,CAAC,EAAE,CAAC;QACpC,mIAAmI;QACnI,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,EAAE,IAAI,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC;QAClE,IAAI,CAAC,gBAAgB,GAAG,iBAAiB,CAAC,QAAQ,CAAC;IACrD,CAAC;IAVD,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAUD,sFAAsF;IAC/E,iBAAiB,CAAC,YAA0B,EAAE,MAAc;QACjE,wKAAwK;QACxK,MAAM,EAAE,GAAG,GAAG,YAAY,CAAC,EAAE,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC;QACjD,IAAI,cAA0C,CAAC;QAE/C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE;YAC/C,IAAI,WAAW,GAAW,EAAE,CAAC;YAE7B,IAAI,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ,EAAE;gBAC5C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,IAAI,qBAAqB,CAAC,mBAAmB,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE;oBAClH,cAAc,GAAG,qBAAqB,CAAC,aAAa,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,EAAE,YAAY,CAAC,eAAe,EAAE,YAAY,CAAC,EAAE,CAAmB,CAAC;oBAChJ,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC;iBACpC;aACF;iBAAM;gBACL,MAAM,IAAI,GAAG,IAAI,sBAAsB,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC;gBACxF,cAAc,GAAG,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAmB,CAAC;gBAChG,WAAW,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC;aACzC;YAED,IAAI,cAAc,EAAE;gBAClB,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,yBAAyB,CAAC,QAAQ,EAAE;oBACrI,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,6BAA6B,WAAW,qDAAqD,CAAC,CAAC;iBACpJ;gBACD,cAAc,CAAC,UAAU,EAAE,CAAC;gBAC5B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;aAC5D;SACF;QAED,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,wEAAwE;IACjE,qBAAqB,CAAC,EAAU;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAED,iFAAiF;IAC1E,eAAe;QACpB,MAAM,YAAY,GAAsB,IAAI,KAAK,EAAmB,CAAC;QAErE,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;aACrD;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,kGAAkG;IAC3F,qBAAqB,CAAC,IAAqB;QAChD,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,KAAK,CAAC;YAChC,IAAI,CAAC,eAAe,EAAE,CAAC;QAEzB,IAAI,IAAI,IAAK,IAAgC,CAAC,GAAG,EAAE;YACjD,MAAM,GAAG,GAAK,IAAgC,CAAC,GAAc,CAAC;YAC9D,oFAAoF;YACpF,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;SAC3C;QAED,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,qDAAqD,CAAC,CAAC;QACzG,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,uFAAuF;IAChF,mBAAmB;QACxB,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED,4EAA4E;IACrE,kBAAkB;QACvB,MAAM,eAAe,GAAqB,IAAI,KAAK,EAAkB,CAAC;QAEtE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,YAA0B,EAAE,KAAa,EAAE,EAAE;YAC1E,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,OAAO,EAAE;gBACX,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,6CAA6C;IACtC,uBAAuB;QAC5B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAED,uCAAuC;IAChC,iBAAiB,KAAW,CAAC;IAEpC,0CAA0C;IACnC,oBAAoB;QACzB,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,eAAiC;QAC7C,MAAM,iBAAiB,GAAsB;YAC3C,EAAE,EAAE,IAAI,CAAC,OAAO;YAChB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,gBAAgB;SAChC,CAAC;QAEF,iBAAiB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAqB,EAAE,KAAa,EAAE,EAAE;YAC1E,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ,EAAE;gBACvC,MAAM,OAAO,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC7E,IAAI,OAAO,KAAK,SAAS;oBACvB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;;oBAE1B,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mCAAmC,KAAK,qCAAqC,CAAC,CAAC;gBAErI,IAAI,eAAe;oBACjB,eAAe,CAAC,OAAO,CAAC,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,YAAY;QACjB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,SAAS,GAAG,IAAI,KAAK,EAA8B,CAAC;QAE1D,eAAe,CAAC,OAAO,CAAC,CAAC,OAAuB,EAAE,EAAE;YAClD,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,QAAQ,EAAE;gBAC1C,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;aAClC;iBAAM;gBACL,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;;AApKc,iBAAI,GAAG,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 ContentView\r\n */\r\n\r\nimport * as React from \"react\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { ScreenViewport } from \"@itwin/core-frontend\";\r\nimport { ContentLayoutProps, UiError } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableCreateInfo, ConfigurableUiControlConstructor, ConfigurableUiControlType } from \"../configurableui/ConfigurableUiControl\";\r\nimport { ConfigurableUiManager } from \"../configurableui/ConfigurableUiManager\";\r\nimport { UiFramework } from \"../UiFramework\";\r\nimport { ContentControl } from \"./ContentControl\";\r\nimport { FrontstageProps } from \"../frontstage/Frontstage\";\r\n\r\n/** Properties for content displayed in a content view\r\n * @public\r\n */\r\nexport interface ContentProps {\r\n  /** A unique id for the Content View within the group */\r\n  id: string;\r\n  /** The class name or [[ConfigurableUiControlConstructor]] of the content control */\r\n  classId: string | ConfigurableUiControlConstructor;\r\n  /** Optional application data passed down to the Content View */\r\n  applicationData?: any;\r\n}\r\n\r\n/** Properties for a [[ContentGroup]]\r\n * @public\r\n */\r\nexport interface ContentGroupProps {\r\n  /** An optional id for the [[ContentGroup]] */\r\n  id: string;\r\n  /** Content Layout Id or complete set of [[ContentLayoutProps]]  */\r\n  layout: ContentLayoutProps;\r\n  /** A collection of [[ContentProps]], one for each content view */\r\n  contents: ContentProps[];\r\n}\r\n\r\n/** Abstract class that can be implemented and specified by frontstage to dynamically construct\r\n * content group just prior to activating the frontstage.\r\n * @public\r\n */\r\nexport abstract class ContentGroupProvider {\r\n  abstract provideContentGroup(props: FrontstageProps): Promise<ContentGroup>;\r\n\r\n  /** Allow provider to update any data stored in ContentGroupProps. Typically this may\r\n   * be to remove applicationData entries.\r\n   */\r\n  public prepareToSaveProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to update any stored ContentGroupProps be it is to be used to create ContentGroup and layouts.\r\n   * Typically this may be to add applicationData to content entries.\r\n   */\r\n  public applyUpdatesToSavedProps(contentGroupProps: ContentGroupProps) {\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Allow provider to save any content group data before the stage deactivated. */\r\n  public async onFrontstageDeactivated() { }\r\n}\r\n\r\n/** Callback to process content properties during toJSON method\r\n * @public\r\n */\r\nexport type ContentCallback = (content: ContentProps) => void;\r\n\r\n/** ContentGroup class. Content Groups define content displayed in content views that are laid out using a [[ContentLayout]].\r\n * @public\r\n */\r\nexport class ContentGroup {\r\n  private static _sId = 0;\r\n  public groupId: string;\r\n  public propsId: string;\r\n  public layout: ContentLayoutProps;\r\n  public contentPropsList: ContentProps[];\r\n  private _contentControls = new Map<string, ContentControl>();\r\n  private _contentSetMap = new Map<string, ContentControl>();\r\n\r\n  public get id() {\r\n    return this.groupId;\r\n  }\r\n\r\n  constructor(contentGroupProps: ContentGroupProps) {\r\n    this.layout = { ...contentGroupProps.layout };\r\n    this.propsId = contentGroupProps.id;\r\n    // ensure we have a unique groupId for each instance of a content group - this will be used to generate a key in the React controls\r\n    this.groupId = `[${contentGroupProps.id}-${ContentGroup._sId++}]`;\r\n    this.contentPropsList = contentGroupProps.contents;\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group based on its [[ContentProps]]. */\r\n  public getContentControl(contentProps: ContentProps, _index: number): ContentControl | undefined {\r\n    // ensure we have a unique control Id for each instance of a content control - this will be used as a key for the React control - see `ContentControl.getKeyedReactNode`\r\n    const id = `${contentProps.id}::${this.groupId}`;\r\n    let contentControl: ContentControl | undefined;\r\n\r\n    if (!this._contentControls.get(contentProps.id)) {\r\n      let usedClassId: string = \"\";\r\n\r\n      if (typeof contentProps.classId === \"string\") {\r\n        if (!this._contentControls.get(contentProps.id) && ConfigurableUiManager.isControlRegistered(contentProps.classId)) {\r\n          contentControl = ConfigurableUiManager.createControl(contentProps.classId, id, contentProps.applicationData, contentProps.id) as ContentControl;\r\n          usedClassId = contentProps.classId;\r\n        }\r\n      } else {\r\n        const info = new ConfigurableCreateInfo(contentProps.classId.name, id, contentProps.id);\r\n        contentControl = new contentProps.classId(info, contentProps.applicationData) as ContentControl;\r\n        usedClassId = contentProps.classId.name;\r\n      }\r\n\r\n      if (contentControl) {\r\n        if (contentControl.getType() !== ConfigurableUiControlType.Content && contentControl.getType() !== ConfigurableUiControlType.Viewport) {\r\n          throw new UiError(UiFramework.loggerCategory(this), `getContentControl error: '${usedClassId}' is NOT a ContentControl or ViewportContentControl`);\r\n        }\r\n        contentControl.initialize();\r\n        this._contentControls.set(contentProps.id, contentControl);\r\n      }\r\n    }\r\n\r\n    return this._contentControls.get(contentProps.id);\r\n  }\r\n\r\n  /** Gets a [[ContentControl]] from the Content Group with a given ID. */\r\n  public getContentControlById(id: string): ContentControl | undefined {\r\n    return this._contentControls.get(id);\r\n  }\r\n\r\n  /** Gets the React nodes representing the Content Views in this Content Group. */\r\n  public getContentNodes(): React.ReactNode[] {\r\n    const contentNodes: React.ReactNode[] = new Array<React.ReactNode>();\r\n\r\n    this._contentSetMap.clear();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentNodes.push(control.reactNode);\r\n        this._contentSetMap.set(control.controlId, control);\r\n      }\r\n    });\r\n\r\n    return contentNodes;\r\n  }\r\n\r\n  /** Gets the [[ContentControl]] associated with a given React node representing a Content View. */\r\n  public getControlFromElement(node: React.ReactNode): ContentControl | undefined {\r\n    if (this._contentSetMap.size === 0)\r\n      this.getContentNodes();\r\n\r\n    if (node && (node as React.ReactElement<any>).key) {\r\n      const key = ((node as React.ReactElement<any>).key as string);\r\n      // key has format `${contentProps.id}::${this.groupId}` which is stored as unique id\r\n      const controlId = key.split(\"::\", 1)[0];\r\n      return this._contentSetMap.get(controlId);\r\n    }\r\n\r\n    Logger.logError(UiFramework.loggerCategory(this), `getControlFromElement: no control found for element`);\r\n    return undefined;\r\n  }\r\n\r\n  /** Refreshes the React nodes representing the Content Views in this Content Group.. */\r\n  public refreshContentNodes() {\r\n    this._contentSetMap.clear();\r\n  }\r\n\r\n  /** Gets an array of the content controls representing the Content Views. */\r\n  public getContentControls(): ContentControl[] {\r\n    const contentControls: ContentControl[] = new Array<ContentControl>();\r\n\r\n    this.contentPropsList.forEach((contentProps: ContentProps, index: number) => {\r\n      const control = this.getContentControl(contentProps, index);\r\n      if (control) {\r\n        contentControls.push(control);\r\n      }\r\n    });\r\n\r\n    return contentControls;\r\n  }\r\n\r\n  /** Called when Frontstage is deactivated. */\r\n  public onFrontstageDeactivated(): void {\r\n    this.clearContentControls();\r\n  }\r\n\r\n  /** Called when Frontstage is ready. */\r\n  public onFrontstageReady(): void { }\r\n\r\n  /** Clears the map of content controls. */\r\n  public clearContentControls(): void {\r\n    this._contentControls.clear();\r\n  }\r\n\r\n  /** Creates [[ContentGroupProps]] for JSON purposes\r\n   * @public\r\n   */\r\n  public toJSON(contentCallback?: ContentCallback): ContentGroupProps {\r\n    const contentGroupProps: ContentGroupProps = {\r\n      id: this.propsId,\r\n      layout: this.layout,\r\n      contents: this.contentPropsList,\r\n    };\r\n\r\n    contentGroupProps.contents.forEach((content: ContentProps, index: number) => {\r\n      if (typeof content.classId !== \"string\") {\r\n        const classId = ConfigurableUiManager.getConstructorClassId(content.classId);\r\n        if (classId !== undefined)\r\n          content.classId = classId;\r\n        else\r\n          throw new UiError(UiFramework.loggerCategory(this), `toJSON: ContentControl at index ${index} is NOT registered with a string id`);\r\n\r\n        if (contentCallback)\r\n          contentCallback(content);\r\n      }\r\n    });\r\n\r\n    return contentGroupProps;\r\n  }\r\n\r\n  /** Gets Viewports from Viewport Content Controls\r\n   * @internal\r\n   */\r\n  public getViewports(): Array<ScreenViewport | undefined> {\r\n    const contentControls = this.getContentControls();\r\n    const viewports = new Array<ScreenViewport | undefined>();\r\n\r\n    contentControls.forEach((control: ContentControl) => {\r\n      if (control.isViewport && control.viewport) {\r\n        viewports.push(control.viewport);\r\n      } else {\r\n        viewports.push(undefined);\r\n      }\r\n    });\r\n\r\n    return viewports;\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/content/ContentLayout.d.ts

@@ -0,0 +1,84 @@
+/** @packageDocumentation
+ * @module ContentView
+ */
+import "./ContentLayout.scss";
+import * as React from "react";
+import { CommonProps, UiEvent } from "@itwin/core-react";
+import { ContentGroup } from "./ContentGroup";
+import { ContentLayoutProps, LayoutFragmentProps } from "@itwin/appui-abstract";
+/** Common interface for HorizontalSplit and VerticalSplit
+ */
+interface LayoutSplit {
+    createContentContainer(contentNodes: React.ReactNode[], resizable: boolean): React.ReactNode;
+    isLocked: boolean;
+}
+/** Content Layout Definition class.
+ * @public
+ */
+export declare class ContentLayoutDef {
+    private _layoutProps;
+    private _rootSplit?;
+    /** ID for this Content Layout */
+    id: string;
+    /** Description of the layout. */
+    description: string;
+    constructor(layoutProps: ContentLayoutProps);
+    get rootSplit(): LayoutSplit | undefined;
+    /** Creates [[ContentLayoutProps]] for JSON purposes
+     * @public
+     */
+    toJSON(): ContentLayoutProps;
+    /** Fill a layout container with React nodes for each content view
+     */
+    fillLayoutContainer(contentNodes: React.ReactNode[], resizable: boolean): React.ReactNode | undefined;
+    /** Gets the indexes of content views used in this Content Layout
+     */
+    getUsedContentIndexes(): number[];
+    private getHorizontalSplitContentIndexes;
+    private getVerticalSplitContentIndexes;
+    /** @internal */
+    static createSplit(fragmentDef: LayoutFragmentProps): LayoutSplit | undefined;
+}
+/** Content Layout Activated Event Args class.
+ * @public
+ */
+export interface ContentLayoutActivatedEventArgs {
+    contentLayout: ContentLayoutDef;
+    contentGroup: ContentGroup;
+}
+/** Content Layout Activated Event class.
+ * @public
+ */
+export declare class ContentLayoutActivatedEvent extends UiEvent<ContentLayoutActivatedEventArgs> {
+}
+/** State for the [[ContentLayout]].
+ */
+interface ContentLayoutState {
+    contentLayoutDef: ContentLayoutDef;
+    contentContainer?: React.ReactNode;
+    contentGroupId?: string;
+}
+/** Properties for the [[ContentLayout]] React component.
+ * @public
+ */
+export interface ContentLayoutComponentProps extends CommonProps {
+    contentLayout: ContentLayoutDef;
+    contentGroup: ContentGroup;
+    isInFooterMode: boolean;
+}
+/** Content Layout React component.
+ * @public
+ */
+export declare class ContentLayout extends React.Component<ContentLayoutComponentProps, ContentLayoutState> {
+    /** @internal */
+    readonly state: Readonly<ContentLayoutState>;
+    constructor(props: ContentLayoutComponentProps);
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private _handleContentLayoutActivated;
+    render(): React.ReactNode;
+    private _onMouseDown;
+    private _onMouseUp;
+}
+export {};
+//# sourceMappingURL=ContentLayout.d.ts.map

package/lib/esm/appui-react/content/ContentLayout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentLayout.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/content/ContentLayout.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,sBAAsB,CAAC;AAE9B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,WAAW,EAAe,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAGtE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAA8E,MAAM,uBAAuB,CAAC;AAsK5J;GACG;AACH,UAAU,WAAW;IACnB,sBAAsB,CAAC,YAAY,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC;IAC7F,QAAQ,EAAE,OAAO,CAAC;CACnB;AA6JD;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,YAAY,CAAqB;IACzC,OAAO,CAAC,UAAU,CAAC,CAAc;IAEjC,iCAAiC;IAC1B,EAAE,EAAE,MAAM,CAAM;IACvB,iCAAiC;IAC1B,WAAW,EAAE,MAAM,CAAM;gBACpB,WAAW,EAAE,kBAAkB;IAO3C,IAAW,SAAS,IAAI,WAAW,GAAG,SAAS,CAA4B;IAE3E;;OAEG;IACI,MAAM,IAAI,kBAAkB;IAEnC;OACG;IACI,mBAAmB,CAAC,YAAY,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,OAAO,GAAG,KAAK,CAAC,SAAS,GAAG,SAAS;IAa5G;OACG;IACI,qBAAqB,IAAI,MAAM,EAAE;IAexC,OAAO,CAAC,gCAAgC;IAuBxC,OAAO,CAAC,8BAA8B;IAuBtC,gBAAgB;WACF,WAAW,CAAC,WAAW,EAAE,mBAAmB,GAAG,WAAW,GAAG,SAAS;CAUrF;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,gBAAgB,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;CAC5B;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,OAAO,CAAC,+BAA+B,CAAC;CAAI;AAE7F;GACG;AACH,UAAU,kBAAkB;IAC1B,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,gBAAgB,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IACnC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,WAAW;IAC9D,aAAa,EAAE,gBAAgB,CAAC;IAChC,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,KAAK,CAAC,SAAS,CAAC,2BAA2B,EAAE,kBAAkB,CAAC;IAEjG,gBAAgB;IAChB,SAAyB,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;gBAEjD,KAAK,EAAE,2BAA2B;IAgB9B,iBAAiB;IAIjB,oBAAoB;IAIpC,OAAO,CAAC,6BAA6B,CAYnC;IAEc,MAAM,IAAI,KAAK,CAAC,SAAS;IAezC,OAAO,CAAC,YAAY,CAElB;IAEF,OAAO,CAAC,UAAU,CAEhB;CACH"}